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"
    }
  }
}
'

{
  "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..."
  }
}

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 upload
submitted: Document submitted for processing
processing: Document is being processed
processed: Document processing completed successfully
failed: Document processing failed

POST

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"
    }
  }
}
'

{
  "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..."
  }
}

Authorizations

X-Api-Key

string

header

required

API key for authentication. Access https://console.beltic.com/ to obtain your API key.

Body

application/json

data

object

required

Show child attributes

Response

Webhook config created successfully

data

object

required

Show child attributes