Create webhook
Registers a new webhook endpoint for platform notifications. The signing secret is returned once at creation time; subsequent reads do not include it. Pass event_types to filter to a subset, or omit to receive every event the platform emits.
Authorizations
Headers
API version (defaults to the latest supported version if omitted).
v1 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.
1 - 255Body
Human-readable name for the webhook endpoint.
1 - 255"Production notifications"
HTTPS URL platform notifications are POSTed to.
"https://example.com/webhooks/bitnob"
Optional filter of event types to deliver; empty delivers every type. See GET /v1/webhooks/event-types.
Response
Created
ISO-8601 time when the webhook was created.
"2026-05-16T10:30:00Z"
Event-type filter; empty means all platform event types are delivered.
Whether a signing secret is configured for delivery verification.
true
Unique identifier of the webhook endpoint.
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
ISO-8601 time of the most recent delivery.
Human-readable name of the webhook endpoint.
"Production notifications"
Object type discriminator; always "webhook".
"webhook"
Plaintext HMAC signing secret. Returned ONLY on create and rotate-secret — never on GET/list.
Current status of the webhook endpoint.
"active"
ISO-8601 time when the webhook was last updated.
"2026-05-16T10:30:00Z"
URL platform notifications are delivered to.
"https://example.com/webhooks/bitnob"