Workflows

Workflows are automated message sequences. They let you define a repeatable set of steps (send + delays) and then trigger that sequence for a specific audience member when something happens in your product.

What a workflow is

A workflow is a versioned definition with:

• A key (stable identifier used to trigger it from your backend)
• One or more steps (for example: send a message, wait 2 days, send another message)
• Optional context and variables used by templates inside the workflow

Think of workflows as “automations you can trigger from code”, without needing to reinvent scheduling, retries, and state tracking.

How it fits into the system

• Audience members are the target of a run (a workflow always runs “for a member”).
• Templates keep each send step consistent and editable in the Dashboard.
• Categories + Preferences apply normally — workflows should still respect opt-outs.
• Runs are observable: you can fetch run metadata and status after triggering.

Getting started

1. Create a workflow in the Dashboard and choose a stable key (for example, welcome-sequence).
2. Add steps (a common pattern is: immediate send → delay → follow-up send).
3. Trigger it from your backend using the Server SDK or via HTTP:
   • POST /sdk/v1/workflows/:key/run
4. Retrieve run status when you need to confirm a run exists or debug:
   • GET /sdk/v1/workflows/runs/:runId