Register a webhook endpoint for booking lifecycle events
curl --request POST \
--url https://api.example.com/v1/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "https://partner.example.com/jinko/webhooks",
"events": [
"booking.completed",
"booking.failed"
]
}
'import requests
url = "https://api.example.com/v1/webhooks"
payload = {
"url": "https://partner.example.com/jinko/webhooks",
"events": ["booking.completed", "booking.failed"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://partner.example.com/jinko/webhooks',
events: ['booking.completed', 'booking.failed']
})
};
fetch('https://api.example.com/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://partner.example.com/jinko/webhooks',
'events' => [
'booking.completed',
'booking.failed'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://partner.example.com/jinko/webhooks\",\n \"events\": [\n \"booking.completed\",\n \"booking.failed\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/webhooks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://partner.example.com/jinko/webhooks\",\n \"events\": [\n \"booking.completed\",\n \"booking.failed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://partner.example.com/jinko/webhooks\",\n \"events\": [\n \"booking.completed\",\n \"booking.failed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"url": "https://partner.example.com/jinko/webhooks",
"events": [
"booking.completed"
],
"secret": "whsec_3f9a…",
"status": "active",
"created_at": "2026-06-02T08:00:00Z"
}{
"error": {
"code": "BAD_REQUEST",
"message": "Malformed JSON in request body.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "AUTH_REQUIRED",
"message": "Invalid or expired API key.",
"doc_url": "https://docs.gojinko.com/api-reference/authentication"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "origins: origins is required; trip_type: trip_type is required",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit or quota exceeded.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "UPSTREAM_ERROR",
"message": "Upstream travel provider returned an error. Please retry.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}Webhooks
register-webhook
Register a callback URL to receive signed booking lifecycle events
POST
/
v1
/
webhooks
Register a webhook endpoint for booking lifecycle events
curl --request POST \
--url https://api.example.com/v1/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "https://partner.example.com/jinko/webhooks",
"events": [
"booking.completed",
"booking.failed"
]
}
'import requests
url = "https://api.example.com/v1/webhooks"
payload = {
"url": "https://partner.example.com/jinko/webhooks",
"events": ["booking.completed", "booking.failed"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://partner.example.com/jinko/webhooks',
events: ['booking.completed', 'booking.failed']
})
};
fetch('https://api.example.com/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://partner.example.com/jinko/webhooks',
'events' => [
'booking.completed',
'booking.failed'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://partner.example.com/jinko/webhooks\",\n \"events\": [\n \"booking.completed\",\n \"booking.failed\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/webhooks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://partner.example.com/jinko/webhooks\",\n \"events\": [\n \"booking.completed\",\n \"booking.failed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://partner.example.com/jinko/webhooks\",\n \"events\": [\n \"booking.completed\",\n \"booking.failed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"url": "https://partner.example.com/jinko/webhooks",
"events": [
"booking.completed"
],
"secret": "whsec_3f9a…",
"status": "active",
"created_at": "2026-06-02T08:00:00Z"
}{
"error": {
"code": "BAD_REQUEST",
"message": "Malformed JSON in request body.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "AUTH_REQUIRED",
"message": "Invalid or expired API key.",
"doc_url": "https://docs.gojinko.com/api-reference/authentication"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "origins: origins is required; trip_type: trip_type is required",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit or quota exceeded.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}{
"error": {
"code": "UPSTREAM_ERROR",
"message": "Upstream travel provider returned an error. Please retry.",
"doc_url": "https://docs.gojinko.com/concepts/errors"
}
}Subscribe an HTTPS endpoint to
booking.completed / booking.failed. The response includes the HMAC signing secret once: store it; later reads only show a prefix. Jinko POSTs each event signed with X-Jinko-Signature: sha256=<hex> over "<X-Jinko-Timestamp>.<raw body>". See the Webhooks guide for payloads and signature verification.Authorizations
ApiKeyAuthBearerAuth
Body
application/json
Response
Webhook registered (secret shown once)
Example:
42
Example:
"https://partner.example.com/jinko/webhooks"
Example:
["booking.completed"]HMAC signing secret. Returned ONCE — store it securely; later reads show only a prefix.
Example:
"whsec_3f9a…"
Example:
"active"
Example:
"2026-06-02T08:00:00Z"
⌘I
