Docs — API Reference/docs/api-reference/webhooks
Webhooks
Manage the HTTPS endpoints the platform pushes events to. Payloads are signed (Mynd-Signature, HMAC-SHA256); deliveries retry with backoff for 24 hours and are inspectable through the deliveries endpoint. The event catalog lives at /docs/webhooks.
[ 01 ]post — /v1/webhooks
POST
/v1/webhooksRegister an endpoint. The signing secret is returned once, on this response only.
| param | type | req | description |
|---|---|---|---|
| url | string | required | HTTPS endpoint. Must return 2xx within 10 seconds. |
| events | string[] | required | Events to subscribe, e.g. ["run.completed", "run.failed"]. "*" subscribes to all. |
| description | string | optional | Label shown on the dashboard. |
[ request ]POST
{
"url": "https://api.example.com/hooks/mynd",
"events": ["run.completed", "run.awaiting_approval"],
"description": "prod event consumer"
}[ response ]200 ok
{
"id": "wh_3fa1c802",
"object": "webhook",
"url": "https://api.example.com/hooks/mynd",
"events": ["run.completed", "run.awaiting_approval"],
"secret": "whsec_…shown_once…",
"status": "enabled"
}[ 02 ]get — /v1/webhooks/:id/deliveries
GET
/v1/webhooks/:id/deliveriesInspect recent delivery attempts — status codes, latency, and retry schedule.
| param | type | req | description |
|---|---|---|---|
| id | string | required | Webhook identifier. Path parameter. |
| status | string | optional | Filter: "succeeded", "failed", "pending". Query parameter. |
[ response ]200 ok
{
"object": "list",
"data": [
{ "id": "del_551", "event": "run.completed", "response_status": 200, "ms": 84 },
{ "id": "del_550", "event": "run.failed", "response_status": 500,
"next_retry_at": "2026-06-11T08:04:00Z" }
]
}[ 03 ]delete — /v1/webhooks/:id
DELETE
/v1/webhooks/:idDelete the endpoint. Pending retries are cancelled.
| param | type | req | description |
|---|---|---|---|
| id | string | required | Webhook identifier. Path parameter. |
[ response ]200 ok
{
"id": "wh_3fa1c802",
"object": "webhook",
"deleted": true
}More resources