Webhooks API
Generierte OpenAPI-Referenz für die Webhooks-API-Oberfläche.
Überblick
Webhooks-Endpoints gehören zur öffentlichen Everyn-API. Webhook endpoint management, one-time signing-secret display/rotation, test deliveries, and public-safe delivery inspection.
Endpunkte
Die generierte OpenAPI-Komponente unten enthält Request-Parameter, Request Bodies, Response Bodies, Statuscodes und Schemas für dieses Tag.
Endpoint-Zusammenfassung für den schnellen Überblick vor der generierten Referenz:
Fehler nutzen die PublicErrorEnvelope-Form mit einem X-Request-Id-Header. Die meisten Endpoints unten liefern 400, 401, 403, 404, 409, 422, 429; die wenigen Abweichungen listen ihre eigenen Statuscodes in der Tabelle, die sonst nur Erfolgs-Responses zeigt. Siehe API-Fehler für Envelope und Recovery-Muster.
| Methode | Pfad | Zusammenfassung | Request Body | Erfolgs-Response |
|---|---|---|---|---|
GET | /v1/webhook-deliveries | List Webhook Deliveries | Keine. | 200 application/json: Page_WebhookDeliveryResponse_ |
GET | /v1/webhook-deliveries/{delivery_id} | Get Webhook Delivery | Keine. | 200 application/json: WebhookDeliveryDetailResponse |
GET | /v1/webhook-endpoints | List Webhook Endpoints | Keine. | 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 | Keine. | 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 | Keine. | 200 application/json: WebhookEndpointResponse |
POST | /v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret | Rotate Webhook Endpoint Secret | Keine. | 200 application/json: WebhookEndpointSecretResponse |
POST | /v1/webhook-endpoints/{webhook_endpoint_id}/test | Test Webhook Endpoint | Keine. | 200 application/json: WebhookDeliveryDetailResponse |
API-Referenz wird geladen...