List webhooks
curl --request POST \
--url https://api.livechatinc.com/v3.5/configuration/action/list_webhooks \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"owner_client_id": "0805e283233042b37f460ed8fbf22160"
}
'import requests
url = "https://api.livechatinc.com/v3.5/configuration/action/list_webhooks"
payload = { "owner_client_id": "0805e283233042b37f460ed8fbf22160" }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({owner_client_id: '0805e283233042b37f460ed8fbf22160'})
};
fetch('https://api.livechatinc.com/v3.5/configuration/action/list_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.livechatinc.com/v3.5/configuration/action/list_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([
'owner_client_id' => '0805e283233042b37f460ed8fbf22160'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.livechatinc.com/v3.5/configuration/action/list_webhooks"
payload := strings.NewReader("{\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.livechatinc.com/v3.5/configuration/action/list_webhooks")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.5/configuration/action/list_webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "pqi8oasdjahuakndw9nsad9na",
"url": "http://myservice.com/webhooks",
"description": "Test webhook",
"action": "chat_deactivated",
"filters": {
"chat_presence": {
"user_ids": {
"values": [
"johndoe@mail.com"
]
},
"my_bots": true
}
},
"owner_client_id": "asXdesldiAJSq9padj",
"type": "license"
}
]Webhooks
List webhooks
Lists all webhooks registered for the given Client ID.
POST
/
action
/
list_webhooks
List webhooks
curl --request POST \
--url https://api.livechatinc.com/v3.5/configuration/action/list_webhooks \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"owner_client_id": "0805e283233042b37f460ed8fbf22160"
}
'import requests
url = "https://api.livechatinc.com/v3.5/configuration/action/list_webhooks"
payload = { "owner_client_id": "0805e283233042b37f460ed8fbf22160" }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({owner_client_id: '0805e283233042b37f460ed8fbf22160'})
};
fetch('https://api.livechatinc.com/v3.5/configuration/action/list_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.livechatinc.com/v3.5/configuration/action/list_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([
'owner_client_id' => '0805e283233042b37f460ed8fbf22160'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.livechatinc.com/v3.5/configuration/action/list_webhooks"
payload := strings.NewReader("{\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.livechatinc.com/v3.5/configuration/action/list_webhooks")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.5/configuration/action/list_webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"owner_client_id\": \"0805e283233042b37f460ed8fbf22160\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "pqi8oasdjahuakndw9nsad9na",
"url": "http://myservice.com/webhooks",
"description": "Test webhook",
"action": "chat_deactivated",
"filters": {
"chat_presence": {
"user_ids": {
"values": [
"johndoe@mail.com"
]
},
"my_bots": true
}
},
"owner_client_id": "asXdesldiAJSq9padj",
"type": "license"
}
]Required scopes:
webhooks.configuration:rwAuthorizations
PersonalAccessTokenOAuth2BearerToken
Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.
Body
application/json
The webhook owner (the Client ID for which the webhook is registered).
Response
200 - application/json
A list of registered webhooks.
Unique ID of the webhook.
The destination URL for the webhook.
The webhook description.
The action that triggers sending the webhook.
The secret key sent in webhooks to verify the source.
Additional data arriving with the webhook.
The filters to check if a webhook should be triggered.
Show child attributes
Show child attributes
The Client ID that owns the webhook.
The webhook type.
Available options:
bot, license Was this page helpful?