For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Login
HomeDocsAPI ReferenceMCP ServerChat SDKsRelease Notes
HomeDocsAPI ReferenceMCP ServerChat SDKsRelease Notes
  • Introduction
    • Overview
    • Authentication
    • Versioning
    • Limits
    • Pagination
    • Errors
    • Migrate to V2
    • Changelog
  • Knowledge
    • Overview
    • Sources
    • Articles
    • Tags
  • End Users
    • Overview
    • Getting started
    • Developer guide
  • Integrations
    • Overview
    • Getting started
  • Conversations
    • Overview
    • Getting started
      • POSTWebhook: Conversation created
      • POSTWebhook: Conversation message
      • POSTWebhook: Conversation ended
      • POSTWebhook: Conversation handoff ended
  • Webhooks
    • Overview
  • Data Compliance
    • Overview
  • Data Export
    • Overview
    • Getting started
    • Conversations
    • Messages
Login
LogoLogo
ConversationsWebhooks

Webhook: Conversation created

Payload
1{
2 "type": "v1.conversation.created",
3 "timestamp": "2020-09-20T00:00:00+00:00",
4 "data": {
5 "conversation_id": "5df263b7db5a7e6ea03fae9b",
6 "channel_id": "5df263b7db5a7e6ea03fae9b",
7 "created_at": "2020-09-20T00:00:00+00:00",
8 "end_user_id": "5f7e0e2c1e7c7e000f0f9c3a",
9 "metadata": {
10 "pass": "example_string_value",
11 "initial_url": "https://example.com",
12 "locale": "en-CA"
13 },
14 "ai_agent_domain": "acme.ada.support"
15 }
16}
A webhook sent when a conversation is created
Was this page helpful?
Previous

Webhook: Conversation message

Next
Built with

Payload

The payload of this webhook request is an object.
typeenumOptional
The webhook event type
Allowed values:
timestampstringOptional

The timestamp for when the event was generated (uses millisecond precision to help with event ordering)

dataobjectOptional
The webhook event data

Response

200
any
Return a 200 status to indicate that the data was received successfully.