Skip to navigation

Disable Webhook

Disables a webhook without deleting it.

📘 One webhook per organization

An organization can register a single webhook, which receives every event produced in that organization. See the Events documentation for the list of event types and payload shapes.

Events are not queued while the webhook is disabled — any activity that occurs during the disabled period is not delivered retroactively. To resume delivery, re-enable the webhook using POST /api/webhooks/{id}/enable.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringRequired

Response

OK
dataobjectOptional

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error