Webhooks API
Generierte OpenAPI-Referenz für die Webhooks-API-Oberfläche.
Überblick
Webhooks-Endpoints gehören zur öffentlichen Everyn-API. Verwaltung von Webhook-Endpunkten, einmalige Anzeige und Rotation von Signaturgeheimnissen, Testzustellungen und sichere Einsicht in Zustellungen.
Endpunkte
Die generierte OpenAPI-Komponente unten enthält Request-Parameter, Request Bodies, Response Bodies, Statuscodes und Schemas für dieses Tag. Die statische Zusammenfassung hält Zweck, Authentifizierung, Schemanamen und Hinweise zur API-Fehlerbehandlung verfügbar, bevor die interaktive Referenz geladen ist.
Die Details unten sind statisches HTML aus demselben OpenAPI-Schema und bleiben ohne clientseitiges JavaScript lesbar. Die interaktive Komponente danach ergänzt ausklappbare Beispiele und Schema-Browsing.
Endpoint-Zusammenfassung für den schnellen Überblick vor der generierten Referenz:
| Methode | Pfad | Zweck | Authentifizierung | Request Body / Schema | Erfolgs-Response / Schema | Fehler |
|---|---|---|---|---|---|---|
GET | /v1/webhook-deliveries | Webhook-Zustellungen auflisten | Bearer-Token (BearerAuth) | Keine. | 200 application/json: Page_WebhookDeliveryResponse_ | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/webhook-deliveries/{delivery_id} | Webhook-Zustellung abrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: WebhookDeliveryDetailResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/webhook-endpoints | Webhook-Endpunkte auflisten | Bearer-Token (BearerAuth) | Keine. | 200 application/json: Page_WebhookEndpointResponse_ | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/webhook-endpoints | Webhook-Endpunkt erstellen | Bearer-Token (BearerAuth) | application/json: WebhookEndpointCreateRequestBody | 201 application/json: WebhookEndpointSecretResponse oder WebhookEndpointResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/webhook-endpoints/{webhook_endpoint_id} | Webhook-Endpunkt abrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: WebhookEndpointResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/webhook-endpoints/{webhook_endpoint_id} | Webhook-Endpunkt aktualisieren | Bearer-Token (BearerAuth) | application/json: WebhookEndpointUpdateRequestBody | 200 application/json: WebhookEndpointResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
DELETE | /v1/webhook-endpoints/{webhook_endpoint_id} | Webhook-Endpunkt löschen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: WebhookEndpointResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret | Signaturgeheimnis des Webhook-Endpunkts rotieren | Bearer-Token (BearerAuth) | Keine. | 200 application/json: WebhookEndpointSecretResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/webhook-endpoints/{webhook_endpoint_id}/test | Webhook-Endpunkt testen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: WebhookDeliveryDetailResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
API-Referenz wird geladen...