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

# Create a webhook

`POST /webhooks`

## Request

- Base URL: `https://api.blinkinbox.club/api/v1`
- URL: `https://api.blinkinbox.club/api/v1/webhooks`
- Auth: HTTP bearer

Deliveries are signed: `BlinkInbox-Signature: t=<unix>,v1=<hex>` where v1 = HMAC-SHA256(secret, "<t>.<raw body>"). The secret is only returned on creation.

## Request body

- object
  - `url` string, uri, required
  - `events` string[]
  - `inbox` string: Limit to one inbox (id or address).

## Response `201`

Created

- Webhook
  - `id` string
  - `url` string
  - `events` string[]
  - `inbox` string, nullable
  - `active` boolean
  - `lastStatus` integer, nullable
  - `failureCount` integer
  - `secret` string: Only on create.

## Other responses

- `401`: Missing or invalid API key
- `404`: Not found
- `429`: Rate limit or quota exceeded

---

[API](https://skmtc.dev/blinkinbox/apis/blinkinbox-api.md) · [All operations](https://skmtc.dev/blinkinbox/apis/blinkinbox-api/llms.txt) · [OpenAPI document](https://skmtc.dev/blinkinbox/apis/blinkinbox-api/revisions/9bd18eadd34a?raw)