Webhooks
Add a webhook
Add a webhook subscription to the account
POST
/
api
/
v1
/
accounts
/
{account_id}
/
webhooks
Add a webhook
curl --request POST \
--url https://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/webhooks \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"url": "https://example.com/webhook",
"subscriptions": [
"conversation_created",
"conversation_status_changed"
]
}
'import requests
url = "https://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/webhooks"
payload = {
"url": "https://example.com/webhook",
"subscriptions": ["conversation_created", "conversation_status_changed"]
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://example.com/webhook',
subscriptions: ['conversation_created', 'conversation_status_changed']
})
};
fetch('https://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/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://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/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://example.com/webhook',
'subscriptions' => [
'conversation_created',
'conversation_status_changed'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <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://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://example.com/webhook\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_token", "<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://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/webhooks")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com/webhook\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://example.com/webhook\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"url": "<string>",
"subscriptions": [
"conversation_created"
],
"account_id": 123
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}Authorizations
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
Body
application/json
The events you want to subscribe to.
Available options:
conversation_created, conversation_status_changed, conversation_updated, message_created, message_updated, contact_created, contact_updated, webwidget_triggered Example:
[
"conversation_created",
"conversation_status_changed"
]
Response
Success
⌘I
Add a webhook
curl --request POST \
--url https://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/webhooks \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"url": "https://example.com/webhook",
"subscriptions": [
"conversation_created",
"conversation_status_changed"
]
}
'import requests
url = "https://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/webhooks"
payload = {
"url": "https://example.com/webhook",
"subscriptions": ["conversation_created", "conversation_status_changed"]
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://example.com/webhook',
subscriptions: ['conversation_created', 'conversation_status_changed']
})
};
fetch('https://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/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://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/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://example.com/webhook',
'subscriptions' => [
'conversation_created',
'conversation_status_changed'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <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://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://example.com/webhook\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_token", "<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://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/webhooks")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com/webhook\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.clickdesk.openclick.ai/api/v1/accounts/{account_id}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://example.com/webhook\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"url": "<string>",
"subscriptions": [
"conversation_created"
],
"account_id": 123
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
