Create a webhook
curl --request POST \
--url https://api.{domain}/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://you.example.com/hooks/gobare",
"events": [
"turn.completed",
"turn.failed"
]
}
'import requests
url = "https://api.{domain}/v1/webhooks"
payload = {
"url": "https://you.example.com/hooks/gobare",
"events": ["turn.completed", "turn.failed"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://you.example.com/hooks/gobare',
events: ['turn.completed', 'turn.failed']
})
};
fetch('https://api.{domain}/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.{domain}/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://you.example.com/hooks/gobare',
'events' => [
'turn.completed',
'turn.failed'
]
]),
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.{domain}/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://you.example.com/hooks/gobare\",\n \"events\": [\n \"turn.completed\",\n \"turn.failed\"\n ]\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.{domain}/v1/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://you.example.com/hooks/gobare\",\n \"events\": [\n \"turn.completed\",\n \"turn.failed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{domain}/v1/webhooks")
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://you.example.com/hooks/gobare\",\n \"events\": [\n \"turn.completed\",\n \"turn.failed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"object": "webhook.subscription",
"id": "<string>",
"url": "<string>",
"events": [
"<string>"
],
"secret": "<string>",
"active": true
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}API Reference
Create a webhook
Subscribe an endpoint to session events.
POST
/
v1
/
webhooks
Create a webhook
curl --request POST \
--url https://api.{domain}/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://you.example.com/hooks/gobare",
"events": [
"turn.completed",
"turn.failed"
]
}
'import requests
url = "https://api.{domain}/v1/webhooks"
payload = {
"url": "https://you.example.com/hooks/gobare",
"events": ["turn.completed", "turn.failed"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://you.example.com/hooks/gobare',
events: ['turn.completed', 'turn.failed']
})
};
fetch('https://api.{domain}/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.{domain}/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://you.example.com/hooks/gobare',
'events' => [
'turn.completed',
'turn.failed'
]
]),
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.{domain}/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://you.example.com/hooks/gobare\",\n \"events\": [\n \"turn.completed\",\n \"turn.failed\"\n ]\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.{domain}/v1/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://you.example.com/hooks/gobare\",\n \"events\": [\n \"turn.completed\",\n \"turn.failed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{domain}/v1/webhooks")
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://you.example.com/hooks/gobare\",\n \"events\": [\n \"turn.completed\",\n \"turn.failed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"object": "webhook.subscription",
"id": "<string>",
"url": "<string>",
"events": [
"<string>"
],
"secret": "<string>",
"active": true
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>"
}
}Authorizations
A gbr_pat_ access token. Scopes are recorded on the token when it is minted.
Headers
Retrying with the same key replays the first answer instead of acting again.
Maximum string length:
255Response
Subscribe an endpoint to session events.
The secret appears in this response only. Store it; it cannot be shown again.
Always webhook.subscription. Names the shape, so a value can be identified without knowing which call returned it.
Allowed value:
"webhook.subscription"Ours. Use it to delete the subscription.
Where deliveries go. Must be https.
Which events to deliver. An empty list means all of them.
Recompute x-gobare-signature as HMAC-SHA256 over <timestamp>.<body>.
False once deliveries have been given up on. See webhooks.md on retries and dead letters.