Sequence icon

Sequence

Interact with the Sequence Platform v1 API

Actions13

Rule → Trigger

AI-generated

Summary

Triggers a Sequence rule on demand, optionally simulating the execution without moving real money.

Inputs

  • ruleId (required) — The rule ID to trigger.
  • executeAmount — Optional amount in cents injected as TRANSFER_AMOUNT. Drives percentage/round_down/top_up actions; ignored by fixed-amount transfers. Leave 0 to use current balances.
  • simulation — Whether to simulate the rule run without moving real money. On by default for safety; turn off to let the rule move real money.
  • idempotencyKey — Deduplicates retries within 24h. Leave blank to auto-generate. Max 36 chars.

Output shape

A single record containing the rule execution result and any generated transfers.

The response is marked executionMode SIMULATION when simulation is on; executionMode LIVE when simulation is off.

Examples

Example 1: Test a rule logic safely before enabling real transfers.

ruleId: '123', simulation: true, executeAmount: 100

Example 2: Execute a rule on-demand to process a transfer.

ruleId: '456', simulation: false, executeAmount: 500

Links

Discussion