SDK
import { createVoyantConnectClient } from "@voyant-travel/connect-sdk";
const connect = createVoyantConnectClient({ apiKey: process.env.VOYANT_API_KEY });
const result = await connect.webhookSubscriptions.create("<operatorId>", {
"url": "https://example.com/webhooks/connect",
"events": [
"booking.confirmed",
"booking.cancelled"
],
"connectionId": "<string>",
"secret": "<string>"
});curl --request POST \
--url https://api.voyant.travel/connect/v1/operators/<operatorId>/webhook-subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks/connect",
"events": [
"booking.confirmed",
"booking.cancelled"
],
"connectionId": "<string>",
"secret": "<string>"
}'const response = await fetch("https://api.voyant.travel/connect/v1/operators/<operatorId>/webhook-subscriptions", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer <token>"
},
body: JSON.stringify({
"url": "https://example.com/webhooks/connect",
"events": [
"booking.confirmed",
"booking.cancelled"
],
"connectionId": "<string>",
"secret": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
"https://api.voyant.travel/connect/v1/operators/<operatorId>/webhook-subscriptions",
headers={
"Authorization": "Bearer <token>"
},
json={
"url": "https://example.com/webhooks/connect",
"events": [
"booking.confirmed",
"booking.cancelled"
],
"connectionId": "<string>",
"secret": "<string>"
}
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voyant.travel/connect/v1/operators/{operatorId}/webhook-subscriptions",
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://example.com/webhooks/connect',
'events' => [
'booking.confirmed',
'booking.cancelled'
],
'connectionId' => '<string>',
'secret' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.voyant.travel/connect/v1/operators/{operatorId}/webhook-subscriptions"
payload := strings.NewReader("{\n \"url\": \"https://example.com/webhooks/connect\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\"\n ],\n \"connectionId\": \"<string>\",\n \"secret\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.voyant.travel/connect/v1/operators/{operatorId}/webhook-subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com/webhooks/connect\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\"\n ],\n \"connectionId\": \"<string>\",\n \"secret\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voyant.travel/connect/v1/operators/{operatorId}/webhook-subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://example.com/webhooks/connect\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\"\n ],\n \"connectionId\": \"<string>\",\n \"secret\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"operatorId": "<string>",
"url": "<string>",
"events": [
"<string>"
],
"status": "active",
"hasSecret": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"connectionId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}Webhook Subscriptions
Create a webhook subscription
Subscribes a URL to one or more Connect event types, optionally scoped to a single connection. Requires a *:write scope.
POST
/
connect
/
v1
/
operators
/
{operatorId}
/
webhook-subscriptions
SDK
import { createVoyantConnectClient } from "@voyant-travel/connect-sdk";
const connect = createVoyantConnectClient({ apiKey: process.env.VOYANT_API_KEY });
const result = await connect.webhookSubscriptions.create("<operatorId>", {
"url": "https://example.com/webhooks/connect",
"events": [
"booking.confirmed",
"booking.cancelled"
],
"connectionId": "<string>",
"secret": "<string>"
});curl --request POST \
--url https://api.voyant.travel/connect/v1/operators/<operatorId>/webhook-subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks/connect",
"events": [
"booking.confirmed",
"booking.cancelled"
],
"connectionId": "<string>",
"secret": "<string>"
}'const response = await fetch("https://api.voyant.travel/connect/v1/operators/<operatorId>/webhook-subscriptions", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer <token>"
},
body: JSON.stringify({
"url": "https://example.com/webhooks/connect",
"events": [
"booking.confirmed",
"booking.cancelled"
],
"connectionId": "<string>",
"secret": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
"https://api.voyant.travel/connect/v1/operators/<operatorId>/webhook-subscriptions",
headers={
"Authorization": "Bearer <token>"
},
json={
"url": "https://example.com/webhooks/connect",
"events": [
"booking.confirmed",
"booking.cancelled"
],
"connectionId": "<string>",
"secret": "<string>"
}
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voyant.travel/connect/v1/operators/{operatorId}/webhook-subscriptions",
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://example.com/webhooks/connect',
'events' => [
'booking.confirmed',
'booking.cancelled'
],
'connectionId' => '<string>',
'secret' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.voyant.travel/connect/v1/operators/{operatorId}/webhook-subscriptions"
payload := strings.NewReader("{\n \"url\": \"https://example.com/webhooks/connect\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\"\n ],\n \"connectionId\": \"<string>\",\n \"secret\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.voyant.travel/connect/v1/operators/{operatorId}/webhook-subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com/webhooks/connect\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\"\n ],\n \"connectionId\": \"<string>\",\n \"secret\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voyant.travel/connect/v1/operators/{operatorId}/webhook-subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://example.com/webhooks/connect\",\n \"events\": [\n \"booking.confirmed\",\n \"booking.cancelled\"\n ],\n \"connectionId\": \"<string>\",\n \"secret\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"operatorId": "<string>",
"url": "<string>",
"events": [
"<string>"
],
"status": "active",
"hasSecret": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"connectionId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}Authorizations
Provide either a static platform API key or an OAuth2 access token (from /connect/v1/oauth/token) as Authorization: Bearer <token>. Scopes are connect:* (e.g. connect:bookings:write).
Path Parameters
Operator id.
Body
application/json
⌘I