suprsend-workflow-schema

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/workflow/ 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

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.

Your agent generates the file

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

{
  "$schema": "https://schema.suprsend.com/workflow/v1/schema.json",
  "slug": "payment-failed",
  "name": "Payment Failed",
  "nodes": [
    { "node_type": "send_email", "...": "..." },
    { "node_type": "branch_waituntil", "duration": "24h", "...": "..." },
    { "node_type": "send_sms", "...": "..." }
  ]
}

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 JSON file lives under suprsend/workflow/. The filename doesn’t matter - but the slug field inside does, since that’s what the CLI uses to target the workflow.

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

Every file must include a slug:

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

Without slug, you can’t target the workflow with suprsend workflow push --slug. The skill always includes it - but 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.

Build with AI

MCP

Agent Skills

Agent SDK

Install

Schema spec

Try it

What you can build

File layout

Node reference

Known limitation

Learn more

Schema Guide

Design Workflow

suprsend-template-schema skill

suprsend-cli skill

Install

Schema spec

​Try it

​What you can build

​File layout

​Node reference

​Known limitation

​Learn more

Schema Guide

Design Workflow

suprsend-template-schema skill

suprsend-cli skill

Try it

What you can build

File layout

Node reference

Known limitation

Learn more