Skip to main content

List Bindings

List all delivery bindings that route signals to destinations. Each binding maps an event type to a deliverable resolver, serializer format, and destination.

A binding connects the four parts of the delivery pipeline: a signal filter (which events to listen for), a deliverable type (what payload to build), a serializer format (how to encode it), and a destination (where to send it). The compatibility triangle is enforced on creation.

GET/v1/delivery/bindings

Response

Response fields

dataarrayArray of binding objects.
data[].idstringBinding UUID.
data[].namestringBinding name.
data[].signal_filterobjectEvent filter with `event_type` and optional match criteria.
data[].deliverable_typestringPayload resolver type.
data[].destination_idstringTarget destination UUID.
data[].serializer_formatstringSerializer format (e.g. `json`, `csv`, `xlsx`).
data[].serializer_configobjectSerializer-specific configuration options.
data[].field_mapobjectJSONPath field projection map.
data[].delivery_policyobjectRetry policy with `max_attempts` and `backoff_schedule`.
data[].is_activebooleanWhether the binding is enabled.
data[].last_statusstring | nullStatus of the most recent delivery attempt through this binding.
data[].created_atstringISO 8601 creation timestamp.
data[].updated_atstringISO 8601 last update timestamp.

Response

{
  "data": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-234567890123",
      "name": "Notify on extraction complete",
      "signal_filter": { "event_type": "document.extraction.completed" },
      "deliverable_type": "document_capture",
      "destination_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "serializer_format": "json",
      "serializer_config": {},
      "field_map": { "vendor": "$.vendor_name", "total": "$.amount" },
      "delivery_policy": { "max_attempts": 5, "backoff_schedule": [1000, 5000, 30000, 120000, 600000] },
      "is_active": true,
      "last_status": "succeeded",
      "created_at": "2024-09-10T09:00:00.000Z",
      "updated_at": "2024-09-10T09:00:00.000Z"
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Create Binding
Catalog