curl --request PATCH \
--url https://api.anchorbrowser.io/v1/webhooks/{id} \
--header 'Content-Type: application/json' \
--header 'anchor-api-key: <api-key>' \
--data '
{
"url": "https://new-host.example.com/anchor/webhooks"
}
'{
"id": "wh_01HXJ4MZ7K9P3Q6R8S2T4V5W7Y",
"project_id": "5d2c31f6-ab7e-481a-b6fd-8b4a96a4e197",
"url": "https://your-app.example.com/anchor/webhooks",
"description": "Production task notifications",
"subscribed_events": [
"task.completed"
],
"enabled": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Update Webhook
Partial update — pass only the fields you want to change. Setting enabled: false
immediately stops events from fanning out to this webhook (existing in-flight
deliveries finish their attempts).
curl --request PATCH \
--url https://api.anchorbrowser.io/v1/webhooks/{id} \
--header 'Content-Type: application/json' \
--header 'anchor-api-key: <api-key>' \
--data '
{
"url": "https://new-host.example.com/anchor/webhooks"
}
'{
"id": "wh_01HXJ4MZ7K9P3Q6R8S2T4V5W7Y",
"project_id": "5d2c31f6-ab7e-481a-b6fd-8b4a96a4e197",
"url": "https://your-app.example.com/anchor/webhooks",
"description": "Production task notifications",
"subscribed_events": [
"task.completed"
],
"enabled": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
API key for your Anchor Browser account, sent as the anchor-api-key header on every
request. Create one at app.anchorbrowser.io (API Access),
or obtain one programmatically via the unauthenticated agent-access flow
(POST /v1/agent-access).
Path Parameters
Webhook id.
Body
Partial update — only the fields you include are changed.
1 - 20482561Catalog of webhook event types Anchor can deliver. Adding a new event type is a coordinated change between session-manager (publisher), webhook-dispatcher (consumer), and the dashboard.
task.completed, task.failed, task.cancelled, task.healed, session.ready, session.completed, session.failed, session.recording.ready, batch.completed, batch.failed, intervention.requested, intervention.resolved, identity.authenticated, identity.authentication_failed Response
Webhook updated.
A registered webhook subscription. The signing secret is NEVER returned by GET/list endpoints.
Webhook id. Use as the path parameter on subsequent calls.
"wh_01HXJ4MZ7K9P3Q6R8S2T4V5W7Y"
The project (team) the webhook belongs to.
"5d2c31f6-ab7e-481a-b6fd-8b4a96a4e197"
HTTPS URL Anchor will POST events to.
"https://your-app.example.com/anchor/webhooks"
Optional human-readable description.
256"Production task notifications"
Event types this webhook is currently subscribed to.
Catalog of webhook event types Anchor can deliver. Adding a new event type is a coordinated change between session-manager (publisher), webhook-dispatcher (consumer), and the dashboard.
task.completed, task.failed, task.cancelled, task.healed, session.ready, session.completed, session.failed, session.recording.ready, batch.completed, batch.failed, intervention.requested, intervention.resolved, identity.authenticated, identity.authentication_failed When false, no events fan out to this webhook.
true
Was this page helpful?