suprsend-workflow-schema

Generate valid SuprSend workflow JSON from plain English. This skill teaches your AI agent every workflow node, field, and validation rule.

Use this skill when you want your AI agent to generate, edit, or refactor SuprSend workflow JSON - without making up node_type values or missing required fields.

The skill loads the full https://schema.suprsend.com/workflow/v1/schema.json spec into your agent’s context whenever it detects a workflow task. Every generated file lands in suprsend/workflows/<slug>/workflow.json and is ready to push with the suprsend-cli skill.

Install

npx skills add https://github.com/suprsend/skills --skill suprsend-workflow-schema

Schema spec

The JSON Schema the skill validates against.

---

Try it

1. Paste this into your agent

   Create a SuprSend workflow JSON with slug "payment-failed".
   Send an email immediately, wait 24 hours, then send an SMS
   only if the user hasn't retried payment yet.
   
2. Your agent generates the file

   The skill activates and produces suprsend/workflows/payment-failed/workflow.json:

   {
     "$schema": "https://schema.suprsend.com/workflow/v1/schema.json",
     "slug": "payment-failed",
     "name": "Payment Failed",
     "category": "transactional",
     "trigger_type": "api",
     "tree": {
       "nodes": [
         { "node_type": "send_email", "properties": { "template": "payment-failed" } },
         {
           "node_type": "branch_waituntil",
           "properties": {},
           "branches": [
             {
               "name": "Payment retried",
               "is_default": false,
               "conditions": [{ "type": "future_event", "event_name": "payment_retried" }],
               "nodes": []
             },
             {
               "name": "After 24 hours",
               "is_default": true,
               "conditions": [{ "type": "delay", "delay_properties": { "delay_type": "fixed", "value": "24h" } }],
               "nodes": [{ "node_type": "send_sms", "properties": { "template": "payment-failed-reminder" } }]
             }
           ]
         }
       ]
     }
   }
   
3. Push it live

   suprsend workflow push --slug payment-failed --commit=true
   

Want more example prompts? See the Prompt Cheatsheet.

---

What you can build

Cart abandonment

Wait 1 hour, then email and in-app notification.

Password reset

Immediate email with retry SMS after 5 minutes.

Onboarding drip

Email today, in-app tomorrow, SMS in 3 days unless the user activates.

Payment reminder

Branch on invoice status, escalate channels over a week.

Re-engagement

Triggered when a user enters a “dormant” list.

---

File layout

Every workflow lives in its own directory under suprsend/workflows/, as <slug>/workflow.json. The directory name is the slug - that’s what the CLI uses to target the workflow.

suprsend/
└── workflows/
    ├── cart-abandonment/
    │   └── workflow.json
    ├── payment-failed/
    │   └── workflow.json
    └── onboarding/
        └── workflow.json

A slug inside the file is optional - the directory name always wins - but a plain suprsend workflow push warns when it’s missing or differs, so keep it in sync:

{
  "$schema": "https://schema.suprsend.com/workflow/v1/schema.json",
  "slug": "cart-abandonment",
  "name": "Cart Abandonment Reminder"
}

suprsend workflow push --slug <slug> reads suprsend/workflows/<slug>/workflow.json and pushes it as <slug>, whatever the file’s slug says. A plain suprsend workflow push uses each directory name and warns when the file’s slug differs - double-check after edits.

---

Node reference

The skill knows every node below. You’ll rarely need to look these up by hand, but they’re useful for verifying generated output.

Delivery nodes

Node	node_type	Docs
Email	send_email	Email
SMS	send_sms	SMS
WhatsApp	send_whatsapp	WhatsApp
In-App Inbox	send_inbox	In-App Inbox
Mobile Push	send_mobile_push	Mobile Push
Web Push	send_webpush	Web Push
Slack	send_slack	Slack
MS Teams	send_ms_teams	MS Teams
Multi-Channel	send_multi_channel	Multi-Channel
Smart Channel Routing	send_smart_channel_routing	Smart Channel Routing
Webhook	httpapi_webhook	HTTP API

Function nodes

Node	node_type	Docs
Delay	delay	Delay
Batch	batch	Batch
Digest	digest	Digest
Time Window	timewindow	Time Window

Branch nodes

Node	node_type	Docs
Branch	branch	Branch
Wait Until	branch_waituntil	Wait Until

Data nodes

Node	node_type	Docs
Fetch	httpapi_fetch	Fetch
Transform	transform	Data Transform
Invoke Workflow	invokeworkflow	Invoke Workflow
Update User Profile	userupdate	Update User Profile

List and Object nodes

Node	node_type	Docs
Add User to List	subscriberlistoperation_adduser	Add User to List
Remove User from List	subscriberlistoperation_removeuser	Remove User from List
Subscribe to Object	objectoperation_addsubscription	Subscribe to Object
Unsubscribe from Object	objectoperation_removesubscription	Unsubscribe from Object

---

Known limitation

Agents sometimes produce incorrect expression_v1 conditions inside branch_waituntil nodes. Always review branch logic before pushing to production. See Wait Until for correct syntax.

---

Learn more

Schema Guide

Detailed field-by-field schema reference on GitHub.

Design Workflow

How workflows work end-to-end in SuprSend.

suprsend-template-schema skill

Generate the template variants that workflow delivery nodes reference.

suprsend-cli skill

Push generated workflows to your workspace.