Webhook: Conversation message

Payload

1 {
2   "type": "v1.conversation.message",
3   "timestamp": "2020-09-20T00:00:00+00:00",
4   "data": {
5     "message_id": "61f46e0b-fa39-4e44-850b-c1ca8f958dd3",
6     "conversation_id": "5f7e0e2c1e7c7e000f0f9c3a",
7     "end_user_id": "5f7e0e2c1e7c7e000f0f9c3a",
8     "handoff_integration": {},
9     "channel": {
10       "type": "custom",
11       "description": "A custom messaging channel for my AI Agent",
12       "id": "5f7e0e2c1e7c7e000f0f9c3a",
13       "modality": "messaging",
14       "name": "My Custom Channel",
15       "created_at": "2020-09-20T00:00:00+00:00",
16       "metadata": {
17         "example_key1": "example_string_value",
18         "example_key2": true,
19         "example_key3": 123
20       }
21     },
22     "created_at": "2020-09-20T00:00:00+00:00",
23     "author": {
24       "id": "5df263b7db5a7e6ea03fae9b",
25       "role": "end_user",
26       "avatar": "https://www.gravatar.com",
27       "display_name": "Ada Lovelace"
28     },
29     "content": {
30       "type": "text",
31       "body": "I need help with my order"
32     },
33     "ai_agent_domain": "acme.ada.support"
34   }
35 }

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

Allowed values:

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.