Create
curl --request POST \
--url https://api.integrations.commenda.io/v4/core/webhook-config \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"webhook_type": "DATA_MODEL_CHANGES",
"name": "My webhook",
"url": "https://example.com/webhooks",
"integration_type": "QUICKBOOKS",
"topics": [
"orders/create"
],
"state": "ENABLED",
"signing_key": "your-signing-key",
"headers": [
{
"name": "X-Custom-Header",
"value": "custom-value"
}
]
}
'import requests
url = "https://api.integrations.commenda.io/v4/core/webhook-config"
payload = {
"webhook_type": "DATA_MODEL_CHANGES",
"name": "My webhook",
"url": "https://example.com/webhooks",
"integration_type": "QUICKBOOKS",
"topics": ["orders/create"],
"state": "ENABLED",
"signing_key": "your-signing-key",
"headers": [
{
"name": "X-Custom-Header",
"value": "custom-value"
}
]
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
webhook_type: 'DATA_MODEL_CHANGES',
name: 'My webhook',
url: 'https://example.com/webhooks',
integration_type: 'QUICKBOOKS',
topics: ['orders/create'],
state: 'ENABLED',
signing_key: 'your-signing-key',
headers: [{name: 'X-Custom-Header', value: 'custom-value'}]
})
};
fetch('https://api.integrations.commenda.io/v4/core/webhook-config', 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.integrations.commenda.io/v4/core/webhook-config",
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([
'webhook_type' => 'DATA_MODEL_CHANGES',
'name' => 'My webhook',
'url' => 'https://example.com/webhooks',
'integration_type' => 'QUICKBOOKS',
'topics' => [
'orders/create'
],
'state' => 'ENABLED',
'signing_key' => 'your-signing-key',
'headers' => [
[
'name' => 'X-Custom-Header',
'value' => 'custom-value'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.integrations.commenda.io/v4/core/webhook-config"
payload := strings.NewReader("{\n \"webhook_type\": \"DATA_MODEL_CHANGES\",\n \"name\": \"My webhook\",\n \"url\": \"https://example.com/webhooks\",\n \"integration_type\": \"QUICKBOOKS\",\n \"topics\": [\n \"orders/create\"\n ],\n \"state\": \"ENABLED\",\n \"signing_key\": \"your-signing-key\",\n \"headers\": [\n {\n \"name\": \"X-Custom-Header\",\n \"value\": \"custom-value\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<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.integrations.commenda.io/v4/core/webhook-config")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"webhook_type\": \"DATA_MODEL_CHANGES\",\n \"name\": \"My webhook\",\n \"url\": \"https://example.com/webhooks\",\n \"integration_type\": \"QUICKBOOKS\",\n \"topics\": [\n \"orders/create\"\n ],\n \"state\": \"ENABLED\",\n \"signing_key\": \"your-signing-key\",\n \"headers\": [\n {\n \"name\": \"X-Custom-Header\",\n \"value\": \"custom-value\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.integrations.commenda.io/v4/core/webhook-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhook_type\": \"DATA_MODEL_CHANGES\",\n \"name\": \"My webhook\",\n \"url\": \"https://example.com/webhooks\",\n \"integration_type\": \"QUICKBOOKS\",\n \"topics\": [\n \"orders/create\"\n ],\n \"state\": \"ENABLED\",\n \"signing_key\": \"your-signing-key\",\n \"headers\": [\n {\n \"name\": \"X-Custom-Header\",\n \"value\": \"custom-value\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"rootfi_id": 123,
"rootfi_created_at": "<string>",
"rootfi_updated_at": "<string>",
"rootfi_organisation_id": 123,
"name": "<string>",
"url": "<string>",
"topics": [
"<string>"
],
"headers": [
{
"name": "X-Custom-Header",
"value": "custom-value"
}
],
"signature_header": {}
}
}WebhookConfig
Create
POST
/
v4
/
core
/
webhook-config
Create
curl --request POST \
--url https://api.integrations.commenda.io/v4/core/webhook-config \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"webhook_type": "DATA_MODEL_CHANGES",
"name": "My webhook",
"url": "https://example.com/webhooks",
"integration_type": "QUICKBOOKS",
"topics": [
"orders/create"
],
"state": "ENABLED",
"signing_key": "your-signing-key",
"headers": [
{
"name": "X-Custom-Header",
"value": "custom-value"
}
]
}
'import requests
url = "https://api.integrations.commenda.io/v4/core/webhook-config"
payload = {
"webhook_type": "DATA_MODEL_CHANGES",
"name": "My webhook",
"url": "https://example.com/webhooks",
"integration_type": "QUICKBOOKS",
"topics": ["orders/create"],
"state": "ENABLED",
"signing_key": "your-signing-key",
"headers": [
{
"name": "X-Custom-Header",
"value": "custom-value"
}
]
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
webhook_type: 'DATA_MODEL_CHANGES',
name: 'My webhook',
url: 'https://example.com/webhooks',
integration_type: 'QUICKBOOKS',
topics: ['orders/create'],
state: 'ENABLED',
signing_key: 'your-signing-key',
headers: [{name: 'X-Custom-Header', value: 'custom-value'}]
})
};
fetch('https://api.integrations.commenda.io/v4/core/webhook-config', 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.integrations.commenda.io/v4/core/webhook-config",
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([
'webhook_type' => 'DATA_MODEL_CHANGES',
'name' => 'My webhook',
'url' => 'https://example.com/webhooks',
'integration_type' => 'QUICKBOOKS',
'topics' => [
'orders/create'
],
'state' => 'ENABLED',
'signing_key' => 'your-signing-key',
'headers' => [
[
'name' => 'X-Custom-Header',
'value' => 'custom-value'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.integrations.commenda.io/v4/core/webhook-config"
payload := strings.NewReader("{\n \"webhook_type\": \"DATA_MODEL_CHANGES\",\n \"name\": \"My webhook\",\n \"url\": \"https://example.com/webhooks\",\n \"integration_type\": \"QUICKBOOKS\",\n \"topics\": [\n \"orders/create\"\n ],\n \"state\": \"ENABLED\",\n \"signing_key\": \"your-signing-key\",\n \"headers\": [\n {\n \"name\": \"X-Custom-Header\",\n \"value\": \"custom-value\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<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.integrations.commenda.io/v4/core/webhook-config")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"webhook_type\": \"DATA_MODEL_CHANGES\",\n \"name\": \"My webhook\",\n \"url\": \"https://example.com/webhooks\",\n \"integration_type\": \"QUICKBOOKS\",\n \"topics\": [\n \"orders/create\"\n ],\n \"state\": \"ENABLED\",\n \"signing_key\": \"your-signing-key\",\n \"headers\": [\n {\n \"name\": \"X-Custom-Header\",\n \"value\": \"custom-value\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.integrations.commenda.io/v4/core/webhook-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhook_type\": \"DATA_MODEL_CHANGES\",\n \"name\": \"My webhook\",\n \"url\": \"https://example.com/webhooks\",\n \"integration_type\": \"QUICKBOOKS\",\n \"topics\": [\n \"orders/create\"\n ],\n \"state\": \"ENABLED\",\n \"signing_key\": \"your-signing-key\",\n \"headers\": [\n {\n \"name\": \"X-Custom-Header\",\n \"value\": \"custom-value\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"rootfi_id": 123,
"rootfi_created_at": "<string>",
"rootfi_updated_at": "<string>",
"rootfi_organisation_id": 123,
"name": "<string>",
"url": "<string>",
"topics": [
"<string>"
],
"headers": [
{
"name": "X-Custom-Header",
"value": "custom-value"
}
],
"signature_header": {}
}
}Authorizations
Your Commenda Integrations API key, sent in the api_key header.
Body
application/json
Available options:
INTEGRATION, DATA_MODEL_CHANGES, CONNECTION_CHANGED, SYNC_COMPLETED, SYNC_STARTED, DISCONNECT_REQUESTED Example:
"DATA_MODEL_CHANGES"
Example:
"My webhook"
Example:
"https://example.com/webhooks"
Available options:
BUSY, CLEARBOOKS, FREEAGENT, FRESHBOOKS, KASHFLOW, MEKARI_JURNAL, MS_DYNAMICS_365, MS_DYNAMICS_365_FO, MYOB_BUSINESS, NETSUITE, ODOO_ACCOUNTING, QOYOD, QUICKBOOKS, QUICKBOOKS_SANDBOX, ROOTFI_SANDBOX, SAGE_CLOUD_ACCOUNTING, SAGE_ZA_CLOUD_ACCOUNTING, SAGE_INTACCT, TALLY, WAFEQ, WAVE, XERO, ZOHO_BOOKS, PUZZLE_SANDBOX, PUZZLE, RILLET, RILLET_SANDBOX, AMAZON, BIG_COMMERCE, SHOPIFY, SQUARESPACE, WIX, WOO_COMMERCE, GOOGLE_PLAYSTORE, CHARGEBEE, MOLLIE, PAYPAL, PAYPAL_SANDBOX, RAZORPAY, SQUARE, SQUARE_SANDBOX, STRIPE, STRIPE_TEST, STRIPE_SANDBOX, ZOHO_INVOICE, PADDLE, PADDLE_SANDBOX, HUBSPOT, PIPEDRIVE, SALES_FORCE, ZOHO_CRM, GUSTO Example:
"QUICKBOOKS"
Example:
["orders/create"]Available options:
ENABLED, DISABLED Example:
"ENABLED"
Example:
"your-signing-key"
Show child attributes
Show child attributes
Response
201 - application/json
Show child attributes
Show child attributes
⌘I