Delivery

Create a delivery binding

Runs the compatibility-triangle validator: the signal_filter must be well-formed, the deliverable_type must resolve to a registered resolver, the serializer_format must resolve to a registered serializer, and the serializer must support the resolver's shape.

post/v1/delivery/bindings

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/delivery/bindings
  • Auth: HTTP bearer

Request body

namestring required
deliverable_typestring required
destination_idstring uuid required
serializer_formatstring required
serializer_configobject
resolver_configobject

Per-binding resolver options — e.g. {"null_handling": "distinguish"} on a pipeline.capture binding. Sparse modes (omit_absent, distinguish) require a json/ndjson serializer (400 otherwise).

excluded_fieldsstring[]

Field keys omitted from every delivered payload (binding-level egress filter, honored by pipeline.capture). Empty array delivers everything.

is_activeboolean

Example request

{
  "signal_filter": {
    "event_type": "document.extracted"
  },
  "destination_id": "e1f2a3b4-c5d6-7890-efab-901234567890"
}

Response

Binding created (alias of 201).

idstring uuid required
customer_idstring uuid required
namestring required
deliverable_typestring required

Must resolve to a registered deliverable resolver.

destination_idstring uuid nullable required

Null when the destination was deleted: the binding is orphaned (inactive, last_status destination_deleted) until re-pointed.

serializer_formatstring required

Must resolve to a registered serializer (json, ndjson, csv, csv_file, xlsx, rows, graph, raw, md, txt).

serializer_configobject
resolver_configobject nullable

Per-binding resolver options threaded into the deliverable resolver. First consumer: null_handling on the pipeline.capture deliverable — always_null (default: every declared schema field present, missing values as null), omit_absent (valued fields only), or distinguish (null = deliberately cleared by resolution; never-captured keys omitted). The sparse modes require a json or ndjson serializer (compatibility validated on create/update).

excluded_fieldsstring[] nullable

Field keys OMITTED from every payload this binding delivers — the binding-level egress filter (honored by pipeline.capture in all null_handling modes). Excluded fields stay available to downstream pipeline stages (data product, business rules); null/empty delivers everything.

is_activeboolean required
last_statusstring nullable
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "customer_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "signal_filter": {
    "event_type": "document.extracted"
  },
  "destination_id": "e1f2a3b4-c5d6-7890-efab-901234567890",
  "created_at": "2026-04-25T14:30:00.000Z",
  "updated_at": "2026-04-25T14:30:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.