agentsclimarketplace

Suprsend workflow schema

Skill suprsend/skills/skills/suprsend-workflow-schema

JSON schema for authoring or editing SuprSend workflow definitions. Loads the schemas and examples needed to write valid workflow JSON. Use ONLY when the user wants the agent to create, modify, or edit a workflow (e.g. "build a workflow that sends a welcome email", "add a 1h delay before the SMS step", "wire a branch on user plan"). Do NOT load for documentation, lookup, or conceptual questions ("how does batching work", "what is the batch node", "explain delivery nodes") — load suprsend-docs-support for those.From its SKILL.md

Install
npx -y skills add suprsend/skills --skill suprsend-workflow-schema

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

  • no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
  • 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

7.5 KB, as published. Nobody here has run it

SuprSend workflows define notification logic as a sequence of nodes. Each workflow requires a trigger (event or API) and at least one delivery node. Between trigger and delivery, you can add function, branch, and data nodes to build sophisticated notification journeys.

Workflows are defined as JSON conforming to the schema at https://schema.suprsend.com/workflow/v1/schema.json.

Recipient model

A workflow runs for exactly one recipient — the distinct_id from the API trigger, or from the event's distinct_id (or its override_recipients_* override). Every delivery node in the workflow sends to that recipient. Delivery nodes have no per-node recipient field.

If a workflow needs to send to someone other than the trigger recipient, use one of these patterns:

NeedUseNotes
Re-point the entire workflow to a different recipient based on event payload (e.g., approval flows where the actor should receive resolution updates instead of the approver)override_recipients_type + override_recipients_user_expr (or override_recipients_single_object_fields_expr) at the workflow rootEvent-triggered workflows only (trigger_type=event). Not available for trigger_type=api. See Workflow Schema Guide → Recipient overrides.
Send to a different recipient mid-flow, while continuing the parent flow for the original recipient (e.g., a buyer-triggered order workflow that also alerts the seller at one step)invokeworkflow node with recipient_selection: "expression" and recipient_expression pointing at the new recipientWorks for both event and api triggers. The invoked workflow runs in parallel with its own recipient. See Invoke Workflow.
Aggregate across recipients different from the workflow's trigger recipient (e.g., one digest per seller across many buyer-triggered orders)A separate workflow triggered with the digest key as its recipient, invoked from the parent via invokeworkflowDigest nodes batch on (recipient, workflow_slug). A digest inside a buyer-triggered workflow will always batch per-buyer. See Digest.

If a generated workflow sends to multiple distinct recipients across nodes and uses neither override_recipients_* nor invokeworkflow, it is wrong — every send will route to the trigger recipient.

For a complete guide on creating workflows using the JSON schema, see Workflow Schema Guide.

Minimum workflow

{
  "$schema": "https://schema.suprsend.com/workflow/v1/schema.json",
  "name": "welcome-email",
  "category": "onboarding",
  "trigger_type": "event",
  "trigger_events": ["user_signed_up"],
  "tree": {
    "nodes": [
      { "node_type": "send_email", "properties": { "template": "welcome-email" } }
    ]
  }
}

A workflow needs name, category, trigger_type, and tree with at least one delivery node. The properties.template field on a delivery node refers to the template slug authored separately.

Workflow Nodes

Delivery Nodes

Send notifications to users. Every workflow must end with at least one delivery or HTTP API node.

Node TypeSchema node_typeDescription
Single Channelsend_email, send_sms, send_whatsapp, send_inbox, send_mobile_push, send_webpush, send_slack, send_ms_teamsSend via one channel
Multi-Channelsend_multi_channelSend across multiple channels simultaneously
Smart Channel Routingsend_smart_channel_routingSend sequentially across channels with delays until engagement

See Delivery Nodes Reference for configuration details and schema.

Function Nodes

Control timing and aggregation of notifications.

Node TypeSchema node_typeDescription
DelaydelayPause workflow for a fixed, dynamic, or relative duration
BatchbatchAggregate multiple triggers into one notification
DigestdigestSend batched summary on a recurring schedule
Time WindowtimewindowDeliver only within specified day/time ranges

See: Delay, Batch, Digest, Time Window

Branch Nodes

Route notifications through different paths based on conditions.

Node TypeSchema node_typeDescription
BranchbranchIf/else routing based on conditions
Wait Untilbranch_waituntilPause until condition is met or timeout expires

When a branch is a terminal exit (rejection, timeout, no-response, failure), set is_terminal: true on the branch object. Without it, the workflow continues past the branch construct for that path — post-approval sends will fire for users who rejected, post-completion sends will fire for users who timed out. See Branch → Terminating the workflow on a branch and Wait Until → Terminating on timeout.

See: Branch, Wait Until

Data Nodes

Fetch, transform, or update data during workflow execution.

Node TypeSchema node_typeDescription
Fetchhttpapi_fetchGET data from an external API
Webhookhttpapi_webhookCall external API (GET/POST/PUT/PATCH/DELETE)
Data TransformtransformGenerate or modify variables using Handlebars or JSONNET
Invoke WorkflowinvokeworkflowTrigger another workflow as a step
Update User ProfileuserupdateModify recipient or actor profile properties

See: Fetch, Webhook, Transform, Invoke Workflow, User Update

List & Object Nodes

Manage user list memberships and object subscriptions.

Node TypeSchema node_typeDescription
Add User to Listsubscriberlistoperation_adduserAdd recipient/actor to a list
Remove User from Listsubscriberlistoperation_removeuserRemove recipient/actor from a list
Subscribe to Objectobjectoperation_addsubscriptionAdd user to an object subscription
Unsubscribe from Objectobjectoperation_removesubscriptionRemove user from an object subscription

See: List Operations, Object Operations

Related skills

  • suprsend-template-schema — delivery nodes reference templates by template slug. Use it to author the template content (variants per channel/locale/tenant) that the workflow sends.
  • suprsend-cli — suprsend workflow push / pull / commit / enable / disable are the commands that move workflow JSON between your editor and a SuprSend workspace.

Keep looking

Skills are one crate of 608,352. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.