POpolytomic
Webhooks

Disable Webhook

Changed on

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

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

Webhook ID

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"
  }
}

Changes

  • 932e484931beRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status