Developer guide

The API is REST over HTTPS. All payloads are JSON and all timestamps are RFC 3339 in UTC. Keys are passed in a request header and can be limited to a single pipeline.

Anatomy of a pipeline

A pipeline is a source, a sink and a schema that ties them together. Everything else, batching, retries and ordering, is handled for you.

PartOptionsNotes
SourceQueue, webhook, database logOne source per pipeline
SinkWarehouse, object storage, HTTP endpointMultiple sinks may share a source
SchemaVersioned, for example orders@v3A breaking change is rejected at publish time

Delivery guarantees

ModeGuaranteeNotes
at-least-onceNo lossDefault. Consumers must be idempotent.
exactly-onceNo loss, no duplicatesRequires a sink that supports transactions.

Backfill

A backfill replays a date range into one consumer without disturbing the others. Progress is shown in the console and the job can be paused at any point.

Support

Engineering support answers within one business day. Include the pipeline name and a trace id.