v1

latestOpenAPI 3.0.32026-08-04850206.9 KB

Webhooks

Create a webhook endpoint

Registers an HTTPS endpoint (max 5 per account) for event deliveries. The response includes the signing secret — the ONLY time it is ever shown, so store it immediately.

post/api/v1/webhooks

Request body

urlstring required

The HTTPS delivery URL. Public hosts only — internal/private addresses are rejected.

eventsstring[] required

Events to subscribe to. Allowed values: alarm.triggered.

Example request

{
  "url": "https://example.com/webhooks/bitculator",
  "events": [
    "alarm.triggered"
  ]
}

Response

Example response

{
  "data": {
    "id": 8,
    "url": "https://example.com/webhooks/bitculator",
    "events": [
      "alarm.triggered"
    ],
    "status": "active",
    "consecutive_failures": 0,
    "disabled_at": null,
    "created_at": "2026-07-03T08:00:00+00:00",
    "secret": "whsec_k5cQ1x9jJ2mW7pR4tY8uB3nV6zA0sD5f"
  }
}