Mobile Push

​

Different workspaces and their usage

• Sandbox is setup for quick testing with sample workflow, a sample user with your registered email and pre-configured channels (email, SMS, WhatsApp, Inbox) for quick testing. It’s ideal for quick exploration and testing and is available for limited period.
• Staging is your development workspace. You’ll do all your iterations and testing in this workspace before pushing it to production.
• Production workspace is where you’ll configure your live notifications and sync your actual product users. We do not recommend making changes directly in your production workspace. It will safeguard you from accidentally sending a test notification to your production users.

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

ssApi.reset()

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.

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.

​

Sample payload for API based 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"
    }
 }
'