Webhooks

Replace webhook subscriptions for an agent

View as Markdown

Replaces all existing webhook subscriptions for the agent with the provided event types. Any previously configured subscriptions for this agent are deleted before the new ones are created. To add subscriptions without removing existing ones, retrieve current subscriptions first and include them in the request.

Authentication

AuthorizationBearer

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

Path parameters

agentIdstringRequired
The ID of the agent to create subscriptions for

Request

This endpoint expects an object.
eventTypeslist of enumsRequired
Array of event types to subscribe to
Allowed values:
webhookIdstringRequired
The ID of the webhook to subscribe to

Response

Subscriptions created successfully
statusboolean
datastring
Success message

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error