The Webhook API provides operations to create, retrieve, update, and delete webhook endpoints, as well as enable, disable, test, reset signing secrets, and list delivery events. Webhooks receive event callback deliveries from Managed Agents.
Overview
A webhook endpoint receives event callback deliveries from Managed Agents. A newly created webhook is active by default (status is ACTIVE) and delivers notifications to the callback URL when events occur. Each delivery failure increments a consecutive failure counter; you can verify connectivity with the test endpoint or rotate the signing secret via the reset-secret endpoint.
Webhook Operations
| Operation | Endpoint | Description |
|---|---|---|
| Create Webhook | POST /webhook_endpoints | Create a webhook endpoint with a callback URL and subscribed events |
| Get Webhook | GET /webhook_endpoints/{id} | Retrieve a single webhook by ID |
| List Webhooks | GET /webhook_endpoints | List non-deleted webhooks in the current workspace |
| Update Webhook | PUT /webhook_endpoints/{id} | Update the callback URL, subscribed events, and description |
| Delete Webhook | DELETE /webhook_endpoints/{id} | Delete the webhook; this operation is irreversible |
| Enable Webhook | POST /webhook_endpoints/{id}/enable | Enable the webhook to start receiving event deliveries |
| Disable Webhook | POST /webhook_endpoints/{id}/disable | Disable the webhook to stop event deliveries |
| Test Webhook | POST /webhook_endpoints/{id}/test | Send a test event to the callback URL to verify connectivity |
| Reset Secret | POST /webhook_endpoints/{id}/reset_secret | Reset the signing secret; the old secret is invalidated immediately |
| List Events | GET /webhook_endpoints/{id}/events | Paginated list of delivery event records for this webhook |