Summary: New event context for instrument data changes, and new cash_deposited trigger and invest_with_allocations action for workflows

Events

New Event Context

Added the InstrumentUpdateEventContext schema to the list of possible event context values. It is delivered on update.created and update.succeeded events to notify partners that an instrument's data has changed, so they can re-fetch it from the Instrument API.

Fields:

• instrument - the ISIN of the instrument whose data changed.

Note: These events are tied to the gradual rollout of instrument trading data and are only emitted once that data is enabled for your account.

Workflows

New Trigger and Action: Invest deposited cash across allocations

The workflows API now supports investing deposited cash across a set of instruments by configured percentages. POST /accounts/{account_id}/workflows accepts a new cash_deposited trigger paired with a new invest_with_allocations action. Triggers and actions must be paired: schedule requires order.create_and_confirm, and cash_deposited requires invest_with_allocations; any other combination is rejected with a 400. This affects the following endpoints:

• POST /accounts/{account_id}/workflows - Create a workflow
• GET /accounts/{account_id}/workflows - List workflows
• GET /accounts/{account_id}/workflows/{workflow_id} - Get a workflow

cash_deposited trigger

Starts the workflow when cash is deposited into the customer account. It carries no further parameters — the arrival of the deposit is the trigger. Sending cadence, start_after, day_of_month or day_of_week with this trigger is rejected with a 400. TriggerType now accepts schedule and cash_deposited.

invest_with_allocations action

Invests each deposit across the instruments named in allocations. The action carries:

• securities_account - the securities account the allocation applies to. Optional when the customer has a single securities account, required otherwise. It must belong to a retirement product with an active product contract; otherwise the request is rejected with a 422.
• allocations - a list of { isin, allocation_pct } entries. Each allocation_pct is the share of each deposit allocated to that instrument, in whole percentage points (1–100); ISINs must be unique and the allocation_pct values must sum to exactly 100. Every ISIN must be an active instrument of the securities account's product contract; otherwise the request is rejected with a 422 listing the ISINs that are not available.

GET /workflows and GET /workflows/{workflow_id} return the invest workflow with its current allocations.

As with savings plans, a created invest workflow must be confirmed with SCA, and with appropriateness consent if any allocated instrument requires it.

Note: This is the first iteration of the invest_with_allocations action. Invest workflows can be created, confirmed, cancelled and retrieved, but deposits do not yet trigger investments automatically; this will be enabled in a later release. The action does not yet provide the PRIIPs KIDs or ex-ante cost information of the allocated instruments, so the response has no regulatory_disclosures; a future iteration will add links to the relevant KID documents.

Schema changes

The request and response format of existing schedule workflows is unchanged. If you generate clients from the OpenAPI specification, note that TriggerRequest and TriggerResponse are now unions discriminated on type, and that action.order is only present for order.create_and_confirm actions. The legacy batch_order.create_and_confirm action type has been removed from ActionType; it is no longer accepted or returned, and all examples now show the nested order object.