Update a webhook
⚠️
Preview — this feature is being built; the design below is the spec.
PATCH https://app.syntic.ai/v1/webhooks/{webhook_id}Change an endpoint’s URL, events, description or status. Send only the fields you change; events is replaced as a whole. Re-enable an endpoint that Syntic disabled after repeated failures by setting status to enabled, then redeliver what it missed.
For how this fits into a full workflow, see Webhooks.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <key>: a private inference key (sk_live_...). See Authentication. |
syntic-beta | Yes, while in preview | webhooks-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Content-Type | Yes | application/json |
Path parameters
| Parameter | Type | Description |
|---|---|---|
webhook_id | string | The webhook id, starting with whk_. |
Body parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
url | string | No | New destination. |
events | array of strings | No | Replaces the list. |
description | string or null | No | null clears it. |
status | string | No | enabled or disabled. |
Response
200 OK, Content-Type: application/json
{
"id": "whk_01JCA4C6E8G0J2L4N6Q8",
"object": "webhook",
"url": "https://hooks.example.com/syntic",
"events": [
"batch.completed",
"batch.failed"
],
"description": "Ops alerts",
"status": "enabled",
"workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
"created_at": "2026-11-05T09:00:00Z",
"updated_at": "2026-11-08T12:30:00Z",
"last_delivery": {
"at": "2026-11-05T10:00:02Z",
"status_code": 200,
"succeeded": true
}
}Examples
curl -sS -X PATCH https://app.syntic.ai/v1/webhooks/whk_01JCA4C6E8G0J2L4N6Q8 \
-H "Authorization: Bearer $SYNTIC_API_KEY" \
-H "syntic-beta: webhooks-2026-11-01" \
-H "Content-Type: application/json" \
-d '{
"status": "enabled",
"events": [
"batch.completed",
"batch.failed"
]
}'Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 400 | invalid_request_error | invalid_url | The new URL is not acceptable. |
| 400 | invalid_request_error | unknown_event_type | An unknown event type. |
| 404 | not_found_error | webhook_not_found | No webhook with that id in this workspace. |
| 401 | authentication_error | invalid_api_key | The key is missing, unknown, revoked or expired. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Related
Was this page helpful?