Create a webhook

View as Markdown

Create a new webhook with subscriptions for specific agents and events.

400 is also returned when the endpoint URL is already registered: "A webhook with this URL has already been registered"

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Request

This endpoint expects an object.
endpointstringRequired
The webhook endpoint URL
descriptionstringRequired
The description of the webhook
eventslist of objectsRequired
Array of events to subscribe to

Response

Webhook created successfully
statusboolean
datastring
The ID of the created webhook

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error