Request
POST /v1/webhooks
Authenticate with a bearer token. Create one with POST /v1/tokens or cluck login.
Parameters
| Name | Type | Description |
|---|---|---|
url | string | HTTPS endpoint |
events | array | Event types to receive |
secret | string | Signing 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
HEN-2001(401): Not logged inHEN-2004(403): Insufficient pecking orderHEN-5001(429): Too many pecksHEN-1002(400): Missing required field
IdempotencySend an
Idempotency-Key header to make retries safe. We will return the original result instead of laying a second egg.