Webhook APIs
Version: aju17f20mq
Use the reference below for request and response fields and operation-specific requirements.
Overview
Register HTTPS endpoints, subscribe them to events and inspect or retry deliveries.
Authentication
Use an authorized backend sk_… key in X-API-Key; these configuration operations do not need an end-user identity. A console JWT belongs to the separate console surface. See Authentication.
Tenant context comes from the authenticated request. Client-supplied X-Tenant-Id, X-User-Id or X-Project-Id are not an authorization mechanism. The current public integration uses the default project. Do not rely on project headers for separate project, test/live or customer isolation on this API.
Endpoints and subscriptions
An endpoint is your receiving URL; a subscription selects its events. Supplying eventTypes during endpoint creation also attempts a subscription, but the two writes can partially succeed. Reconcile before retrying. The current platform permits one live subscription per endpoint and rejects a second. Replacement by delete-then-create has a delivery gap; temporary overlap requires a separately created endpoint, receiver deduplication and a qualified cutover.
Addressing Subscriptions
Subscription references accept exactly one of subscriptionId or externalId where offered. An external ID is unique among live subscriptions in its current scope and may be reused after deletion; do not treat a reused alias as the original subscription’s immutable identity.
Provider cursor traversal can produce estimated totals until exhausted. Re-queue acceptance is not proof of successful delivery or business processing.
Related guide: Webhooks
JSON conventions
Requests accept snake_case or camelCase field names; responses use camelCase. Ordinary default-valued scalars and empty repeated fields can be omitted. Explicitly present optional scalars, map values and well-known JSON types follow their own presence rules: an explicit false, 0 or empty value is not universally equivalent to absence. Decode each field according to its schema. 64-bit integers use JSON strings; preserve their precision. Unknown request fields are generally discarded before validation, so a typo can silently change behavior. This is not a guarantee that arbitrary fields or future client contracts are supported. See API conventions.
Endpoints
Register and manage the URLs that receive webhook deliveries.
- Create a webhook endpoint
- List webhook endpoints
- Update a webhook endpoint
- Delete a webhook endpoint
Subscriptions
Bind an endpoint to event types. One live subscription is allowed per endpoint; subscriptions on separate endpoints can receive the same event.
Deliveries
Inspect delivery records and request another attempt for eligible retained deliveries.
Server 1
Travila API
X-API-Key
Authorized tenant backend secret key (sk_…). No end-user identity is needed for these tenant/project configuration operations. Keep the key out of client apps; authorization and provisioning still apply.
Authorization: Bearer
The end user's own JWT, issued by the OIDC provider configured on the publishable key. Required alongside a pk_… key, and supplies the user identity in place of X-On-Behalf-Of.
Authentication credentials
- API Key: apiKeyAuth
- API Key: onBehalfOf
- HTTP: bearerAuth
| Setting | Value |
|---|---|
| Security scheme type | apiKey |
| header parameter name | X-API-Key |
| Setting | Value |
|---|---|
| Security scheme type | apiKey |
| header parameter name | X-On-Behalf-Of |
| Setting | Value |
|---|---|
| Security scheme type | http |
| Scheme | bearer |
Operations
- Create a webhook endpoint —
POST /api/v1/webhooks/create-endpoint - List webhook endpoints —
POST /api/v1/webhooks/list-endpoints - Update a webhook endpoint —
POST /api/v1/webhooks/update-endpoint - Delete a webhook endpoint —
POST /api/v1/webhooks/delete-endpoint - Create a webhook subscription —
POST /api/v1/webhooks/create-subscription - List webhook subscriptions —
POST /api/v1/webhooks/list-subscriptions - Delete a webhook subscription —
POST /api/v1/webhooks/delete-subscription - List webhook event deliveries —
POST /api/v1/webhooks/list-deliveries - Retry a failed webhook delivery —
POST /api/v1/webhooks/retry-delivery
Document ID: DOC-API-webhooks-overview. Section identities and revisions.
| Section | Stable reference |
|---|---|
| Overview | DOC-API-webhooks-overview#overview |
| Authentication | DOC-API-webhooks-overview#authentication |
| Endpoints and subscriptions | DOC-API-webhooks-overview#endpoints-and-subscriptions |
| Addressing Subscriptions | DOC-API-webhooks-overview#addressing-subscriptions |
| JSON conventions | DOC-API-webhooks-overview#json-conventions |
| Endpoints | DOC-API-webhooks-overview#reference-group-1 |
| Subscriptions | DOC-API-webhooks-overview#reference-group-2 |
| Deliveries | DOC-API-webhooks-overview#reference-group-3 |
| Server 1 | DOC-API-webhooks-overview#reference-server-1 |
| X-API-Key | DOC-API-webhooks-overview#authentication-apiKeyAuth |
| Authorization: Bearer | DOC-API-webhooks-overview#authentication-bearerAuth |