The Webhook object

You can use webhook endpoints to be notified about events that occur in your agent. To learn more about the events supported by the platform, see the section Types of events.

{
    "id": "NeslQOP6vEPwR6vEPm4iV",
    "description": "Trigger when a new message thread is created.",
    "endpoint": "https://d02f2b22.ngrok.io/webhook",   
    "events": ["thread.created"],    
    "secret": "NeslQOP6vEPwR6vEPm4iVx5NlZ6z",
    "status": "enabled",
    "createdAt": "2024-08-20T15:50:00Z",
    "updatedAt": "2024-08-20T15:50:00Z"
}

Attributes

• id (string): A unique identifier for the webhook.

• description (string): A brief description of the webhook.

• endpoint (string): The URL of the webhook endpoint.

• events (array): The list of events that trigger this webhook. For a list of supported event types, see the section Types of events.

• secret (string): The endpoint’s secret. Only returned at creation.

• status (string): The status of the webhook. Possible values: enabled and disabled.

• createdAt (string, ISO 8601 date-Time): The date and time when the webhook was created.

• updatedAt (string, ISO 8601 date-Time): The date and time when the webhook was last updated.