Skip to main content
The suprsend-workflow-schema skill gives your agent the full SuprSend workflow JSON schema. It generates complete, valid workflow JSON from a plain-English description. Workflows conform to https://schema.suprsend.com/workflow/v1/schema.json. See Design Workflow for the full overview.

​
Installation

npx skills add https://github.com/suprsend/skills --skill suprsend-workflow-schema
Generated workflow is saved in suprsend/workflow/ directory and can be pushed to SuprSend using suprsend workflow push --commit=true command.

​
Workflow file structure

suprsend/
└── workflow/
    ├── cart-abandonment.json
    ├── payment-reminder.json
    └── onboarding.json
Each file must include a slug — the unique identifier used by the CLI to target a specific workflow: 
{
  "$schema": "https://schema.suprsend.com/workflow/v1/schema.json",
  "slug": "cart-abandonment",
  "name": "Cart Abandonment Reminder"
}
Workflows without a slug cannot be targeted with suprsend workflow push --slug. Always include it in generated JSON.

​
Node reference

​
Delivery

Nodenode_typeDocs
Emailsend_emailEmail
SMSsend_smsSMS
WhatsAppsend_whatsappWhatsApp
In-App Inboxsend_inboxIn-App Inbox
Mobile Pushsend_mobile_pushMobile Push
Web Pushsend_webpushWeb Push
Slacksend_slackSlack
MS Teamssend_ms_teamsMS Teams
Multi-Channelsend_multi_channelMulti-Channel
Smart Channel Routingsend_smart_channel_routingSmart Channel Routing
Webhookhttpapi_webhookHTTP API

​
Function

Nodenode_typeDocs
DelaydelayDelay
BatchbatchBatch
DigestdigestDigest
Time WindowtimewindowTime Window

​
Branch

Nodenode_typeDocs
BranchbranchBranch
Wait Untilbranch_waituntilWait Until

​
Data

Nodenode_typeDocs
Fetchhttpapi_fetchFetch
TransformtransformData Transform
Invoke WorkflowinvokeworkflowInvoke Workflow
Update User ProfileuserupdateUpdate User Profile

​
List and Object

Nodenode_typeDocs
Add User to Listsubscriberlistoperation_adduserAdd User to List
Remove User from Listsubscriberlistoperation_removeuserRemove User from List
Subscribe to Objectobjectoperation_addsubscriptionSubscribe to Object
Unsubscribe from Objectobjectoperation_removesubscriptionUnsubscribe from Object

​
Known limitation

Agents may 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 definitions on GitHub.

Design Workflow

How to design and publish workflows.

suprsend-cli skill

Push generated workflows to SuprSend.

Agent Skills Overview

All available skills.