Webhooks API
Generated OpenAPI reference for the Webhooks API surface.
Overview
Webhooks endpoints are part of the public Everyn API. Webhook endpoint management, one-time signing-secret display/rotation, test deliveries, and public-safe delivery inspection.
Endpoints
The generated OpenAPI component below contains request parameters, request bodies, response bodies, status codes, and schemas for this tag.
Endpoint summary for quick scanning before using the generated reference:
Failures use the PublicErrorEnvelope shape with an X-Request-Id header. Most endpoints below return 400, 401, 403, 404, 409, 422, 429; the few that differ list their own statuses in the table, which otherwise shows only success responses. See API errors for the envelope and recovery patterns.
| Method | Path | Summary | Request body | Success response |
|---|---|---|---|---|
GET | /v1/webhook-deliveries | List Webhook Deliveries | None. | 200 application/json: Page_WebhookDeliveryResponse_ |
GET | /v1/webhook-deliveries/{delivery_id} | Get Webhook Delivery | None. | 200 application/json: WebhookDeliveryDetailResponse |
GET | /v1/webhook-endpoints | List Webhook Endpoints | None. | 200 application/json: Page_WebhookEndpointResponse_ |
POST | /v1/webhook-endpoints | Create Webhook Endpoint | application/json: WebhookEndpointCreateRequestBody | 201 application/json: WebhookEndpointSecretResponse or WebhookEndpointResponse |
GET | /v1/webhook-endpoints/{webhook_endpoint_id} | Get Webhook Endpoint | None. | 200 application/json: WebhookEndpointResponse |
PATCH | /v1/webhook-endpoints/{webhook_endpoint_id} | Update Webhook Endpoint | application/json: WebhookEndpointUpdateRequestBody | 200 application/json: WebhookEndpointResponse |
DELETE | /v1/webhook-endpoints/{webhook_endpoint_id} | Delete Webhook Endpoint | None. | 200 application/json: WebhookEndpointResponse |
POST | /v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret | Rotate Webhook Endpoint Secret | None. | 200 application/json: WebhookEndpointSecretResponse |
POST | /v1/webhook-endpoints/{webhook_endpoint_id}/test | Test Webhook Endpoint | None. | 200 application/json: WebhookDeliveryDetailResponse |
Loading API reference...