Create a webhook endpoint
curl --request POST \
--url https://api.unif.dev/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://hooks.example.com/unif",
"events": [
"job.completed",
"job.failed",
"tracker.triggered"
],
"description": "Production ingestion"
}
'import requests
url = "https://api.unif.dev/v1/webhooks"
payload = {
"url": "https://hooks.example.com/unif",
"events": ["job.completed", "job.failed", "tracker.triggered"],
"description": "Production ingestion"
}
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({
url: 'https://hooks.example.com/unif',
events: ['job.completed', 'job.failed', 'tracker.triggered'],
description: 'Production ingestion'
})
};
fetch('https://api.unif.dev/v1/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.unif.dev/v1/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([
'url' => 'https://hooks.example.com/unif',
'events' => [
'job.completed',
'job.failed',
'tracker.triggered'
],
'description' => 'Production ingestion'
]),
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.unif.dev/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://hooks.example.com/unif\",\n \"events\": [\n \"job.completed\",\n \"job.failed\",\n \"tracker.triggered\"\n ],\n \"description\": \"Production ingestion\"\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.unif.dev/v1/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://hooks.example.com/unif\",\n \"events\": [\n \"job.completed\",\n \"job.failed\",\n \"tracker.triggered\"\n ],\n \"description\": \"Production ingestion\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unif.dev/v1/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 \"url\": \"https://hooks.example.com/unif\",\n \"events\": [\n \"job.completed\",\n \"job.failed\",\n \"tracker.triggered\"\n ],\n \"description\": \"Production ingestion\"\n}"
response = http.request(request)
puts response.read_body{
"id": "whk_01k3m9x7v2q8r4t6y0b1n5d7fa",
"object": "webhook",
"url": "<string>",
"events": [
"job.completed"
],
"enabled": true,
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"secret": "whsec_7f3c1a9e4b2d8065f1a3c7e9b5d2408f"
}{
"error": {
"type": "invalid_request_error",
"code": "parameter_invalid",
"message": "filters.revenue.gte must be a non-negative number.",
"param": "filters.revenue.gte",
"doc_url": "https://unif.dev/docs/platform/errors#parameter_invalid",
"request_id": "req_01k3m9x7v2q8r4t6y0b1n5d7fa"
}
}Webhooks
Create a webhook endpoint
The secret is returned once, at creation. Store it — you need it to verify the
Unif-Signature header on every delivery.
POST
https://api.unif.dev/v1
/
webhooks
Create a webhook endpoint
curl --request POST \
--url https://api.unif.dev/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://hooks.example.com/unif",
"events": [
"job.completed",
"job.failed",
"tracker.triggered"
],
"description": "Production ingestion"
}
'import requests
url = "https://api.unif.dev/v1/webhooks"
payload = {
"url": "https://hooks.example.com/unif",
"events": ["job.completed", "job.failed", "tracker.triggered"],
"description": "Production ingestion"
}
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({
url: 'https://hooks.example.com/unif',
events: ['job.completed', 'job.failed', 'tracker.triggered'],
description: 'Production ingestion'
})
};
fetch('https://api.unif.dev/v1/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.unif.dev/v1/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([
'url' => 'https://hooks.example.com/unif',
'events' => [
'job.completed',
'job.failed',
'tracker.triggered'
],
'description' => 'Production ingestion'
]),
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.unif.dev/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://hooks.example.com/unif\",\n \"events\": [\n \"job.completed\",\n \"job.failed\",\n \"tracker.triggered\"\n ],\n \"description\": \"Production ingestion\"\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.unif.dev/v1/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://hooks.example.com/unif\",\n \"events\": [\n \"job.completed\",\n \"job.failed\",\n \"tracker.triggered\"\n ],\n \"description\": \"Production ingestion\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unif.dev/v1/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 \"url\": \"https://hooks.example.com/unif\",\n \"events\": [\n \"job.completed\",\n \"job.failed\",\n \"tracker.triggered\"\n ],\n \"description\": \"Production ingestion\"\n}"
response = http.request(request)
puts response.read_body{
"id": "whk_01k3m9x7v2q8r4t6y0b1n5d7fa",
"object": "webhook",
"url": "<string>",
"events": [
"job.completed"
],
"enabled": true,
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"secret": "whsec_7f3c1a9e4b2d8065f1a3c7e9b5d2408f"
}{
"error": {
"type": "invalid_request_error",
"code": "parameter_invalid",
"message": "filters.revenue.gte must be a non-negative number.",
"param": "filters.revenue.gte",
"doc_url": "https://unif.dev/docs/platform/errors#parameter_invalid",
"request_id": "req_01k3m9x7v2q8r4t6y0b1n5d7fa"
}
}Authorizations
Send your workspace API key as a bearer token:
Authorization: Bearer unif_sk_live_...
Keys are scoped to a single workspace. See Authentication.
Body
application/json
Response
The created endpoint, including its signing secret.
Example:
"whk_01k3m9x7v2q8r4t6y0b1n5d7fa"
Allowed value:
"webhook"Available options:
job.completed, job.failed, tracker.triggered, entity.refreshed Returned only at creation. Used to verify the Unif-Signature header.
Example:
"whsec_7f3c1a9e4b2d8065f1a3c7e9b5d2408f"
Was this page helpful?