Skip to main content
POST
Create webhook

Authorizations

X-API-Key
string
header
required

Headers

API-Version
enum<string>
default:v1

API version (defaults to the latest supported version if omitted).

Available options:
v1
Idempotency-Key
string

Unique key (1-255 printable ASCII chars) used to safely retry write operations. Same key + body returns the cached response; same key + different body returns 409.

Required string length: 1 - 255

Body

application/json
name
string
required

Human-readable name for the webhook endpoint.

Required string length: 1 - 255
Example:

"Production notifications"

url
string<uri>
required

HTTPS URL platform notifications are POSTed to.

Example:

"https://example.com/webhooks/bitnob"

event_types
string[]

Optional filter of event types to deliver; empty delivers every type. See GET /v1/webhooks/event-types.

Response

Created

created_at
string<date-time>

ISO-8601 time when the webhook was created.

Example:

"2026-05-16T10:30:00Z"

event_types
string[]

Event-type filter; empty means all platform event types are delivered.

has_signing_secret
boolean

Whether a signing secret is configured for delivery verification.

Example:

true

id
string

Unique identifier of the webhook endpoint.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

last_triggered_at
string<date-time>

ISO-8601 time of the most recent delivery.

name
string

Human-readable name of the webhook endpoint.

Example:

"Production notifications"

object
string

Object type discriminator; always "webhook".

Example:

"webhook"

signing_secret
string

Plaintext HMAC signing secret. Returned ONLY on create and rotate-secret — never on GET/list.

status
string

Current status of the webhook endpoint.

Example:

"active"

updated_at
string<date-time>

ISO-8601 time when the webhook was last updated.

Example:

"2026-05-16T10:30:00Z"

url
string

URL platform notifications are delivered to.

Example:

"https://example.com/webhooks/bitnob"