From SuprSend Platform
SuprSend workflow builder enables you to design notification workflows from the SuprSend platform itself. Workflow combines all the communication elements (like user, trigger, template, vendor, etc) and adds a business logic to it to determine which users to notify, when to notify and across which channels.
We recommended designing workflows on SuprSend platform as most of the workflow elements are not tied to the code, and can be easily modified through SuprSend dashboard without changing anything in the code.
To create a workflow on SuprSend dashboard, just follow below simple steps:
Step 1. Create New Workflow
Click on the 'Workflows' tab on left panel, you see a list of all workflows (active and inactive) on this page. From here, click on 'New Workflow'
Step 2. Add relevant information in the workflow form and "Save"
Below are the possible fields that can be added in workflow form and their type and usage:
| Field Name | Description |
|---|---|
| Mandatory Workflow Name | Add a name to identify the workflow. Recommended to add a name which defines the communication to be sent (Eg. in the above image, the communication is sent when the user makes a purchase). You can see Analytics and Logs at a workflow level. |
| Mandatory Trigger -> Event Name | Event Name is the trigger point to initiate the workflow on SuprSend platform. This could be an action performed by user on your app or a trigger added in backend code just to trigger the workflow (Eg. Notify a user when he makes a purchase on the product). You can either select an existing event or type in a new event name. Event has to be sent to SuprSend by one of SuprSend SDKs. Checkout Events section on how to send Events, with user details and variables data in it. |
| Optional Trigger -> Delay | You can add delay if you want to send the notification after a delay from sending the event. (Eg. Notify a user after 1 hour of making a purchase). You can add delay in days, hours, minutes. |
| Optional Trigger -> Batch Events | Select Batch Events if you want to send batched / digest notification |
| Mandatory Template Name | Select the template name from the drop down, which will have the message content to be sent. You will only see the list of active (atleast 1 channel published) templates here |
| Mandatory Notification Category | Select one of 'System', 'Transactional', 'Promotional. To understand more about Notification Category, refer section. |
| Mandatory Success Metric | Add a success metric that will be used to measure the success of your workflow. Refer Success Metric section to know more |
| Mandatory Delivery | You can select from one of the 2 options: 1. Send to All Channels at once - This will trigger communication on all active channels common to user and template 2. Smart Delivery - You can set this option to send notification sequentially on channels in the order of Notification cost (low to high), starting with the channel with the lowest Price per notification. The communication will be sent on channels until the success metric is achieved. Refer Smart Delivery section to know more |
Step 3. Enable Workflow
Once saved, you can see the Workflow name on the Workflows Listing page in disbaled state. You can enable / disable a workflow by clicking on 'Is Active' toggle on the workflow details page
How will Workflow run?
Whenever a new event with the chosen 'Event Name' is received on SuprSend, the workflow will be initiated.
When will a Workflow not deliver communication?
On receiving an event, workflow will get triggered. However it may not deliver the communication to a specific channel if it encounters any of the errors below:
- Variable data mismatch - Value corresponding to added variables in any of the template is missing. (Make sure the variable name added in template is matching with JSON data coming in event). You'll be able to see the variables mismatch on the logs page
- User channel details is not available in user profile. Refer to Users section to know how to add channels in user profile
In all these cases where workflow doesn't trigger notification on one or more channels, we will log a soft error. Workflow will trigger notification as usual for channels for which there was no error encountered. (Eg. SMS may be triggered, email not triggered)
Updated 11 months ago