Skip to main content

​
chat.started

Occurs whenever a conversation begins, marked by a user sending a message. 
{
  "id": "webhook_123456789",
  "type": "chat.started",
  "created": 1708646472,
  "data": {
    "chat_id": "8b146471-e88e-4322-86af-016cd36fd216",
    "created": 1708646471
  }
}

​
chat.ended

Occurs whenever a conversation completes. 
{
  "id": "webhook_123456789",
  "type": "chat.ended",
  "created": 1708646472,
  "data": {
    "chat_id": "8b146471-e88e-4322-86af-016cd36fd216",
    "created": 1708646471
  }
}

​
chat.human_required

Occurs whenever human assistance is needed. 
{
  "id": "webhook_123456789",
  "type": "chat.human_required",
  "created": 1708646472,
  "data": {
    "chat_id": "8b146471-e88e-4322-86af-016cd36fd216",
    "created": 1708646471
  }
}

​
contact:insight.created

Occurs whenever new contact insight is generated. 
{
  "id": "webhook_123456789",
  "type": "contact:insight.created",
  "created": 1708646472,
  "data": {
    "contact_id": "8b146471-e88e-4322-86af-016cd36fd216",
    "created": 1708646471
  }
}

​
contact:insight.updated

Occurs whenever contact insight is modified. 
{
  "id": "webhook_123456789",
  "type": "contact:insight.updated",
  "created": 1708646472,
  "data": {
    "contact_id": "8b146471-e88e-4322-86af-016cd36fd216",
    "key": "preference",
    "value": "email",
    "created": 1708646471
  }
}

​
contact:attribute.created

Occurs whenever a new contact attribute is added. 
{
  "id": "webhook_123456789",
  "type": "contact:attribute.created",
  "created": 1708646472,
  "data": {
    "contact_id": "8b146471-e88e-4322-86af-016cd36fd216",
    "created": 1708646471
  }
}

​
contact:attribute.updated

Occurs whenever a contact attribute is modified. 
{
  "id": "webhook_123456789",
  "type": "contact:attribute.updated",
  "created": 1708646472,
  "data": {
    "contact_id": "8b146471-e88e-4322-86af-016cd36fd216",
    "key": "company",
    "value": "Acme Corp",
    "created": 1708646471
  }
}

​
task.completed

Occurs whenever an agent task is finished. 
{
  "id": "webhook_123456789",
  "type": "task.completed",
  "created": 1708646472,
  "data": {
    "task_id": "8b146471-e88e-4322-86af-016cd36fd216",
    "task_name": "Send welcome email",
    "chat_id": "8b146471-e88e-4322-86af-016cd36fd216",
    "created": 1708646471
  }
}

​
performance.recorded

Occurs whenever an agent logs a successful Qualified Opportunity. Learn more about Team Usage. 
{
  "id": "webhook_123456789",
  "type": "performance.recorded",
  "created": 1708646472,
  "data": {
    "performance_record_id": "8b146471-e88e-4322-86af-016cd36fd216",
    "metric": "instructions",
    "details": "Instructions-Aligned Outcome: Successfully guided prospect through qualification process and captured key business requirements",
    "created": 1708646471
  }
}
⌘I