API referenceWebhooksUpdate a webhook

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

HeaderRequiredValue
AuthorizationYesBearer <key>: a private inference key (sk_live_...). See Authentication.
syntic-betaYes, while in previewwebhooks-2026-11-01. Without it the call fails with 400 beta_required. See Versioning.
Content-TypeYesapplication/json

Path parameters

ParameterTypeDescription
webhook_idstringThe webhook id, starting with whk_.

Body parameters

ParameterTypeRequiredNotes
urlstringNoNew destination.
eventsarray of stringsNoReplaces the list.
descriptionstring or nullNonull clears it.
statusstringNoenabled 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:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
400invalid_request_errorinvalid_urlThe new URL is not acceptable.
400invalid_request_errorunknown_event_typeAn unknown event type.
404not_found_errorwebhook_not_foundNo webhook with that id in this workspace.
401authentication_errorinvalid_api_keyThe key is missing, unknown, revoked or expired.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?