Add new webhook instance
curl --request POST \
--url https://api.chift.eu/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"event": "<string>",
"url": "<string>",
"signingsecret": "<string>",
"integrationid": 123
}
'import requests
url = "https://api.chift.eu/webhooks"
payload = {
"event": "<string>",
"url": "<string>",
"signingsecret": "<string>",
"integrationid": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event: '<string>',
url: '<string>',
signingsecret: '<string>',
integrationid: 123
})
};
fetch('https://api.chift.eu/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.chift.eu/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([
'event' => '<string>',
'url' => '<string>',
'signingsecret' => '<string>',
'integrationid' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.chift.eu/webhooks"
payload := strings.NewReader("{\n \"event\": \"<string>\",\n \"url\": \"<string>\",\n \"signingsecret\": \"<string>\",\n \"integrationid\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.chift.eu/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"event\": \"<string>\",\n \"url\": \"<string>\",\n \"signingsecret\": \"<string>\",\n \"integrationid\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chift.eu/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event\": \"<string>\",\n \"url\": \"<string>\",\n \"signingsecret\": \"<string>\",\n \"integrationid\": 123\n}"
response = http.request(request)
puts response.read_body{
"webhookid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdon": "2023-11-07T05:31:56Z",
"event": "<string>",
"url": "<string>",
"status": "active",
"createdby": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integrationid": 123
}{
"message": "There is already an existing webhook with the same url and type",
"status": "error"
}{
"message": "Validation error",
"status": "error",
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Webhooks
Add new webhook instance
Creates a new webhook subscription for the specified event and URL, then returns the created webhook instance.
POST
/
webhooks
Add new webhook instance
curl --request POST \
--url https://api.chift.eu/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"event": "<string>",
"url": "<string>",
"signingsecret": "<string>",
"integrationid": 123
}
'import requests
url = "https://api.chift.eu/webhooks"
payload = {
"event": "<string>",
"url": "<string>",
"signingsecret": "<string>",
"integrationid": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event: '<string>',
url: '<string>',
signingsecret: '<string>',
integrationid: 123
})
};
fetch('https://api.chift.eu/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.chift.eu/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([
'event' => '<string>',
'url' => '<string>',
'signingsecret' => '<string>',
'integrationid' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.chift.eu/webhooks"
payload := strings.NewReader("{\n \"event\": \"<string>\",\n \"url\": \"<string>\",\n \"signingsecret\": \"<string>\",\n \"integrationid\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.chift.eu/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"event\": \"<string>\",\n \"url\": \"<string>\",\n \"signingsecret\": \"<string>\",\n \"integrationid\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chift.eu/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event\": \"<string>\",\n \"url\": \"<string>\",\n \"signingsecret\": \"<string>\",\n \"integrationid\": 123\n}"
response = http.request(request)
puts response.read_body{
"webhookid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdon": "2023-11-07T05:31:56Z",
"event": "<string>",
"url": "<string>",
"status": "active",
"createdby": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integrationid": 123
}{
"message": "There is already an existing webhook with the same url and type",
"status": "error"
}{
"message": "Validation error",
"status": "error",
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Learn more:
- How do webhooks work in Chift? ↗
Authorizations
This access token needs to be included in each of your request to the Chift API.
Body
application/json
Maximum string length:
80Maximum string length:
500Maximum string length:
100Can be used to specify the integration code of a specific connector. This is mandatory in case you create a webhook related to a specific One API.