List Webhooks
curl --request GET \
--url http://localhost:3000/v2/integrations/webhooks/ \
--header 'x-API-Key: <api-key>'import requests
url = "http://localhost:3000/v2/integrations/webhooks/"
headers = {"x-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-API-Key': '<api-key>'}};
fetch('http://localhost:3000/v2/integrations/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/integrations/webhooks/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-API-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"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/integrations/webhooks/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v2/integrations/webhooks/")
.header("x-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/integrations/webhooks/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"type": "CREATE",
"entity": "user",
"url": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
}
}
]Webhooks
List Webhooks
List all webhooks with optional filtering, pagination, and sorting.
GET
/
integrations
/
webhooks
/
List Webhooks
curl --request GET \
--url http://localhost:3000/v2/integrations/webhooks/ \
--header 'x-API-Key: <api-key>'import requests
url = "http://localhost:3000/v2/integrations/webhooks/"
headers = {"x-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-API-Key': '<api-key>'}};
fetch('http://localhost:3000/v2/integrations/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/integrations/webhooks/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-API-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"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/integrations/webhooks/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v2/integrations/webhooks/")
.header("x-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/integrations/webhooks/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"type": "CREATE",
"entity": "user",
"url": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
}
}
]Authorizations
API-KeyBearer-Auth
Query Parameters
Maximum number of items to return
Required range:
1 <= x <= 1000Number of items to skip for pagination
Required range:
x >= 0Sort field and direction (e.g. number:1, status.createdAt:-1)
Example:
"number:1"
Response
List of Webhooks
The type of the webhook, e.g., CREATE, UPDATE, DELETE
Available options:
CREATE, UPDATE, DELETE, ABSENCE_APPROVED, ABSENCE_CANCELED, OPEN The entity that the webhook is associated with, e.g., "Absence", "Task"
Available options:
user, customer, customerobject, materialorder, absence, complaint, article, salary, job, qualitycontrol, invoice, offer, credit, invoicestorno, servicereport, payment, contact, equipment, task The URL to which the webhook will send data
Unique identifier of the entity
Unique number of the entity, used for identification
The ID of the company this entity belongs to
Entity Status information
Show child attributes
Show child attributes
Was this page helpful?

