MainTargetsWebhook

Webhook Setup

Prerequisites

  • HTTP endpoint that accepts POST with application/json
  • Authentication credentials (if required)

Setup

Endpoint

  • URL: Base endpoint (e.g., https://api.example.com/events)
  • Path Template: Append path with {schema} and {table} placeholders

Example: https://api.example.com + webhooks/{schema}/{table} → https://api.example.com/webhooks/public/users

Authentication (optional)

MethodHeader
BearerAuthorization: Bearer <token>
BasicAuthorization: Basic <base64(user:pass)>
HeaderCustom name/value (e.g., X-API-Key: secret)

Message Format

Debezium or Supermetal — see Kafka Message Formats.

Headers

HeaderDefaultDescription
Idempotency-KeyonDeterministic deduplication key
X-Source-SchemaonSource schema name
X-Source-TableonSource table name

Configure header names or disable individually.

Idempotency Key

Derived from source table, row identity, and commit timestamp. Retrying the same batch produces the same key. Keys are time-sortable.

For predictable idempotency, keep batch configuration stable. Disable batching (Max Batch Size = 1) for per-row keys.

Static Headers

Add custom headers to every request.

Batching

OptionDefaultDescription
Max Batch Size0 (unlimited)Rows per request
Max Payload Bytes1 MBRequest body size

Flushes when either limit triggers. Set Max Batch Size = 1 to disable batching.

Compression

ValueContent-Encoding
None—
Gzipgzip
Zstdzstd
Brbr

Rate Limiting

OptionDefaultDescription
Max Requests/Second0 (unlimited)Request rate
Max Bytes/Second0 (unlimited)Bandwidth

Retry

Exponential backoff with jitter.

OptionDefaultDescription
Max Retries1024Attempts (0 = unlimited)
Max Retry Duration1 hourTotal time (0 = unlimited)
Initial Backoff1sFirst delay
Max Backoff3 minMaximum delay

Timeouts

OptionDefault
Request Timeout30s

Last updated on

On this page

PrerequisitesSetupEndpointAuthentication (optional)Message FormatHeadersIdempotency KeyStatic HeadersBatchingCompressionRate LimitingRetryTimeouts