API Reference
The webhook endpoints: manage targets, inspect deliveries, rotate secrets, and test.
All endpoints use your Kora API key (Authorization: Bearer <key>). Change the host variable in the
playground to point at your own instance.
Authorization
apiKey Your Kora API key, sent as Authorization: Bearer <key>.
In: header
Query Parameters
Response Body
application/json
curl -X GET "https://example.com/webhooks"[ { "name": "string", "url": "string", "events": [ "string" ], "secret": "string", "enabled": true, "headers": {}, "id": 0 }]Authorization
apiKey Your Kora API key, sent as Authorization: Bearer <key>.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/webhooks" \ -H "Content-Type: application/json" \ -d '{}'{ "name": "string", "url": "string", "events": [ "string" ], "secret": "string", "enabled": true, "headers": {}, "id": 0}Authorization
apiKey Your Kora API key, sent as Authorization: Bearer <key>.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X PATCH "https://example.com/webhooks" \ -H "Content-Type: application/json" \ -d '{}'Authorization
apiKey Your Kora API key, sent as Authorization: Bearer <key>.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X DELETE "https://example.com/webhooks" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'Authorization
apiKey Your Kora API key, sent as Authorization: Bearer <key>.
In: header
Query Parameters
Response Body
application/json
curl -X GET "https://example.com/webhooks/deliveries"[ { "webhook": "string", "event": "string", "status": "pending", "attempts": 0, "code": 0, "error": "string" }]Authorization
apiKey Your Kora API key, sent as Authorization: Bearer <key>.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/webhooks/rotate" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "name": "string", "secret": "string"}Authorization
apiKey Your Kora API key, sent as Authorization: Bearer <key>.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "https://example.com/webhooks/test" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'