Webhooks
Test a webhook
Queues a webhook.test event through the normal delivery pipeline using the endpoint's current URL, secret, and custom headers. The endpoint must be active.
Authorization
bearerAuth AuthorizationBearer <token>
PostZen API key.
In: header
Path Parameters
webhookId*string
PostZen webhook endpoint id.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/webhooks/string/test"{ "message": "string", "eventId": "string", "deliveryId": "string"}{ "error": "Unauthorized"}{ "error": "API key requires read_write permission"}{ "error": "Not found"}{ "error": "string"}{ "error": "rate_limited", "retryAfter": 30}{ "error": "Failed to create post"}Delete a webhook DELETE
Deletes an endpoint and stops new event fan-out. Retained delivery logs remain available until their retention period ends.
List webhook deliveries GET
Returns retained delivery logs visible to the API key, newest first. Results are capped to the 1000 most recent matching deliveries.