Skip to main content

Delivery Config

Get and replace a Spec's delivery configuration: the outbound settings the pipeline uses when routing produced data to destinations after a run finishes.

The delivery config is the Spec outbound configuration. It captures how a finished run routes its produced data to destinations. The GET endpoint reads the current config, and the POST endpoint replaces it wholesale. An unset config reads back as an empty object.

The config body is a free-form JSON object, so the exact keys depend on how your delivery is wired (bindings, formats, and destinations). The Spec stores whatever you send under delivery_config. POST replaces the stored object rather than merging, so send the full config each time.

GET/v1/schemas/{id}/delivery
POST/v1/schemas/{id}/delivery

Body parameters

<key>anyFree-form delivery configuration. The object is stored verbatim under delivery_config and replaces any existing config.

Response

GET returns the stored delivery_config object, or {} when none is set. POST returns the updated Spec record reflecting the new config.

Response (GET delivery)

{
  "format": "csv",
  "destination_id": "dst_9f8e7d6c",
  "field_map": {
    "invoice_number": "Invoice #",
    "total": "Amount"
  }
}
POST replaces the entire delivery_config object. To change one key, read the current config with GET, modify it, and send the whole object back.

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo Spec (schema) with this ID exists for your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Assembly Configs
Samples