API v2

Bot Status Change

Bot Status Change payload structure

Payload Structure

FieldTypeRequiredDescription
dataobjectYes
eventstringYesThe webhook event type
extraobjectnullYes

Field Details

  • data (object) Required

    Properties:

    • bot_id (string (uuid)) Required The UUID of the bot that changed status

    • event_id (string (uuid) | null) Required The UUID of the calendar event associated with this bot. Null for non-calendar bots

    • status (object) Required Status information with code, timestamp, and optional status-specific fields

  • 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,
    "status": {
      "attempt": 0,
      "code": "examplecode",
      "created_at": "examplecreated_at",
      "error_message": "exampleerror_message",
      "max": 0,
      "start_time": 0
    }
  },
  "event": "exampleevent",
  "extra": null
}

On this page