Learn how to trigger workflows using direct workflow API, with code snippets and examples.
"$skip_create": true
flag.This can be applied inside the actor, individual user recipient objects, or object recipient objects.Property | Type | Description |
---|---|---|
workflow | string | Slug of designed workflow on SuprSend dashboard. You’ll get the slug from workflow settings. |
recipients | array of string / array of objects | List of users who need to be notified. You can add up to 100 recipients in a workflow trigger. You can either pass recipients as an array of distinct_id (if the user is pre-synced in SuprSend database) or define recipient information inline. |
actor (Optional) | string / object | Includes distinct_id and properties of the user who performed the action. You can use it for cross-user notifications, where you need to include actor properties in the notification template. Actor properties can be added as $actor.<prop> . |
data | object | Variable data required to render dynamic template content or workflow properties such as dynamic delay or channel override in send node. |
tenant_id (Optional) | string | Trigger workflow for a specific tenant/brand. |
idempotency_key (Optional) | string | Unique identifier of the request. We’ll be returning idempotency_key in our outbound webhook response. You can use it to map notification statuses and replies in your system. |
recipients\[].$timezone | string | Sets the recipient’s timezone. Used to send notifications in the user’s local timezone. You can pass the timezone in IANA (TZ identifier) format. |
recipients\[].$preferred_language | string | Sets the recipient’s preferred language. This supports localization in notification content. You can pass the language in ISO 639-1 2-letter format. Refer to all language codes here. |
distinct_ids
or recipient objects. You can pass up to 100 recipients in a single workflow trigger. SuprSend will internally convert it into multiple workflow triggers, one for each recipient in the array.
$recipient.<property>
.
This is how the complete recipient object with look like
Property | Type | Description |
---|---|---|
distinct_id | string | Unique identifier of the user to be notified. |
communication channels ($email , $sms , etc.) | array of string / objects | The communication channels info provided will be updated to the user profile in the background. For this workflow, only channel values specified for this recipient will be used for sending notifications instead of all channel values present in the user profile. |
channels | array of string | By default, notifications will be sent to all channels defined in the workflow delivery nodes. However, if a user has a specific channel preference for a notification (e.g. they only want to receive payment reminders via email), you can include that preference in the workflow payload. This will ensure that notifications are sent only to the specified channels. Supported channels: email, sms, whatsapp, androidpush, iospush, slack, webpush, ms_teams .You can always use our in-built preference APIs to maintain user notification preferences. Preferences defined within SuprSend will automatically apply with workflow triggers. |
$preferred_language | string | Sets the recipient’s preferred language to support localization in notification content. You can pass the language in ISO 639-1 2-letter format. Refer to all language codes here. |
$timezone | string | Sets the recipient’s timezone. Used to send notifications in the user’s local timezone. You can pass the timezone in IANA (TZ identifier) format. |
\* | object | You can pass other user properties to render dynamic template content. These properties will also be set in the user profile and can be used in the template as $recipient.<property> . |
$actor.<property>
.
"is_transient": true
in your recipient object. This approach is recommended for scenarios where you need to send notifications to unregistered users without creating them in the SuprSend platform. The same way, you can pass "is_transient": true
in your actor object to use actor properties in template without creating user profile.
tenant_id
in your workflow instance. You can use this to dynamically manage tenant level notification customizations. This includes the ability to customize template design or content and route notifications via tenant vendors.
idempotency_key
for next 24 hours. Idempotency key should be uniquely generated for each request (max 255 characters allowed). Spaces in start and end of the key will be trimmed. Here are some common approaches for generating idempotency keys:
user147-new-comment-1687437670
.append()
and workflows.bulkTriggerInstance()
to add however-many-records to call in bulk.
wf.addAttachment()
for each file with local path or remote attachment url. Ensure that file path is valid, and public(for remote url) otherwise it will raise error.
Create a json file with workflow configurations in a file named input.json
Parameter | Description | Format | Obligation |
---|---|---|---|
name | It is the unique name of the workflow. You can see workflow-related analytics on the workflow page (how many notifications were sent, delivered, clicked or interacted). The workflow name should be easily identifiable for your reference at a later stage | text | Mandatory |
template | It is the unique slug of the template created on SuprSend platform. You can get this slug by clicking on the clipboard icon next to the Template name on SuprSend templates page. It is the same for all channels | slug name | Mandatory |
notification_category | You can understand more about them in the Notification Category documentation | system / transactional / promotional | Mandatory |
delay | Workflow will be halted for the time mentioned in delay, and become active once the delay period is over. | XXdXXhXXmXXs or if its number (n) then delay is in seconds (n) | Optional |
trigger_at | Trigger workflow on a specific date-time | date string in ISO 8601 e.g. “2021-08-27T20:14:51.643Z” | Optional |
users | Array object of target users. Atleast 1 user mandatory. distinct_id for each user mandatory Channel information is non-mandatory. If you pass channel information here, then these channels will be used for sending notification otherwise channels will be picked from user profile. | "users": [ { "distinct_id": "value", "$channels":[], channel_information_dict #(optional) }], | Mandatory |
delivery | Delivery instructions for the workflow. You can enable smart delivery by setting "smart":True By default, delivery instruction will be "delivery": { "smart": False, "success": "seen" } Checkout the docs for more info. | delivery = { "smart": True/False, "success": "delivered/seen/interaction/", "time_to_live": "", "mandatory_channels": []} , # list of mandatory channels e.g gation” | Optional |
data | JSON. To replace the variables in the template, templates use handlebars language | "data": { "key": { "key": "value", "key": "value" } }, | Optional |
To find the template slug name on SuprSend platform, click on the clipboard icon on Templates page. Templates > Template Details Page
$sms
and $whatsapp
, +<countrycode>
is mandatory to send along with phone number. e.g. +91 for IndiaCall suprsend.triggerWorkflow() method to trigger workflow
suprClient.triggerWorkflow
, the SDK internally makes an HTTP
call to SuprSend Platform to register this request, and you’ll immediately receive a response indicating the acceptance status.Possible values for status key in the response:status | Description |
---|---|
202 | Request was successfully accepted |
400 | Some of the backend validations failed due to which request could not be accepted. More details will be present against the message key. |
401 | Unauthorised access made to Suprsend backend. Please check the credentials that are being passed. |
500 | Any other error which was not handled by the Suprsend system. You will find more details against the message key in response. |
.append()
on bulk_workflows
instance to add however-many-records to call in bulk.Response is an instance of suprsend.BulkResponse
class.