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. The static summary keeps the endpoint purpose, authentication, schema names, and API error guidance available before the interactive reference loads.
The details below are static HTML generated from the same OpenAPI schema, so they remain readable without client-side JavaScript. The interactive component after this section provides expandable examples and richer schema browsing.
Endpoint summary for quick scanning before using the generated reference:
| Method | Path | Purpose | Authentication | Request body / schema | Success response / schema | Errors |
|---|---|---|---|---|---|---|
GET | /v1/webhook-deliveries | List Webhook Deliveries | Bearer token (BearerAuth) | None. | 200 application/json: Page_WebhookDeliveryResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/webhook-deliveries/{delivery_id} | Get Webhook Delivery | Bearer token (BearerAuth) | None. | 200 application/json: WebhookDeliveryDetailResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/webhook-endpoints | List Webhook Endpoints | Bearer token (BearerAuth) | None. | 200 application/json: Page_WebhookEndpointResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/webhook-endpoints | Create Webhook Endpoint | Bearer token (BearerAuth) | application/json: WebhookEndpointCreateRequestBody | 201 application/json: WebhookEndpointSecretResponse or WebhookEndpointResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/webhook-endpoints/{webhook_endpoint_id} | Get Webhook Endpoint | Bearer token (BearerAuth) | None. | 200 application/json: WebhookEndpointResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/webhook-endpoints/{webhook_endpoint_id} | Update Webhook Endpoint | Bearer token (BearerAuth) | application/json: WebhookEndpointUpdateRequestBody | 200 application/json: WebhookEndpointResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
DELETE | /v1/webhook-endpoints/{webhook_endpoint_id} | Delete Webhook Endpoint | Bearer token (BearerAuth) | None. | 200 application/json: WebhookEndpointResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret | Rotate Webhook Endpoint Secret | Bearer token (BearerAuth) | None. | 200 application/json: WebhookEndpointSecretResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/webhook-endpoints/{webhook_endpoint_id}/test | Test Webhook Endpoint | Bearer token (BearerAuth) | None. | 200 application/json: WebhookDeliveryDetailResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
Loading API reference...