Create webhook subscription

POST/unified/webhook

The data payload received by your server is described at https://docs.unified.to/unified/overview. The `interval` field can be set as low as 1 minute for paid accounts, and 60 minutes for free accounts.

Parameters

include_allboolean

When set, all of the existing data will sent back to your server.

Payload

A webhook is used to POST new/updated information to your server.

idstring read-only

created_atdate read-only

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate read-only

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

workspace_idstring read-only

(reference to KmsSpace)

connection_idstring required

hook_urlstring

The URL of the webhook

object_type enum required

Valid values:

"accounting_account"

"accounting_transaction"

"accounting_journal"

"accounting_contact"

"accounting_invoice"

The object to return (eg. CRM "contact")

intervalnumber

The interval (in minutes) to check for updated/new objets.

checked_atdate read-only

The last date/time that a check was done on this object (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

integration_typestring read-only

environmentstring read-only

event enum required

Valid values:

"updated"

"created"

"deleted"

runsstring array read-only

An array of the most revent virtual webhook runs

fieldsstring

webhook_type enum

Valid values:

"virtual"

"native"

metaany read-only

is_healthyboolean read-only

page_max_limitnumber

filtersstring dictionary

db_type enum

Valid values:

"mongodb"

"mysql"

"postgres"

"mssql"

"mariadb"

db_urlstring

db_schemastring

db_name_prefixstring

is_pausedboolean

is_betaboolean

Returns

Webhook

A webhook is used to POST new/updated information to your server.

idstring read-only

created_atdate read-only

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate read-only

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

workspace_idstring read-only

(reference to KmsSpace)

connection_idstring required

hook_urlstring

The URL of the webhook

object_type enum required

Valid values:

"accounting_account"

"accounting_transaction"

"accounting_journal"

"accounting_contact"

"accounting_invoice"

The object to return (eg. CRM "contact")

intervalnumber

The interval (in minutes) to check for updated/new objets.

checked_atdate read-only

The last date/time that a check was done on this object (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

integration_typestring read-only

environmentstring read-only

event enum required

Valid values:

"updated"

"created"

"deleted"

runsstring array read-only

An array of the most revent virtual webhook runs

fieldsstring

webhook_type enum

Valid values:

"virtual"

"native"

metaany read-only

is_healthyboolean read-only

page_max_limitnumber

filtersstring dictionary

db_type enum

Valid values:

"mongodb"

"mysql"

"postgres"

"mssql"

"mariadb"

db_urlstring

db_schemastring

db_name_prefixstring

is_pausedboolean

is_betaboolean

const options = {
  method: 'POST',
  url: 'https://api.unified.to/unified/webhook',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    include_all: false,
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const results = await sdk.unified.createUnifiedWebhook({ 
    include_all: false,
 });

Node.js (axios)

const options = {
  method: 'POST',
  url: 'https://api.unified.to/unified/webhook',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    include_all: false,
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("POST", "https://api.unified.to/unified/webhook?include_all=false")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/unified/webhook?include_all=false

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/unified/webhook?include_all=false"

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.post(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/unified/webhook?include_all=false",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/unified/webhook?include_all=false")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request POST \
  --url 'https://api.unified.to/unified/webhook?include_all=false' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?