For AI agents: visit https://devdocs.drift.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Dev.Drift
GuidesDrift API Documentation
Phoenix

Dev.DriftGuidesDev.Drift
Guides
Dev.DriftGuides
Phoenix
User Model

Start Here

  • Using Drift APIs

Guides

  • Playbook Webhook Implementation Guide
  • Custom MAP/CRM Integration
  • Drift.identify() Implementation Guide

Tutorials

  • Start a Chat Programmatically
  • Embed Drift's Landing Pages
  • Welcome Message
  • How to Export Conversations from Drift
  • Load Support Chat Client with Conversation Events
  • Capture URL Query Strings as Attributes
  • Force DriftLinks to Adhere to Online/Offline Hours
  • Convert Epoch Time to Standard Time and Assign to Attribute
  • Assign Country from Browser/IP Address to Attribute
  • Using a Browser-side Event to Fire a POST Request
  • Bulk Conversations Transcript Export
  • Redirect URL on Chat Button Click
  • Targeted Fastlane Script Per Site Language
  • Tracking conversation events as conversions with LinkedIn Insight Tags
  • How To Send Conversation Events To Google Tag Manager's Data Layer Object
  • Adobe Analytics and Drift Browser Events
  • Zapier and Drift - Custom Webhook Configuration
  • Switch Playbooks On Button-Click
  • Load Drift after opt-in through HubSpot Cookie Consent Banner
  • Retrieve Cookie Values and Pass to Drift
  • Using Marketo Webhooks To Fetch Conversation Transcript
  • Use Salesforce Flow Builder to Update Lead or Contact Ownership from Drift Conversation Tasks
  • Sending GA Events when Drift is Installed via an iFrame
  • Using a Drift Facade with a Cookie Manager

Security

  • Securing Drift on your Site
    • Securing Drift on Your Site with an iframe
    • Securing Drift on Your Site with Signed Identities

In the Browser

  • Installation
    • Using Drift with Gatsby CMS
  • User Identification
  • Configuration and Settings
  • Controlling the Widget
  • Receiving Information from Drift
  • Sending Information into Drift

Fastlane

  • Installing Fastlane Playbooks
  • Installing Fastlane Playbooks in Pardot forms
  • Fastlane Deferred Form Submissions with React

Server Side

  • Introduction to Backend APIs
  • Setting Up an Integration
  • Interacting with Drift Chat
  • Webhooks: Subscribing to Drift Events
  • Contact Update Subscriptions
  • Data and Errors
  • Making a Public Integration
    • Authentication and Scopes

Contacts API

  • Contact Model
    • Setting up Custom Attributes in Drift
  • Creating a Contact
  • Updating a Contact
    • Updating a Contact via non-Drift ID
  • Retrieving Contacts
  • Deleting a Contact
  • Unsubscribe Contacts From Emails
  • Posting Timeline Events
  • Listing Custom Attributes
  • Common Contact API Errors

Users API

  • User Model
  • Retrieving User
  • Listing Users
  • Updating a User
  • Get Booked Meetings
  • Meeting Model

Conversations & Messages API

  • Conversation Model
  • Message Model
  • Creating a Message
  • Retrieving a Conversation
  • Retrieving a Conversation's Messages
  • Retrieving a Conversation's Transcript
  • Retrieving a Conversation's Attachments
  • Creating a new Conversation
  • Bulk Conversation Statuses
  • List Conversations

Accounts API

  • Account Model
  • Creating an Account
  • Retrieving an account
  • Listing Accounts
  • Updating Accounts
  • Deleting Accounts

Playbooks API

  • Playbook Model
  • Retrieving Bot Playbooks
  • Retrieving Conversational Landing Pages

TEAM API

  • Team Model
  • Listing Teams Org
  • Listing Teams by User

App Admin API

  • Trigger App Uninstall
  • Get Token Information

Data Privacy API

  • GDPR Overview
  • GDPR Retrieval
  • GDPR Deletion
  • Walkthrough

Community

  • FAQs
  • Blog
  • Community Forum

SCIM API

  • User Schema
  • Searching via SCIM
  • Provisioning via SCIM
  • Updating via SCIM
  • Deprovisioning via SCIM