For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETList Webhooks
      • POSTCreate Webhook
      • GETGet Webhook
      • PUTUpdate Webhook
      • DELDelete Webhook
      • POSTDisable Webhook
      • POSTEnable Webhook
Logo
Log inBook a demo
API ReferenceWebhooks

Disable Webhook

POST
https://app.polytomic.com/api/webhooks/:id/disable
POST
/api/webhooks/:id/disable
$curl -X POST https://app.polytomic.com/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d/disable \
>     -H "Authorization: Bearer <token>"
1{
2  "data": {
3    "created_at": "2024-01-01T00:00:00Z",
4    "disabled": true,
5    "endpoint": "https://example.com/webhook",
6    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
8    "secret": "secret"
9  }
10}
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](../../../../guides/events) 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`](../../../../api-reference/webhooks/enable).
Was this page helpful?
Previous

Enable Webhook

Next

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

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringOptional

Response

OK
dataobject

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error