Webhooks - Relay

Read webhook subscriptions and the event types they deliver.

The Webhook object

Field	Type	Description
`id`	string	Unique identifier for the webhook subscription
`target_url`	string	URL where webhook events will be sent
`subscribed_events`	array	List of event types this subscription receives
`is_active`	boolean	Whether this subscription is currently active
`created_at`	string	When the subscription was created
`updated_at`	string	When the subscription was last updated

Example

GET /v1/webhook-subscriptions for an agent with no subscriptions returns HTTP 200:

{
  "subscriptions": []
}

Operations

Method	Path	What it does
`GET`	`/v1/webhook-events`	List available webhook event types
`POST`	`/v1/webhook-subscriptions`	Create a new webhook subscription
`GET`	`/v1/webhook-subscriptions`	List all webhook subscriptions
`GET`	`/v1/webhook-subscriptions/{subscriptionId}`	Get a webhook subscription by ID
`PUT`	`/v1/webhook-subscriptions/{subscriptionId}`	Update a webhook subscription
`DELETE`	`/v1/webhook-subscriptions/{subscriptionId}`	Delete a webhook subscription

Errors

Common authentication, validation, and server errors apply alongside resource errors. Read error.message for the rejected condition. 1005, 2001, 2003, 2004, 2006, 3006.

Next steps