Create a delivery
Creates a delivery rule: a schedule plus a payload plus a destination. Deliveries are workflow-engine rows in their own table and are picked up by the same execution coordinator as workflows, so a delivery behaves exactly like a workflow at runtime.
A delivery is an ordinary workflow: operations is a plain list of operation nodes, exactly as a workflow stores them, and nothing is expanded at run time. Two shapes cover everything:
- Standard — trigger -> index_panel -> send_<channel>, where the channel is send_email, send_webhook, send_sftp or send_s3. The trigger is index_event_trigger (fires when a target index publishes value_eod, universe, weighting or holdings), trigger (cron) or manual_trigger. The console's one-click form writes and reads back exactly these nodes, so the workflow builder shows what actually runs.
- Partner — trigger -> send_<partner> (send_alphabot, send_alphathena, send_stratifi, send_refinitiv). A partner operation is the whole flow — it reads the data, formats it the one way that partner accepts and sends it over the one transport that partner speaks — so there is no index_panel node; you supply only the per-index account binding, such as ric_map for LSEG.
operations is required. Every operation and its parameters are listed in the live catalog at GET /schema.
The new delivery is linked into the team's deliveries map and the coordinator is notified immediately, so a live delivery with an index_event trigger can fire the same day. Note the success status is 200, not 201.
Request
- Base URL: https://api.indexone.io
- URL: https://api.indexone.io/deliveries
- Auth: API key in header x-api-key and API key in header Authorization
Request body
Example request
{
"operations": [
{
"id": "delivery_trigger"
}
]
}Response
The created delivery, plus the coordinator notification result.
Changes
No recorded changes to this operation across all 1 revision of this API.