Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Webhooks

Update Webhook

Updates an existing webhook.

📘 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.

put/api/webhooks/{id}

Path parameters

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

Headers

X-Polytomic-Versionstring

Request body

endpointstring required
organization_idstring uuid nullable
secretstring required

Example request

{
  "endpoint": "https://example.com/webhook",
  "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
}

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