Skip to main content
POST
Register a webhook endpoint for booking lifecycle events
Subscribe a callback URL to booking.processing, booking.completed, booking.failed, booking.partial, servicing.completed, servicing.exchange_confirmed, servicing.ticket_issued, or servicing.failed. The response includes the HMAC signing secret ONCE. Deliveries are signed with X-Jinko-Signature: sha256=<hex> over "<X-Jinko-Timestamp>.<raw body>".

Authorizations

X-API-Key
string
header
required

Body

application/json
url
string<uri>
required
Example:

"https://partner.example.com/jinko/webhooks"

events
enum<string>[]
required
Minimum array length: 1

A booking lifecycle event. booking.processing — Payment is authorized and the booking is being confirmed with the suppliers. No supplier reference exists yet. booking.completed — Every item of the booking is confirmed and the payment is captured. booking.failed — No item of the booking could be confirmed. The payment hold is released and nothing is charged. booking.partial — Payment is captured but only some items were confirmed; the trip needs attention. A distinct event, so a handler written before it existed can never mistake it for a success. servicing.completed — A post-booking operation on one booked item (a cancellation) is complete and its money is settled. Distinct from booking.completed: it reports a booking being undone, not made. servicing.exchange_confirmed — The supplier confirmed an exchange of one booked item. For a flight, the new e-ticket number may follow in servicing.ticket_issued. servicing.ticket_issued — The new e-ticket number of an exchanged flight is available. servicing.failed — An exchange or a refund could not be completed. The original booking is unchanged unless the payload says otherwise.

Available options:
booking.processing,
booking.completed,
booking.failed,
booking.partial,
servicing.completed,
servicing.exchange_confirmed,
servicing.ticket_issued,
servicing.failed
Example:

Response

Webhook registered (secret shown once)

id
number
required
Example:

42

url
string
required
Example:

"https://partner.example.com/jinko/webhooks"

events
string[]
required
Example:
secret
string
required

HMAC signing secret. Returned ONCE — store it securely; later reads show only a prefix.

Example:

"whsec_3f9a…"

status
string
required
Example:

"active"

created_at
string
required
Example:

"2026-06-02T08:00:00Z"