Update a webhook endpoint

Settings module

PATCH/webhook-endpoints/{id}webhookEndpoints.update

A webhook endpoint. Deliveries are signed with HMAC-SHA256 and retried for 72 hours. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requires the capability org.webhooks.manage.
OAuth scopes: org.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

webhookEndpoints.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the webhook endpoint.

Request body: WebhookEndpointUpdate

webhookEndpoints.update: WebhookEndpointUpdate
Field	Type	Required	Description
url	string (uri)	No	HTTPS endpoint URL.
events	array of string	No	Subscribed event names.
description	string \| null	No	What the endpoint is for.Constraints: length 1 to 2000
disabled_at	string (date-time) \| null	No	When the endpoint was turned off; disabled endpoints get no new deliveries.

{
  "url": "https://northwindlive.example/files/site-plan.pdf",
  "events": [
    "record.state_changed",
    "po.approved"
  ],
  "description": "Sync approved POs to the ERP.",
  "disabled_at": "2026-10-08T14:30:00Z"
}

Response 200: WebhookEndpoint

webhookEndpoints.update: WebhookEndpoint
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the webhook endpoint.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
url	string (uri)	Yes	HTTPS endpoint URL.
events	array of string	Yes	Subscribed event names.
description	string \| null	Yes	What the endpoint is for.Constraints: length 1 to 2000
disabled_at	string (date-time) \| null	Yes	When the endpoint was turned off; disabled endpoints get no new deliveries.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "url": "https://northwindlive.example/files/site-plan.pdf",
  "events": [
    "record.state_changed",
    "po.approved"
  ],
  "description": "Sync approved POs to the ERP.",
  "disabled_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/webhook-endpoints/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"url":"https://northwindlive.example/files/site-plan.pdf","events":["record.state_changed","po.approved"],"description":"Sync approved POs to the ERP.","disabled_at":"2026-10-08T14:30:00Z"}'

const { data, etag } = await xos.webhookEndpoints.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "url": "https://northwindlive.example/files/site-plan.pdf",
    "events": [
      "record.state_changed",
      "po.approved"
    ],
    "description": "Sync approved POs to the ERP.",
    "disabled_at": "2026-10-08T14:30:00Z"
  }, { ifMatch: etag });

response = xos.webhook_endpoints.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"url": "https://northwindlive.example/files/site-plan.pdf", "events": ["record.state_changed", "po.approved"], "description": "Sync approved POs to the ERP.", "disabled_at": "2026-10-08T14:30:00Z"}, if_match=etag)

xos webhook-endpoints update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"url":"https://northwindlive.example/files/site-plan.pdf","events":["record.state_changed","po.approved"],"description":"Sync approved POs to the ERP.","disabled_at":"2026-10-08T14:30:00Z"}' --if-match auto