---
title: "Create a webhook endpoint"
method: POST
path: "/api/v1/webhooks"
tags: ["Webhooks"]
---

# Create a webhook endpoint

`POST /api/v1/webhooks`

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.

## Request body

- object
  - `url` string, required — The HTTPS delivery URL. Public hosts only — internal/private addresses are rejected.
  - `events` string[], required — Events to subscribe to. Allowed values: `alarm.triggered`.

## Response `201`

- object
  - `data` object
    - `id` integer
    - `url` string
    - `events` string[]
    - `status` string
    - `consecutive_failures` integer
    - `disabled_at` string, nullable
    - `created_at` string
    - `secret` string

---

[API](https://skmtc.net/bitculator/apis/bitculator-data-api.md) · [All operations](https://skmtc.net/bitculator/apis/bitculator-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitculator/bitculator-data-api/revisions/ed1378af68b6/schema)