Skip to main content
This schema describes the JSON body of each POST request Artie makes to your webhook URL when Format is set to Event Payload. For how requests are sent (headers, retries, and authentication), see Webhooks.

Webhook delivery body (Event Payload format). The concrete shape is selected by the event field; see the matching variant for the exact properties keys.

​
delivery_metadata
object
required
​
destination
string
required

Destination connector type (e.g. bigquery).

​
event
enum<string>
required

Event type identifier (e.g. replication.failed).

Available options:
backfill.completed
​
message
string
required

Human-readable summary of the event.

​
pipelines
object[]
required
​
properties
object
required

Event-specific fields included in the properties object of a webhook delivery. The set of keys depends on the event type. Every field is optional; omitted keys should be treated as absent. Artie may add new fields at any time—clients must tolerate unknown keys and should not assume a fixed schema beyond this contract.

​
severity
enum<string>
required

Severity of the event.

Available options:
info,
warning,
error
​
source
string
required

Source connector type (e.g. postgresql).

​
source_reader_uuid
string<uuid>
required
​
timestamp
string<date-time>
required

Time the event occurred (RFC 3339).

​
environment_name
string

Human-readable name of the environment. Omitted when the event has no environment.

​
environment_uuid
null | string<uuid>

UUID of the environment the event belongs to. Omitted when the event has no environment.