curl --request POST \
--url https://api.safarapi.com/api/partner/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Signature: <x-signature>' \
--header 'X-Timestamp: <x-timestamp>' \
--data '
{
"url": "https://partner-bank.example.com/safariat/webhooks",
"events": [
"booking.confirmed",
"booking.cancelled",
"settlement.issued"
],
"description": "Primary endpoint of the bank platform"
}
'import requests
url = "https://api.safarapi.com/api/partner/v1/webhooks"
payload = {
"url": "https://partner-bank.example.com/safariat/webhooks",
"events": ["booking.confirmed", "booking.cancelled", "settlement.issued"],
"description": "Primary endpoint of the bank platform"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-Timestamp": "<x-timestamp>",
"X-Signature": "<x-signature>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'X-Timestamp': '<x-timestamp>',
'X-Signature': '<x-signature>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
url: 'https://partner-bank.example.com/safariat/webhooks',
events: ['booking.confirmed', 'booking.cancelled', 'settlement.issued'],
description: 'Primary endpoint of the bank platform'
})
};
fetch('https://api.safarapi.com/api/partner/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.safarapi.com/api/partner/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-bank.example.com/safariat/webhooks',
'events' => [
'booking.confirmed',
'booking.cancelled',
'settlement.issued'
],
'description' => 'Primary endpoint of the bank platform'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"X-Signature: <x-signature>",
"X-Timestamp: <x-timestamp>"
],
]);
$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.safarapi.com/api/partner/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://partner-bank.example.com/safariat/webhooks\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\",\n \"settlement.issued\"\n ],\n \"description\": \"Primary endpoint of the bank platform\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-Timestamp", "<x-timestamp>")
req.Header.Add("X-Signature", "<x-signature>")
req.Header.Add("Authorization", "Bearer <token>")
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.safarapi.com/api/partner/v1/webhooks")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-Timestamp", "<x-timestamp>")
.header("X-Signature", "<x-signature>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://partner-bank.example.com/safariat/webhooks\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\",\n \"settlement.issued\"\n ],\n \"description\": \"Primary endpoint of the bank platform\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.safarapi.com/api/partner/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-Timestamp"] = '<x-timestamp>'
request["X-Signature"] = '<x-signature>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://partner-bank.example.com/safariat/webhooks\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\",\n \"settlement.issued\"\n ],\n \"description\": \"Primary endpoint of the bank platform\"\n}"
response = http.request(request)
puts response.read_bodyRegister a webhook endpoint
Configures an HTTPS endpoint that Safariat will call to deliver the selected events.
The response contains the signing_secret to use on the bank side to verify the
X-SafarApi-Signature signature of each delivery. The secret is shown only once.
Retries on failure: exponential at 5 min, 15 min, 1 h, 6 h, 24 h. Beyond that, the event is moved to the dead-letter queue and is visible in the partner portal.
curl --request POST \
--url https://api.safarapi.com/api/partner/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Signature: <x-signature>' \
--header 'X-Timestamp: <x-timestamp>' \
--data '
{
"url": "https://partner-bank.example.com/safariat/webhooks",
"events": [
"booking.confirmed",
"booking.cancelled",
"settlement.issued"
],
"description": "Primary endpoint of the bank platform"
}
'import requests
url = "https://api.safarapi.com/api/partner/v1/webhooks"
payload = {
"url": "https://partner-bank.example.com/safariat/webhooks",
"events": ["booking.confirmed", "booking.cancelled", "settlement.issued"],
"description": "Primary endpoint of the bank platform"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-Timestamp": "<x-timestamp>",
"X-Signature": "<x-signature>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'X-Timestamp': '<x-timestamp>',
'X-Signature': '<x-signature>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
url: 'https://partner-bank.example.com/safariat/webhooks',
events: ['booking.confirmed', 'booking.cancelled', 'settlement.issued'],
description: 'Primary endpoint of the bank platform'
})
};
fetch('https://api.safarapi.com/api/partner/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.safarapi.com/api/partner/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-bank.example.com/safariat/webhooks',
'events' => [
'booking.confirmed',
'booking.cancelled',
'settlement.issued'
],
'description' => 'Primary endpoint of the bank platform'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"X-Signature: <x-signature>",
"X-Timestamp: <x-timestamp>"
],
]);
$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.safarapi.com/api/partner/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://partner-bank.example.com/safariat/webhooks\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\",\n \"settlement.issued\"\n ],\n \"description\": \"Primary endpoint of the bank platform\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-Timestamp", "<x-timestamp>")
req.Header.Add("X-Signature", "<x-signature>")
req.Header.Add("Authorization", "Bearer <token>")
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.safarapi.com/api/partner/v1/webhooks")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-Timestamp", "<x-timestamp>")
.header("X-Signature", "<x-signature>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://partner-bank.example.com/safariat/webhooks\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\",\n \"settlement.issued\"\n ],\n \"description\": \"Primary endpoint of the bank platform\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.safarapi.com/api/partner/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-Timestamp"] = '<x-timestamp>'
request["X-Signature"] = '<x-signature>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://partner-bank.example.com/safariat/webhooks\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\",\n \"settlement.issued\"\n ],\n \"description\": \"Primary endpoint of the bank platform\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API key authentication. Issued by the Safariat admin or via the partner portal. The secret is shown only once at generation.
Production sk_live_* keys must additionally sign every write request
(POST/PUT/DELETE) with the X-Timestamp and X-Signature headers.
Sandbox sk_test_* keys are exempt from request signing: X-Signature and
X-Timestamp are not required for writes in the sandbox (so the developer-portal
"Try it" playground works end to end). The Idempotency-Key header remains
required on writes in both environments.
Headers
Opaque, client-generated string unique per logical operation (a UUID v4 is
recommended but any non-blank value up to 255 chars is accepted). Same key +
same body = the cached response is returned with the Idempotent-Replayed: true
header. Same key + different body = 409 Conflict. Retained for 24 h.
255Unix timestamp in seconds at the time the request is issued. Validity window
±5 minutes — beyond that the request is rejected. Required for production
sk_live_* keys only; not required for sandbox sk_test_* keys.
hex(HMAC_SHA256(secret, "{X-Timestamp}\n{METHOD}\n{path}\n{body}")).
The path includes the query string. The body is the exact JSON representation
sent — any reformatting invalidates the signature. Required for production
sk_live_* keys only; not required for sandbox sk_test_* keys.
^[a-f0-9]{64}$Body
The bank's HTTPS endpoint. HTTP is rejected.
^https://1booking.confirmed, booking.cancelled, booking.completed, settlement.issued, settlement.paid, review.moderated 200Response
Webhook created, signing_secret returned in clear (once only)
booking.confirmed, booking.cancelled, booking.completed, settlement.issued, settlement.paid, review.moderated ACTIVE, DISABLED HMAC secret to verify X-SafarApi-Signature on deliveries.
Shown only once, never displayable again.
Last HTTP status received from the bank.