Create webhook config
curl --request POST \
--url https://api.beltic.com/v1/webhooks/configs \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"data": {
"type": "webhook_config",
"attributes": {
"url": "https://example.com/webhooks/documents",
"subscribed_statuses": [
"processed",
"failed"
],
"resource_type": "document"
}
}
}
'import requests
url = "https://api.beltic.com/v1/webhooks/configs"
payload = { "data": {
"type": "webhook_config",
"attributes": {
"url": "https://example.com/webhooks/documents",
"subscribed_statuses": ["processed", "failed"],
"resource_type": "document"
}
} }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
type: 'webhook_config',
attributes: {
url: 'https://example.com/webhooks/documents',
subscribed_statuses: ['processed', 'failed'],
resource_type: 'document'
}
}
})
};
fetch('https://api.beltic.com/v1/webhooks/configs', 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.beltic.com/v1/webhooks/configs",
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([
'data' => [
'type' => 'webhook_config',
'attributes' => [
'url' => 'https://example.com/webhooks/documents',
'subscribed_statuses' => [
'processed',
'failed'
],
'resource_type' => 'document'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.beltic.com/v1/webhooks/configs"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"webhook_config\",\n \"attributes\": {\n \"url\": \"https://example.com/webhooks/documents\",\n \"subscribed_statuses\": [\n \"processed\",\n \"failed\"\n ],\n \"resource_type\": \"document\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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.beltic.com/v1/webhooks/configs")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"webhook_config\",\n \"attributes\": {\n \"url\": \"https://example.com/webhooks/documents\",\n \"subscribed_statuses\": [\n \"processed\",\n \"failed\"\n ],\n \"resource_type\": \"document\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beltic.com/v1/webhooks/configs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"type\": \"webhook_config\",\n \"attributes\": {\n \"url\": \"https://example.com/webhooks/documents\",\n \"subscribed_statuses\": [\n \"processed\",\n \"failed\"\n ],\n \"resource_type\": \"document\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"type": "webhook_config",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attributes": {
"resource_type": "document",
"url": "https://example.com/webhooks/documents",
"subscribed_statuses": [
"processed",
"failed"
],
"secret_prefix": "abc12...",
"is_active": true,
"created_at": "2026-01-16T10:00:00.000Z",
"updated_at": "2026-01-16T10:00:00.000Z"
}
},
"meta": {
"secret": "abc123xyz789..."
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>"
}
]
}Webhooks
Create Webhook Config
Create a new webhook configuration to receive notifications when document status changes.
Important: The webhook secret is returned ONLY in this response. Store it securely - it cannot be retrieved again.
Webhook Delivery:
- Webhooks are delivered via HTTP POST to the specified URL
- Use the secret to validate the webhook payload signature using the HMAC-SHA256 algorithm
- Non-2xx responses trigger automatic retries with exponential backoff
- After 5 failed attempts, the delivery is marked as failed and sent to DLQ
Subscribed Statuses:
pending: Document created, awaiting file uploadsubmitted: Document submitted for processingprocessing: Document is being processedprocessed: Document processing completed successfullyfailed: Document processing failed
POST
/
v1
/
webhooks
/
configs
Create webhook config
curl --request POST \
--url https://api.beltic.com/v1/webhooks/configs \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"data": {
"type": "webhook_config",
"attributes": {
"url": "https://example.com/webhooks/documents",
"subscribed_statuses": [
"processed",
"failed"
],
"resource_type": "document"
}
}
}
'import requests
url = "https://api.beltic.com/v1/webhooks/configs"
payload = { "data": {
"type": "webhook_config",
"attributes": {
"url": "https://example.com/webhooks/documents",
"subscribed_statuses": ["processed", "failed"],
"resource_type": "document"
}
} }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
type: 'webhook_config',
attributes: {
url: 'https://example.com/webhooks/documents',
subscribed_statuses: ['processed', 'failed'],
resource_type: 'document'
}
}
})
};
fetch('https://api.beltic.com/v1/webhooks/configs', 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.beltic.com/v1/webhooks/configs",
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([
'data' => [
'type' => 'webhook_config',
'attributes' => [
'url' => 'https://example.com/webhooks/documents',
'subscribed_statuses' => [
'processed',
'failed'
],
'resource_type' => 'document'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.beltic.com/v1/webhooks/configs"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"webhook_config\",\n \"attributes\": {\n \"url\": \"https://example.com/webhooks/documents\",\n \"subscribed_statuses\": [\n \"processed\",\n \"failed\"\n ],\n \"resource_type\": \"document\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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.beltic.com/v1/webhooks/configs")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"webhook_config\",\n \"attributes\": {\n \"url\": \"https://example.com/webhooks/documents\",\n \"subscribed_statuses\": [\n \"processed\",\n \"failed\"\n ],\n \"resource_type\": \"document\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beltic.com/v1/webhooks/configs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"type\": \"webhook_config\",\n \"attributes\": {\n \"url\": \"https://example.com/webhooks/documents\",\n \"subscribed_statuses\": [\n \"processed\",\n \"failed\"\n ],\n \"resource_type\": \"document\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"type": "webhook_config",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attributes": {
"resource_type": "document",
"url": "https://example.com/webhooks/documents",
"subscribed_statuses": [
"processed",
"failed"
],
"secret_prefix": "abc12...",
"is_active": true,
"created_at": "2026-01-16T10:00:00.000Z",
"updated_at": "2026-01-16T10:00:00.000Z"
}
},
"meta": {
"secret": "abc123xyz789..."
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>"
}
]
}Authorizations
API key for authentication. Access https://console.beltic.com/ to obtain your API key.
Body
application/json
Show child attributes
Show child attributes
Was this page helpful?
⌘I