Skip to content

Delete a webhook endpoint

Settings module

DELETE/webhook-endpoints/{id}webhookEndpoints.delete

A webhook endpoint. Deliveries are signed with HMAC-SHA256 and retried for 72 hours. Soft-deletes the webhook endpoint: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability org.webhooks.manage.
  • OAuth scopes: org.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

webhookEndpoints.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the webhook endpoint.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/webhook-endpoints/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.webhookEndpoints.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.webhook_endpoints.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos webhook-endpoints delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f