Webhook: Conversation message

{
  "type": "v1.conversation.message",
  "timestamp": "2020-09-20T00:00:00+00:00",
  "data": {
    "message_id": "61f46e0b-fa39-4e44-850b-c1ca8f958dd3",
    "conversation_id": "5f7e0e2c1e7c7e000f0f9c3a",
    "end_user_id": "5f7e0e2c1e7c7e000f0f9c3a",
    "handoff_integration": {},
    "channel": {
      "type": "custom",
      "description": "A custom messaging channel for my AI Agent",
      "id": "5f7e0e2c1e7c7e000f0f9c3a",
      "modality": "messaging",
      "name": "My Custom Channel",
      "created_at": "2020-09-20T00:00:00+00:00",
      "metadata": {
        "example_key1": "example_string_value",
        "example_key2": true,
        "example_key3": 123
      }
    },
    "created_at": "2020-09-20T00:00:00+00:00",
    "author": {
      "id": "5df263b7db5a7e6ea03fae9b",
      "role": "end_user",
      "avatar": "https://www.gravatar.com",
      "display_name": "Ada Lovelace"
    },
    "content": {
      "type": "text",
      "body": "I need help with my order"
    },
    "ai_agent_domain": "acme.ada.support"
  }
}

A webhook sent when a message is sent to a conversation

Payload

The payload of this webhook request is an object.

typeenumOptional

The webhook event type

timestampstringOptional

The timestamp for when the event was generated, uses millisecond precision to help with event ordering needs

dataobjectOptional

The webhook event data

Response

200

any

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