Quick start

This quick start takes you from a new account to a delivered notification, then to production. You can do every step in three ways: with an AI agent, in code, or in the dashboard. All three work on the same workflows, templates and users, so you can switch at any step.

Before you start

Create your SuprSend account. Every account starts with a Sandbox workspace for trying SuprSend, and this quick start runs there:

Email, SMS, WhatsApp and Inbox providers are already connected.
Push, Slack and Microsoft Teams aren’t set up, because they send through your own apps: a Firebase or APNs account for push, and a Slack app or Teams bot for those channels. Add a channel covers each one.
A sample workflow and a sample user, created from your registered email, are ready to use.
Email, SMS and WhatsApp only deliver to verified channels, up to 5 per channel type. Your registered email is a good first recipient. Slack, Teams, Inbox and push have no such limit.
Sandbox is a trial workspace. It expires 30 days after you sign up.

Your account also has Staging and Production workspaces. That’s where you build your real notifications, with your own providers (SuprSend calls them vendors). Add them in Staging to test before you go live.

Set up how you’ll work

AI agent
Code
Dashboard

Add the hosted MCP server (beta) at https://mcp.suprsend.com/mcp to your AI client. There’s nothing to install. In Claude Code, run:

claude mcp add --transport http suprsend https://mcp.suprsend.com/mcp

For ChatGPT, Codex, Cursor, VS Code, Gemini CLI and others, see how to connect. On first use, your client opens a browser window so you can sign in with your SuprSend account.The server already gives the agent SuprSend’s workflow, template, SQL and docs skills, so there’s nothing extra to install. Add the CLI skill only if your agent will run the SuprSend CLI:

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

Admins get every tool, and members get read-only tools except the two that show sent message content, messages_get_content and messages_preview_content. Check it worked by asking: “List my SuprSend workspaces.”Name the sandbox workspace in your prompts so the agent works there.

Copy your Workspace Key and Workspace Secret from Developers → API Keys in Sandbox, and store them as environment variables:

.env

SUPRSEND_WORKSPACE_KEY=your_workspace_key
SUPRSEND_WORKSPACE_SECRET=your_workspace_secret

Install the SDK for your backend and create the client once:

// npm install @suprsend/node-sdk
const { Suprsend } = require("@suprsend/node-sdk");

const supr_client = new Suprsend(
  process.env.SUPRSEND_WORKSPACE_KEY,
  process.env.SUPRSEND_WORKSPACE_SECRET
);

# pip install suprsend-py-sdk
import os
from suprsend import Suprsend

supr_client = Suprsend(
    os.environ["SUPRSEND_WORKSPACE_KEY"],
    os.environ["SUPRSEND_WORKSPACE_SECRET"],
)

Java, Go and the REST API are covered in Integrate SuprSend.

Nothing to set up. Open app.suprsend.com and switch to Sandbox from the top navigation bar. You can also ask the In-product Agent to do any step for you: type in the floating chat box at the bottom of the page, or press Cmd+/ (Ctrl+/ on Windows) to open it as a side chat.

Step by step

A template holds the content, a user holds the addresses to send to, and a workflow decides what to send and when. A list groups users so you can send one message to all of them, or send users down a workflow as they enter or exit the list. See core concepts for more.

Build your first notification

Create an email template, order-shipped, with one variable, order_id, and a workflow, order-shipped-notification, that sends it.

AI agent
Code
Dashboard

“In my SuprSend sandbox workspace, create an email template called order-shipped with the subject ‘Your order has shipped’ and the body ‘Order #{{order_id}} is on its way.’ Then create an API-triggered workflow called order-shipped-notification that sends it. Publish both.”

Go to Templates → + New Template, name it Order Shipped and pick Email.
Set the subject to Your order has shipped and the body to Order #{{order_id}} is on its way. Then click Commit.
Go to Workflows → + New Workflow, name it Order Shipped Notification and pick the Transactional category.
Add a Single Channel delivery node, choose Email and the order-shipped template, and click Commit.

Integrate SuprSend walks through each screen.

Send it

Send the notification to yourself, at an email address that’s verified in Sandbox.

AI agent
Code
Dashboard

“Trigger order-shipped-notification in my SuprSend sandbox workspace for me at my verified email address, with order_id ORD-1234.”

Identify the user once, then trigger the workflow when the event happens:

const { WorkflowTriggerRequest } = require("@suprsend/node-sdk");

