The Webhooks routes. Every body is JSON, and an error always comes back as an object with a code and a message.
List webhook endpoints
Response (object[])
curl -X GET "https://zaiped.com/v1/webhooks" \ -H "Authorization: Bearer zp_..."
Create a webhook endpoint
Registers an HTTPS URL for the given events (`message.received`, `message.status`, `template.status`, `number.update`, `account.notice`, `call.event`). The signing secret is returned once: verify `X-Zaiped-Signature` (`t=TIMESTAMP,v1=HEX`, where HEX is the HMAC-SHA256 of `TIMESTAMP.BODY`) with it.
Request body
Response (object)
curl -X POST "https://zaiped.com/v1/webhooks" \
-H "Authorization: Bearer zp_..." \
-H "Content-Type: application/json" \
-d '{
"url": "…",
"events": []
}'Get a webhook endpoint
Path parameters
Response (object)
curl -X GET "https://zaiped.com/v1/webhooks/YOUR_WEBHOOK_ID" \ -H "Authorization: Bearer zp_..."
Update a webhook endpoint
Path parameters
Request body
Response (object)
curl -X PUT "https://zaiped.com/v1/webhooks/YOUR_WEBHOOK_ID" \
-H "Authorization: Bearer zp_..." \
-H "Content-Type: application/json" \
-d '{}'Delete a webhook endpoint
Path parameters
Response (object)
curl -X DELETE "https://zaiped.com/v1/webhooks/YOUR_WEBHOOK_ID" \ -H "Authorization: Bearer zp_..."
Send a test event
Queues a `test` event to this endpoint, signed like any other.
Path parameters
Response (object)
curl -X POST "https://zaiped.com/v1/webhooks/YOUR_WEBHOOK_ID/test" \ -H "Authorization: Bearer zp_..."
List recent deliveries
The last deliveries to this endpoint, newest first, with the attempt count and the last HTTP status.
Path parameters
Response (object[])
curl -X GET "https://zaiped.com/v1/webhooks/YOUR_WEBHOOK_ID/deliveries" \ -H "Authorization: Bearer zp_..."