Bot Chat Message
Bot Chat Message payload structure
Payload Structure
| Field | Type | Required | Description |
|---|---|---|---|
data | object | Yes | |
event | string | Yes | The webhook event type |
extra | object | null | Yes |
Field Details
-
data(object) RequiredProperties:
-
bot_id(string (uuid)) Required The UUID of the bot that received the chat message -
event_id(string (uuid) | null) Required The UUID of the calendar event associated with this bot. Null for non-calendar bots -
message_id(string) Required Unique identifier of the chat message -
sender_id(integer | null) Required Sequential participant ID of the sender. Null if the sender could not be resolved to a participant -
sender_name(string) Required Display name of the message sender -
sent_at(string (date-time)) Required ISO 8601 timestamp when this webhook was sent -
text(string) Required Text content of the chat message
-
-
event(string) Required The webhook event type -
extra(object | null) Required Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
Example
{
"data": {
"bot_id": "examplebot_id",
"event_id": null,
"message_id": "examplemessage_id",
"sender_id": null,
"sender_name": "examplesender_name",
"sent_at": "examplesent_at",
"text": "exampletext"
},
"event": "exampleevent",
"extra": null
}