Save the outbound webhook configuration
curl --request PUT \
--url https://api.closebot.com/agency/source/{sourceId}/webhook-integration/outbound \
--header 'Content-Type: application/json' \
--header 'X-CB-KEY: <api-key>' \
--data '
{
"mode": "<string>",
"webhookCallbackUri": "<string>",
"sendMessageTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"setFieldTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"externalApiKey": "<string>"
}
'import requests
url = "https://api.closebot.com/agency/source/{sourceId}/webhook-integration/outbound"
payload = {
"mode": "<string>",
"webhookCallbackUri": "<string>",
"sendMessageTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"setFieldTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"externalApiKey": "<string>"
}
headers = {
"X-CB-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-CB-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mode: '<string>',
webhookCallbackUri: '<string>',
sendMessageTemplate: {
method: '<string>',
url: '<string>',
headers: [{name: '<string>', value: '<string>'}],
bodyTemplate: '<string>'
},
setFieldTemplate: {
method: '<string>',
url: '<string>',
headers: [{name: '<string>', value: '<string>'}],
bodyTemplate: '<string>'
},
externalApiKey: '<string>'
})
};
fetch('https://api.closebot.com/agency/source/{sourceId}/webhook-integration/outbound', 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.closebot.com/agency/source/{sourceId}/webhook-integration/outbound",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'mode' => '<string>',
'webhookCallbackUri' => '<string>',
'sendMessageTemplate' => [
'method' => '<string>',
'url' => '<string>',
'headers' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'bodyTemplate' => '<string>'
],
'setFieldTemplate' => [
'method' => '<string>',
'url' => '<string>',
'headers' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'bodyTemplate' => '<string>'
],
'externalApiKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CB-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.closebot.com/agency/source/{sourceId}/webhook-integration/outbound"
payload := strings.NewReader("{\n \"mode\": \"<string>\",\n \"webhookCallbackUri\": \"<string>\",\n \"sendMessageTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"setFieldTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"externalApiKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-CB-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.put("https://api.closebot.com/agency/source/{sourceId}/webhook-integration/outbound")
.header("X-CB-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"<string>\",\n \"webhookCallbackUri\": \"<string>\",\n \"sendMessageTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"setFieldTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"externalApiKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.closebot.com/agency/source/{sourceId}/webhook-integration/outbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-CB-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mode\": \"<string>\",\n \"webhookCallbackUri\": \"<string>\",\n \"sendMessageTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"setFieldTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"externalApiKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"configured": true,
"requireAccessToken": true,
"inbound": {
"contactIdPath": "<string>",
"bodyPath": "<string>",
"attachmentsPath": "<string>",
"statePath": "<string>",
"contactFieldPaths": {}
},
"filterKey": {
"path": "<string>",
"expectedValue": "<string>"
},
"outboundMode": "<string>",
"sendMessageTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"setFieldTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"getContactTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"contactFieldResponsePaths": {},
"webhookCallbackUri": "<string>",
"hasExternalApiKey": true,
"listenUntil": "2023-11-07T05:31:56Z",
"contactFieldDescriptors": [
"<string>"
],
"lastTestResults": {},
"selectedSampleEventId": 123
}"<string>"Source
Save the outbound webhook configuration
Mode “legacy” POSTs bot events to the callback URL; mode “templates” executes the saved HTTP request templates directly against the external API. For the external API key: null leaves it unchanged, an empty string clears it.
PUT
/
agency
/
source
/
{sourceId}
/
webhook-integration
/
outbound
Save the outbound webhook configuration
curl --request PUT \
--url https://api.closebot.com/agency/source/{sourceId}/webhook-integration/outbound \
--header 'Content-Type: application/json' \
--header 'X-CB-KEY: <api-key>' \
--data '
{
"mode": "<string>",
"webhookCallbackUri": "<string>",
"sendMessageTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"setFieldTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"externalApiKey": "<string>"
}
'import requests
url = "https://api.closebot.com/agency/source/{sourceId}/webhook-integration/outbound"
payload = {
"mode": "<string>",
"webhookCallbackUri": "<string>",
"sendMessageTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"setFieldTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"externalApiKey": "<string>"
}
headers = {
"X-CB-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-CB-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mode: '<string>',
webhookCallbackUri: '<string>',
sendMessageTemplate: {
method: '<string>',
url: '<string>',
headers: [{name: '<string>', value: '<string>'}],
bodyTemplate: '<string>'
},
setFieldTemplate: {
method: '<string>',
url: '<string>',
headers: [{name: '<string>', value: '<string>'}],
bodyTemplate: '<string>'
},
externalApiKey: '<string>'
})
};
fetch('https://api.closebot.com/agency/source/{sourceId}/webhook-integration/outbound', 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.closebot.com/agency/source/{sourceId}/webhook-integration/outbound",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'mode' => '<string>',
'webhookCallbackUri' => '<string>',
'sendMessageTemplate' => [
'method' => '<string>',
'url' => '<string>',
'headers' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'bodyTemplate' => '<string>'
],
'setFieldTemplate' => [
'method' => '<string>',
'url' => '<string>',
'headers' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'bodyTemplate' => '<string>'
],
'externalApiKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CB-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.closebot.com/agency/source/{sourceId}/webhook-integration/outbound"
payload := strings.NewReader("{\n \"mode\": \"<string>\",\n \"webhookCallbackUri\": \"<string>\",\n \"sendMessageTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"setFieldTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"externalApiKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-CB-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.put("https://api.closebot.com/agency/source/{sourceId}/webhook-integration/outbound")
.header("X-CB-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"<string>\",\n \"webhookCallbackUri\": \"<string>\",\n \"sendMessageTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"setFieldTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"externalApiKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.closebot.com/agency/source/{sourceId}/webhook-integration/outbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-CB-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mode\": \"<string>\",\n \"webhookCallbackUri\": \"<string>\",\n \"sendMessageTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"setFieldTemplate\": {\n \"method\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"bodyTemplate\": \"<string>\"\n },\n \"externalApiKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"configured": true,
"requireAccessToken": true,
"inbound": {
"contactIdPath": "<string>",
"bodyPath": "<string>",
"attachmentsPath": "<string>",
"statePath": "<string>",
"contactFieldPaths": {}
},
"filterKey": {
"path": "<string>",
"expectedValue": "<string>"
},
"outboundMode": "<string>",
"sendMessageTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"setFieldTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"getContactTemplate": {
"method": "<string>",
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"bodyTemplate": "<string>"
},
"contactFieldResponsePaths": {},
"webhookCallbackUri": "<string>",
"hasExternalApiKey": true,
"listenUntil": "2023-11-07T05:31:56Z",
"contactFieldDescriptors": [
"<string>"
],
"lastTestResults": {},
"selectedSampleEventId": 123
}"<string>"Authorizations
CloseBot API Key Authorization
Path Parameters
The source ID.
Body
application/jsontext/jsonapplication/*+json
The outbound configuration.
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes

