webhooks

Create Webhook

Register a webhook URL. Pass events to narrow it to specific events, or omit it to receive every event. The response returns the webhook id, which is what the delete endpoint takes.

post/webhooks

Request

Request body

urlstring
eventsstring[]

Response

Successful Response

messagestring
dataobject

Example response

{
  "message": "Success",
  "data": {
    "id": 42,
    "url": "https://hooks.example.com/catch/site-created",
    "active": true,
    "events": [
      "site_created",
      "site_deleted"
    ],
    "receivesAllEvents": false,
    "created": "2026-08-20T14:30:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.