DOCS / API REFERENCE

Create a webhook

POST /v1/webhooks

POSTHenHouse API v1

Request

POST /v1/webhooks

Authenticate with a bearer token. Create one with POST /v1/tokens or cluck login.

Parameters

NameTypeDescription
urlstringHTTPS endpoint
eventsarrayEvent types to receive
secretstringSigning secret

Example

curl -X POST https://api.pollosoft.example/v1/webhooks \
  -H "Authorization: Bearer $COOP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url": "example-url", "events": [], "secret": "example-secret"}'

Response

A successful call returns 201 Created with JSON like this:

{
  "id": "whk_42f1",
  "url": "https://example.com/hook",
  "active": true
}

Errors

IdempotencySend an Idempotency-Key header to make retries safe. We will return the original result instead of laying a second egg.