Skip to main content
POST
/
v1
/
webhooks
Register webhook
curl --request POST \
  --url https://instance.prod.onboardapp.io/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "url": "<string>",
  "events": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": "<string>",
    "url": "<string>",
    "events": [
      "case.created"
    ],
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

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