Bot Chat Status
Bot Chat Status 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:
-
available(boolean) Required Whether the bot can send and receive chat in this meeting -
bot_id(string) Required The UUID of the bot this chat status refers to -
event_id(string (uuid) | null) Required The UUID of the calendar event series. Null when the bot was not created from a calendar event -
reason("organizer_disabled" | "panel_not_attached" | "send_failed" | null) Required Why chat is unavailable. Null when available is true -
sent_at(string (date-time)) Required ISO 8601 timestamp when this webhook was sent
-
-
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": {
"available": true,
"bot_id": "examplebot_id",
"event_id": null,
"reason": null,
"sent_at": "examplesent_at"
},
"event": "exampleevent",
"extra": null
}