Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Webhooks

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.

post/api/webhooks/{id}/disable

Path parameters

idstring uuid required
Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": {
    "created_at": "2024-01-01T00:00:00Z",
    "endpoint": "https://example.com/webhook",
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "secret": "secret"
  }
}