Skip to content

Step types

notify has eleven step types. The list is the registry in internal/steptype; it is also what POST /v1/workflows accepts in type.

TypeKindWhat it does
in_appChannelPuts a message in the subscriber’s inbox.
emailChannelSends an email through an email integration.
pushChannelSends a push notification (ntfy, Expo, FCM, Web Push, or a push webhook).
chatChannelPosts to Discord, Telegram, Slack, WhatsApp, Mastodon, Bluesky, or a chat webhook.
smsChannelSends an SMS through Twilio, SignalWire or Amazon SNS.
delayFlowWaits: a fixed time, until a scheduled time of day, or until a time in the payload.
digestFlowCollects events for a window and sends one run with the batch.
throttleFlowFails the run when a subscriber exceeds a rate.
http_requestActionCalls an HTTP endpoint and exposes the response to later steps.
streamChannelPublishes an event to the environment’s durable feed.
agent_messageActionPosts a message to an agent’s conversation and starts its turn.

All steps run in the order listed in the workflow. Channel steps accept filters, a condition.

Gates

Channel steps (in_app, email, push, chat, sms, stream) apply their gates in this order:

  1. The step’s condition. False, or not evaluable, records a message with status skipped and skipReason condition or condition_invalid.
  2. The step’s inline throttle ({"limit": n, "windowSec": s} in controlValues), if set. Over the limit records a message with status throttled. The budget is per environment, subscriber and workflow.
  3. The subscriber’s preferences. A disabled channel records skipped with skipReason preference, unless the workflow is critical. If the preference lookup itself fails, the send proceeds.
  4. The recipient’s address. A step whose recipient has none for the channel records skipped with skipReason no_email (email), no_device (push: no topic, device token or web push subscription) or no_channel (chat, on a provider that addresses each recipient: telegram, slack, whatsapp). No provider is called, and the run carries on. An in_app step needs no address, and sms has its own no_verified_phone.
  5. The send. A transient provider error (a timeout or a 5xx) makes the engine retry the task. A permanent error records a message with status error and the error text. A scope with no integration for the channel records error with errorClass not_configured; it is a setup fault, so it never counts against an integration’s health.

Fields in controlValues that hold text are Handlebars templates.