Webhook outgoing payload

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.

delivery_metadata

object

required

Show child attributes

destination

string

required

Destination connector type (e.g. bigquery).

event

string

required

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

message

string

required

Human-readable summary of the event.

pipelines

object[]

required

Show child attributes

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

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).

Create a connectorCreates a new source or destination connector for your Artie deployment. Configure database connections, authentication, and replication settings programmatically.

⌘I

{
  "delivery_metadata": {
    "attempt": 123
  },
  "destination": "<string>",
  "event": "<string>",
  "message": "<string>",
  "pipelines": [
    {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "properties": {},
  "severity": "info",
  "source": "<string>",
  "source_reader_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timestamp": "2023-11-07T05:31:56Z"
}

API Reference