const user = supr_client.user.get_instance("user_1a2b3c");
user.add_email("you@example.com"); // a verified email in Sandbox
await user.save();

const w1 = new WorkflowTriggerRequest({
  workflow: "order-shipped-notification",
  recipients: [{ distinct_id: "user_1a2b3c" }],
  data: { order_id: "ORD-1234" },
});
const res = await supr_client.workflows.trigger(w1);
console.log(res);

from suprsend import WorkflowTriggerRequest

user = supr_client.user.get_instance("user_1a2b3c")
user.add_email("you@example.com")  # a verified email in Sandbox
user.save()

w1 = WorkflowTriggerRequest(body={
    "workflow": "order-shipped-notification",
    "recipients": [{"distinct_id": "user_1a2b3c"}],
    "data": {"order_id": "ORD-1234"},
})
res = supr_client.workflows.trigger(w1)
print(res)

distinct_id is your own ID for the user. The keys in data fill the template’s variables.

Press Cmd+/ (Ctrl+/ on Windows) to open the In-product Agent side chat and ask: “Trigger order-shipped-notification for me with order_id ORD-1234.” To check the content alone, send a test from the template editor.

Check the delivery log

Starting a workflow only means SuprSend accepted the request. The log shows whether the message actually went out, and why if it didn’t.

AI agent
Code
Dashboard

“Show me the delivery log for that run.”

Open Logs in the dashboard. Under Requests, open the workflow request to follow it node by node.

Open Logs. Under Requests, open the workflow request to follow it node by node and see the email delivered.

Then check your inbox. See logs for what each status means.

Add more channels

Each channel needs an address on the user, and some need a provider or an SDK first:

Channel	What you need	Guide
Email, SMS, WhatsApp	The user’s email address or phone number. Sandbox already has providers.	Email, SMS and WhatsApp
In-App Inbox, web push	The JavaScript or React SDK in your frontend	In-app inbox and web push
Mobile push	A Firebase or APNs account, and a mobile SDK in your app	Mobile push
Slack, Microsoft Teams	A bot token, conversation ID or incoming webhook URL	Slack and Microsoft Teams

With your agent: “Add an in-app inbox version to my order-shipped template in sandbox and publish it.”

Send a broadcast to a list

Send one message to everyone on a list, now or on a schedule. If you don’t have a list yet, create one first. Send a broadcast shows each step in the dashboard and with the In-product Agent.With your agent: “In my SuprSend sandbox workspace, create a list with only me in it, then send it a broadcast using the order-shipped template.”

Move to Staging, then Production

Sandbox is for trying SuprSend. To build for real:

In Staging, connect your own providers and turn on Test Mode so only your testers get messages.
Build and test your notifications there.
Sync your workflows and templates to Production and connect its providers.
Work through the go-live checklist before you launch.

With your agent: “Copy my order-shipped workflow and its template from staging to production as drafts, and tell me what to review before I publish.” Copies made through the MCP server land as drafts. To promote everything at once, use suprsend sync from the CLI instead. It commits every asset, so the changes go live immediately.

Next steps

Invite your team

Add teammates from Account Settings → Team and give each a role.

Customize notifications per tenant

Give each customer or product app its own branding, providers and preference defaults.

See a full build

Follow an example app with the Inbox and preferences, end to end.

Design notifications users engage with

Best practices for timing, channels and preferences.

Try the API without code

Run every API call from the Postman collection.

Promote changes across workspaces

Move workflows and templates from Staging to Production by cloning, with the CLI in your CI/CD pipeline, or with the Management API.

To choose between tenants and separate workspaces for each customer or app, see the multi-tenant modelling guide.

GETTING STARTED

CORE CONCEPTS

WORKFLOW BUILDER

Notification Inbox

PREFERENCE CENTRE

VENDOR INTEGRATION GUIDE

INTEGRATIONS

MONITORING & DEBUGGING

MANAGE YOUR ACCOUNT

Before you start

Set up how you’ll work

Step by step

Next steps

Invite your team

Customize notifications per tenant

See a full build

Design notifications users engage with

Try the API without code

Promote changes across workspaces

​Before you start

​Set up how you’ll work

​Step by step

​Next steps

Invite your team

Customize notifications per tenant

See a full build

Design notifications users engage with

Try the API without code

Promote changes across workspaces

Before you start

Set up how you’ll work

Step by step

Next steps