Skip to main content
POST
Register webhook

Authorizations

X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Headers

Idempotency-Key
string<uuid>

Unique key for idempotent request handling. If a request with the same key was already processed within the last 24 hours, the original response is returned.

Body

application/json

Request body for registering a webhook endpoint.

url
string<uri>
required

HTTPS endpoint URL. Must respond to verification challenges.

events
string[]
required

Event types to subscribe to. Use ["*"] for all events.

Minimum array length: 1

Response

Webhook registered. Store the secret — it is only returned once.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

data
object

A registered webhook endpoint for receiving event notifications.

meta
object