​
Create SuprSend account

Simply signup on SuprSend to create your account. If you already have your company account setup, ask your admin to invite you to the team.

​
Integrate push channel in your application

For Android applications, Integrate SuprSend SDK and FCM (service provider for sending android push notifications).
LanguageDocumentationExample
Native AndroidIntegrate Android SDK and Integrate FCM in native application-
React Native (Android)Integrate React Native SDK and Integrate FCM in react native applicationGitHub
Flutter (Android)Integrate Flutter SDK and Integrate FCM in flutter applicationGitHub
For iOS applications, Integrate SuprSend SDK and APNS (service provider for sending iOS Push notifications)
LanguageDocumentationExample
Native iOSIntegrate iOS SDK and Integrate APNS in native application-
React Native (iOS)Integrate React Native SDK and Integrate APNS in react native applicationGitHub
Flutter (iOS)Integrate Flutter SDK and Integrate APNS in flutter applicationGitHub

​
Start testing in Sandbox workspace

Your SuprSend account includes three default workspaces: Sandbox, Staging, and Production. You can switch between them from the top navigation bar, and create additional workspaces if needed.
  1. Sandbox
    • Demo Workspace with pre-configured vendors for quick exploration and POC.
    • Includes a sample workflow, a sample user with your registered email and pre-configured channels for quick testing.
    • Limitation: Available for a trial period of 30 days.
  2. Staging
    • Development workspace used to test notification flows before pushing it to production.
    • You can enable Test Mode to safely test notification flows without delivering to real users. In Test Mode, notifications is delivered only to designated internal testers. You can also set up a catch-all channel to redirect all notifications intended for non-test users.
  3. Production
    • Live workspace for syncing your actual product users and running production workflows.
    • We do not recommend making changes directly in your production workspace as it might disrupt your live notifications.

​
Identify user to attach push token to their profile

Call this method as soon as you know the identity of user, that is after login authentication. Pass the id that you use as internal user identifier (UUID, email or numeric code). You’ll use this same id in recipient field to trigger the notification. 
ssApi.identify(_distinct_id_)

//Sample Values
ssApi.identify("291XXXXX-62XX-4dXX-b2XX");
ssApi.identify("johndoe@suprsend.com");

​
Call reset to clear user data on log out

Don’t forget to call reset on user logout. If not called, user id will not reset and multiple tokens and channels will get added to the distinct_id who logged in first on the device. 
ssApi.reset()

​
Create a workflow

Workflow houses the automation logic of your notification. Each workflow starts with a trigger, processes the defined logic, and sends one or more messages to the end user. You can create a workflow from SuprSend dashboard by clicking on button on the workflows tab. To design a workflow, you need:
  1. A Trigger point- Trigger initiates the workflow. You can initiate it
    • Using the direct workflow API, where you can include recipient channel information, preferences, and actor details directly in the trigger.
    • By emitting an event: You can trigger these events from your frontend application or from your backend systems, depending on the use case. (note: the recipient needs to be pre-created for event-based triggers).
  2. Delivery node- Delivery Nodes represent the channels where users will receive notifications. You can use:
    • multi-channel nodes to send messages across multiple channels,
    • smart channel routing to notify users sequentially rather than bombarding them on all channels at once (though it’s generally better to use).
    • Template in delivery node contains the content of the notification. You can add both static and dynamic content sourced from user properties or trigger payloads. We use handlebars as our Push templating language. You can add dynamic content as {{var}}. Add trigger data in the mock to get variable auto-suggestions during editing. Ensure to publish the template before using it in a workflow.
    Learn how to design Android Push and iOS Push template here.
3. Functional nodes (Optional)- These are the logic nodes in the workflow. You can use it to add delay, batch multiple notifications in a summary or add conditional branches in the workflow. Check out all workflow nodes here.

​
Trigger the workflow

You can trigger a test workflow directly from dashboard by clicking on ‘Text’ button in your workflow editor or “Commit” changes to trigger it from your code. We follow Git like versioning for workflow changes, so you need to commit your changes to trigger new workflow via the API. You can check all methods of triggering workflow here. To trigger a workflow, you need:
  1. Recipient- End user who would be notified in the workflow run. Recipient is uniquely identified by distinct_id within SuprSend and must have the relevant channel identity set in their profile. You can define recipient inline in case of API based trigger or create user profile first with user creation method for event based trigger.
  2. Data or Event Properties- This will be used to render dynamic content in the template (added in template mock) or variables in the workflow configuration.
We’ll be triggering the workflow with direct API trigger for quick testing. You can check all trigger methods here.
Sample payload for API based trigger You can get workspace key, secret or API Key for trigger from Settings tab -> API Keys . Push channel will be updated in user profile as soon as you identify the user in step 4, so you can just pass the distinct_id and data in the trigger. 
curl --request POST \
     --url https://hub.suprsend.com/trigger/ \
     --header 'Authorization: Bearer __api_key__' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "workflow": "_workflow_slug_",
  "recipients": [
      {
        "distinct_id": "0gxxx9f14-xxxx-23c5-1902-xxxcb6912ab09",
        "name":"recipient_1"
      }
    ],
  "data":{
      "first_name": "User",
      "invoice_amount": "$5000",
      "invoice_id":"Invoice-1234"
    }
 }
'

​
Check notification logs

You can view the status of any sent notification under the Logs tab. Logs are organized in the following order:
  • Requests: Captures all API/SDK requests sent to SuprSend from your backend or frontend. You can see the input payload and request response here.
  • Executions: Workflow executions are logged here. You can click on a log entry to open the step-by-step workflow debugger
  • Messages: All delivery nodes (including webhooks) are tracked here along with their message status (delivered, seen, clicked). Message preview for delivered notifications will also be available soon.

​
Push to Production

In SuprSend, each environment is isolated, meaning workflows, users, and vendors are configured separately in testing and production workspaces. Follow this go live checklist to setup things in production once you are done testing.