Subscribe a Webhook
curl --request POST \
--url https://api.callers.ai/campaigns/{campaignId}/webhook/subscribe \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"name": "<string>",
"events": [
"POST_PROCESSING_FINISHED:INTERESTED",
"POST_PROCESSING_FINISHED:NOT_INTERESTED",
"POST_PROCESSING_FINISHED:CALL_ME_LATER",
"POST_PROCESSING_FINISHED:WRONG_NUMBER",
"POST_PROCESSING_FINISHED:DO_NOT_CALL"
],
"isAdvanced": false,
"advancedWebhook": {
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"parameters": [
{
"name": "<string>",
"value": "<string>"
}
],
"body": ""
}
}
'import requests
url = "https://api.callers.ai/campaigns/{campaignId}/webhook/subscribe"
payload = {
"url": "<string>",
"name": "<string>",
"events": ["POST_PROCESSING_FINISHED:INTERESTED", "POST_PROCESSING_FINISHED:NOT_INTERESTED", "POST_PROCESSING_FINISHED:CALL_ME_LATER", "POST_PROCESSING_FINISHED:WRONG_NUMBER", "POST_PROCESSING_FINISHED:DO_NOT_CALL"],
"isAdvanced": False,
"advancedWebhook": {
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"parameters": [
{
"name": "<string>",
"value": "<string>"
}
],
"body": ""
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
name: '<string>',
events: [
'POST_PROCESSING_FINISHED:INTERESTED',
'POST_PROCESSING_FINISHED:NOT_INTERESTED',
'POST_PROCESSING_FINISHED:CALL_ME_LATER',
'POST_PROCESSING_FINISHED:WRONG_NUMBER',
'POST_PROCESSING_FINISHED:DO_NOT_CALL'
],
isAdvanced: false,
advancedWebhook: {
url: '<string>',
headers: [{name: '<string>', value: '<string>'}],
parameters: [{name: '<string>', value: '<string>'}],
body: JSON.stringify('')
}
})
};
fetch('https://api.callers.ai/campaigns/{campaignId}/webhook/subscribe', 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.callers.ai/campaigns/{campaignId}/webhook/subscribe",
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' => '<string>',
'name' => '<string>',
'events' => [
'POST_PROCESSING_FINISHED:INTERESTED',
'POST_PROCESSING_FINISHED:NOT_INTERESTED',
'POST_PROCESSING_FINISHED:CALL_ME_LATER',
'POST_PROCESSING_FINISHED:WRONG_NUMBER',
'POST_PROCESSING_FINISHED:DO_NOT_CALL'
],
'isAdvanced' => false,
'advancedWebhook' => [
'url' => '<string>',
'headers' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'parameters' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'body' => ''
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.callers.ai/campaigns/{campaignId}/webhook/subscribe"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"POST_PROCESSING_FINISHED:INTERESTED\",\n \"POST_PROCESSING_FINISHED:NOT_INTERESTED\",\n \"POST_PROCESSING_FINISHED:CALL_ME_LATER\",\n \"POST_PROCESSING_FINISHED:WRONG_NUMBER\",\n \"POST_PROCESSING_FINISHED:DO_NOT_CALL\"\n ],\n \"isAdvanced\": false,\n \"advancedWebhook\": {\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.callers.ai/campaigns/{campaignId}/webhook/subscribe")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"POST_PROCESSING_FINISHED:INTERESTED\",\n \"POST_PROCESSING_FINISHED:NOT_INTERESTED\",\n \"POST_PROCESSING_FINISHED:CALL_ME_LATER\",\n \"POST_PROCESSING_FINISHED:WRONG_NUMBER\",\n \"POST_PROCESSING_FINISHED:DO_NOT_CALL\"\n ],\n \"isAdvanced\": false,\n \"advancedWebhook\": {\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.callers.ai/campaigns/{campaignId}/webhook/subscribe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"POST_PROCESSING_FINISHED:INTERESTED\",\n \"POST_PROCESSING_FINISHED:NOT_INTERESTED\",\n \"POST_PROCESSING_FINISHED:CALL_ME_LATER\",\n \"POST_PROCESSING_FINISHED:WRONG_NUMBER\",\n \"POST_PROCESSING_FINISHED:DO_NOT_CALL\"\n ],\n \"isAdvanced\": false,\n \"advancedWebhook\": {\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": true
}{
"status": "error",
"message": "<string>",
"data": [
{}
]
}{
"status": "error",
"message": "<string>"
}{
"status": "error",
"message": "<string>"
}Webhooks
Subscribe a Webhook
Add a new webhook to the specified campaign.
POST
/
campaigns
/
{campaignId}
/
webhook
/
subscribe
Subscribe a Webhook
curl --request POST \
--url https://api.callers.ai/campaigns/{campaignId}/webhook/subscribe \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"name": "<string>",
"events": [
"POST_PROCESSING_FINISHED:INTERESTED",
"POST_PROCESSING_FINISHED:NOT_INTERESTED",
"POST_PROCESSING_FINISHED:CALL_ME_LATER",
"POST_PROCESSING_FINISHED:WRONG_NUMBER",
"POST_PROCESSING_FINISHED:DO_NOT_CALL"
],
"isAdvanced": false,
"advancedWebhook": {
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"parameters": [
{
"name": "<string>",
"value": "<string>"
}
],
"body": ""
}
}
'import requests
url = "https://api.callers.ai/campaigns/{campaignId}/webhook/subscribe"
payload = {
"url": "<string>",
"name": "<string>",
"events": ["POST_PROCESSING_FINISHED:INTERESTED", "POST_PROCESSING_FINISHED:NOT_INTERESTED", "POST_PROCESSING_FINISHED:CALL_ME_LATER", "POST_PROCESSING_FINISHED:WRONG_NUMBER", "POST_PROCESSING_FINISHED:DO_NOT_CALL"],
"isAdvanced": False,
"advancedWebhook": {
"url": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"parameters": [
{
"name": "<string>",
"value": "<string>"
}
],
"body": ""
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
name: '<string>',
events: [
'POST_PROCESSING_FINISHED:INTERESTED',
'POST_PROCESSING_FINISHED:NOT_INTERESTED',
'POST_PROCESSING_FINISHED:CALL_ME_LATER',
'POST_PROCESSING_FINISHED:WRONG_NUMBER',
'POST_PROCESSING_FINISHED:DO_NOT_CALL'
],
isAdvanced: false,
advancedWebhook: {
url: '<string>',
headers: [{name: '<string>', value: '<string>'}],
parameters: [{name: '<string>', value: '<string>'}],
body: JSON.stringify('')
}
})
};
fetch('https://api.callers.ai/campaigns/{campaignId}/webhook/subscribe', 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.callers.ai/campaigns/{campaignId}/webhook/subscribe",
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' => '<string>',
'name' => '<string>',
'events' => [
'POST_PROCESSING_FINISHED:INTERESTED',
'POST_PROCESSING_FINISHED:NOT_INTERESTED',
'POST_PROCESSING_FINISHED:CALL_ME_LATER',
'POST_PROCESSING_FINISHED:WRONG_NUMBER',
'POST_PROCESSING_FINISHED:DO_NOT_CALL'
],
'isAdvanced' => false,
'advancedWebhook' => [
'url' => '<string>',
'headers' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'parameters' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'body' => ''
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.callers.ai/campaigns/{campaignId}/webhook/subscribe"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"POST_PROCESSING_FINISHED:INTERESTED\",\n \"POST_PROCESSING_FINISHED:NOT_INTERESTED\",\n \"POST_PROCESSING_FINISHED:CALL_ME_LATER\",\n \"POST_PROCESSING_FINISHED:WRONG_NUMBER\",\n \"POST_PROCESSING_FINISHED:DO_NOT_CALL\"\n ],\n \"isAdvanced\": false,\n \"advancedWebhook\": {\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.callers.ai/campaigns/{campaignId}/webhook/subscribe")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"POST_PROCESSING_FINISHED:INTERESTED\",\n \"POST_PROCESSING_FINISHED:NOT_INTERESTED\",\n \"POST_PROCESSING_FINISHED:CALL_ME_LATER\",\n \"POST_PROCESSING_FINISHED:WRONG_NUMBER\",\n \"POST_PROCESSING_FINISHED:DO_NOT_CALL\"\n ],\n \"isAdvanced\": false,\n \"advancedWebhook\": {\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.callers.ai/campaigns/{campaignId}/webhook/subscribe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"POST_PROCESSING_FINISHED:INTERESTED\",\n \"POST_PROCESSING_FINISHED:NOT_INTERESTED\",\n \"POST_PROCESSING_FINISHED:CALL_ME_LATER\",\n \"POST_PROCESSING_FINISHED:WRONG_NUMBER\",\n \"POST_PROCESSING_FINISHED:DO_NOT_CALL\"\n ],\n \"isAdvanced\": false,\n \"advancedWebhook\": {\n \"url\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": true
}{
"status": "error",
"message": "<string>",
"data": [
{}
]
}{
"status": "error",
"message": "<string>"
}{
"status": "error",
"message": "<string>"
}Authorizations
Headers
Optional sub organization ID. Must belong to your main organization API key.
Path Parameters
The campaign ObjectId as a string.
Body
application/json
Maximum string length:
30Available options:
POST_PROCESSING_FINISHED:INTERESTED, POST_PROCESSING_FINISHED:NOT_INTERESTED, POST_PROCESSING_FINISHED:CALL_ME_LATER, POST_PROCESSING_FINISHED:WRONG_NUMBER, POST_PROCESSING_FINISHED:DO_NOT_CALL, POST_PROCESSING_FINISHED:VOICE_MAIL, FORWARDED_CALL_FINISHED, FORWARDED, HANG_UP, DIALING, CONNECTED, FAILED, COULD_NOT_CONNECT:NO_ANSWER, COULD_NOT_CONNECT:BUSY, CALL_FINISHED Show child attributes
Show child attributes
Get call webhook payload by campaign ID and call IDGet all campaign groups for the authenticated organization
⌘I