Webhooks

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>".

post/v1/webhooks

Request

Base URL
https://api.gojinko.com
URL
https://api.gojinko.com/v1/webhooks
Auth
- API key in header X-API-Key
- or HTTP bearer

Request body

urlstring uri required

eventsWebhookEvent[] required

Example request

{
  "url": "https://partner.example.com/jinko/webhooks",
  "events": [
    "booking.completed",
    "booking.failed",
    "booking.partial"
  ]
}

Response

Webhook registered (secret shown once)

idnumber required

urlstring required

eventsstring[] required

secretstring required

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

statusstring required

created_atstring required

Example response

{
  "id": 42,
  "url": "https://partner.example.com/jinko/webhooks",
  "events": [
    "booking.completed"
  ],
  "secret": "whsec_3f9a…",
  "status": "active",
  "created_at": "2026-06-02T08:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.