Trigger Workflow from API

It is a unified API to trigger workflow and doesn't require user creation before hand to trigger notification. Recommended for platforms transitioning their existing notifications to SuprSend.
If you are using our frontend SDKs to configure notifications and passing events and user properties from third-party data platforms like Segment, then event-based trigger would be a better choice.

📘
Available in SDK version >= v0.11.0.

Payload Schema

from suprsend import Event
from suprsend import WorkflowTriggerRequest

supr_client = Suprsend("_workspace_key_", "_workspace_secret_")

# Prepare workflow payload
w1 = WorkflowTriggerRequest(
  body={
    "workflow": "_workflow_slug_",
    "actor": {
      "distinct_id": "0fxxx8f74-xxxx-41c5-8752-xxxcb6911fb08",
      "name":"actor_1"
    },
    "recipients": [
      {
        "distinct_id": "0gxxx9f14-xxxx-23c5-1902-xxxcb6912ab09",
        "$email":["[email protected]"],
        "name":"recipient_1"
      }
    ],
    "data":{
      "first_name": "User",
      "invoice_amount": "$5000",
      "invoice_id":"Invoice-1234"
    }
  },
    tenant_id = "tenant_id1",
    idempotency_key = "_unique_identifier_of_the_request_"
  )

# Trigger workflow
response = supr_client.workflows.trigger(w1)
print(response)

Property	Type	Description
workflow	string	Slug of designed workflow on SuprSend dashboard. You'll get the slug from workflow settings.
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 notification template. Actor properties can be added as `$actor.<prop>`.
recipients	array of string / array of objects	List of users who need to be notified. You can add upto 100 recipients in a workflow trigger. You can either pass recipients as an array of `distinct_ID` (if user is pre-synced in SuprSend database) or define recipient information inline.
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	string	unique identifier of the brand / tenant
idempotency_key	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.

Sending notification to multiple recipients

Recipients in workflow call is an array of distinct_ids or recipient objects. You can pass upto 100 recipients in a single workflow trigger. SuprSend will internally convert it into multiple workflow triggers, one for each recipient in the array.

"recipients": [
      {
        "distinct_id": "id1",
        "$email":["[email protected]"],
        "name":"recipient_1"
      },
  	 {
        "distinct_id": "id1",
        "$email":["[email protected]"],
        "name":"recipient_2"
      }
    ]

---- OR ------
"recipients": ["id1","id2"]

📘
Use lists to broadcast to a large list of users
We recommend you to use lists and broadcasts to send notifications to a user list larger than 1000 users. This approach allows for bulk processing within SuprSend, resulting in significantly faster delivery compared to individual workflow calls. Sending individual workflows to a large set of users may introduce delays in your notification queue and is not an optimized way of handling bulk trigger.

Identifying recipients inline

One of the benefits of using direct workflow trigger is that you can identify recipients inline. You can include recipient channel information, their channel preferences, and their user properties along with the workflow trigger. Upon triggering the workflow, the recipient will be automatically created in the SuprSend database in the background. This facilitates dynamic synchronization of your user data within SuprSend and eliminates the need for any migration efforts on your end to start sending notifications from SuprSend. You can also use recipient properties in your template as $recipient.<property>.

This is how the complete recipient object with look like

{
  "distinct_id": "0gxxx9f14-xxxx-23c5-1902-xxxcb6912ab09",
  "$email":["[email protected]"],
  "$channels":["email","inbox"],
  "user_prop1":"value_1",
  "$preferred_language":"en"
}

Property	Type	Description
distinct_id	string	Unique identifier of the user to be notified.
`$<channel>`(eg. `$sms`)	array of string / objects	You can pass user channel information using `$<channel>` key. The channel info will be updated to user profile in the background. For this workflow, only channel values specified in this key will be used for sending notification (instead of all channel values present in User profile) Refer how different communication channels can be passed here.
$channels	array of string	Use it to pass user's channel preference in the payload. You can always use our in-build preference APIs to maintain user notification preferences. Preferences defined within SuprSend will automatically apply with workflow trigger. By default, notifications will be sent to all channels defined in the workflow delivery node. However, if you have a scenario where user has 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 channels specified in the $channels key. Supported channel values are `email, sms, whatsapp, androidpush, iospush, slack, webpush, ms_teams`.
$preferred_language	string	Used to override user's language preference.
*	key-value pair	You can pass other user properties to render dynamic template content in key-value pair as `"user_prop1":"value1"` . Extra properties will be set in subscriber profile (as subscriber properties) which can then be used in the template as `$recipient.<property>`.

Add User Communication Channel

"$email":["[email protected]"],
"$whatsapp":["+15555555555"],
"$sms":["+15555555555"],
"$androidpush": [{"token": "__android_push_token__", "provider": "fcm", "device_id": ""}],  
"$iospush":[{"token": "__ios_push_token__", "provider": "apns", "device_id": ""}],
"$slack": [{
  "email": "[email protected]",
  "access_token": "xoxb-XXXXXXXX"
}]   // slack using email

"$slack": [{
  "user_id": "U/WXXXXXXXX",
  "access_token": "xoxb-XXXXXX"
}] // slack using member_id

"$slack": [{
  "channel": "CXXXXXXXX",
  "access_token": "xoxb-XXXXXX"
}] // slack channel

"$slack": [{
  "incoming_webhook": {
    "url": "https://hooks.slack.com/services/TXXXXXXXXX/BXXXXXXXX/XXXXXXXXXXXXXXXXXXX"
  }
}] // slack incoming webhook

"$ms_teams": [{
  "tenant_id": "c1981ab2-9aaf-xxxx-xxxx",
  "service_url": "https://smba.trafficmanager.net/amer",
  "conversation_id": "19:c1524d7c-a06f-456f-8abe-xxxx"
}] // MS teams user or channel using conversation_id

"$ms_teams": [{
  "tenant_id": "c1981ab2-9aaf-xxxx-xxxx",
  "service_url": "https://smba.trafficmanager.net/amer",
  "user_id": "29:1nsLcmJ2RKtYH6Cxxxx-xxxx"
}] // MS teams user using user_id

"$ms_teams": [{
  "incoming_webhook": {
    "url": "https://wnk1z.webhook.office.com/webhookb2/XXXXXXXXX"
  }
}] // MS teams incoming webhook

Sending cross-user notifications

In scenarios where you need to notify a group of users based on another user's action, such as sending a notification to the document owner when someone comments on it, you can specify the actor in your workflow call. This allows you to use actor's name or other properties in your notification template. Actor properties can be included in the template as $actor.<property>.

Sample template with actor and recipient properties:

//handlebar template
Hi {{$recipient.name}}, {{$actor.name}} added {{length comments}} new comments on the {{doc_name}}.

//Rendered content
Hi recipient_1, actor_1 added 2 new comments on the annual IT report.

{
  "workflow": "new_comment",
  "actor": {
    "distinct_id": "0fxxx8f74-xxxx-41c5-8752-xxxcb6911fb08",
    "name":"actor_1"
  },
  "recipients": [
    {
      "distinct_id": "0gxxx9f14-xxxx-23c5-1902-xxxcb6912ab09",
      "$email":["[email protected]"],
      "name":"recipient_1"
    }
  ],
  "data":{
    "doc_name": "annual IT report",
    "date": "2024-01-01",
    "comments":["change the date","rest looks good"]
  }
}

Sending notification to anonymous user

You can send notifications to anonymous users by passing "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.

from suprsend import Event
from suprsend import WorkflowTriggerRequest

supr_client = Suprsend("_workspace_key_", "_workspace_secret_")

# Prepare workflow payload
w1 = WorkflowTriggerRequest(
  body={
    "workflow": "_workflow_slug_",
    "actor": {
      "is_transient": True,
      "name":"actor_1"
    },
    "recipients": [
      {
        "is_transient": True,
        "$email":["[email protected]"],
        "name":"recipient_1"
      }
    ],
    "data":{
      "first_name": "User",
      "invoice_amount": "$5000",
      "invoice_id":"Invoice-1234"
    }
  },
  tenant_id = "tenant_id1",
  idempotency_key = "_unique_identifier_of_the_request_"
)

# Trigger workflow
response = supr_client.workflows.trigger(w1)
print(response)

Multi-tenant notifications

For usecases where you want to send notifications to your enterprise customers' end users, pass the 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.

from suprsend import Event
from suprsend import WorkflowTriggerRequest

supr_client = Suprsend("_workspace_key_", "_workspace_secret_")

# Prepare workflow payload
w1 = WorkflowTriggerRequest(
  body={...},
  tenant_id = "tenant_id1",
  idempotency_key = "_unique_identifier_of_the_request_"
)

# Trigger workflow
response = supr_client.workflows.trigger(w1)
print(response)

Idempotent requests

SuprSend supports idempotency to ensure that requests can be retried safely without duplicate processing. If Suprsend receives and processes a request with an idempotency_key, it will skip processing requests with same 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:

Generate a random UUID for each request.
Construct the idempotency key by combining relevant information about the request. This can include parameters, identifiers, or specific contextual details that are meaningful within your application. For example, you could concatenate the user ID, action, and timestamp to form an idempotency key like user147-new-comment-1687437670
Request-specific Identifier: If your request already contains a unique identifier, such as an order ID or a job ID, you can use that identifier directly as the idempotency key.

Response structure

{
  success: true,
  status: 'success',
  status_code: 202,
  message: { status: 'success' }
}

Once your request is accepted, you can check the status of your request in the ' SuprSend Logs' section.

Bulk API for triggering multiple workflows

Bulk API allows you to send multiple workflow requests in a single call. There isn't any limit on number-of-records that can be added to bulk_workflows instance. Use .append() on workflows.bulk_trigger_instance() instance to add however-many-records to call in bulk.

from suprsend import Event
from suprsend import WorkflowTriggerRequest

supr_client = Suprsend("_workspace_key_", "_workspace_secret_")

# Workflow: 1
w1 = WorkflowTriggerRequest(
  body={...},
  tenant_id = "tenant_id1",
  idempotency_key = "_unique_identifier_of_the_request_"
)

# Workflow: 2
w2 = WorkflowTriggerRequest(
  body={...}
)
# ...... Add as many Workflow records as required.

bulk_ins = supr_client.workflows.bulk_trigger_instance()

bulk_ins.append(w1,w2)

# Trigger workflow
response = bulk_ins.trigger()
print(response)

Response

Response is an instance of suprsend.BulkResponse type

# Response structure
from suprsend import BulkResponse

BulkResponse(
  status = "success",
  total = 10, # number of records sent in bulk
  success = 10, # number of records succeeded
  failure = 0, # number of records failed
  warnings = [],
  failed_records = []
)

BulkResponse(
  status = "fail",
  total = 10, # number of records sent in bulk
  success = 0, # number of records succeeded
  failure = 10, # number of records failed
  warnings = [],
  failed_records = [{"record": {...}, "error": "error_str", "code": 500}]
)

BulkResponse(
  status = "partial",
  total = 10, # number of records sent in bulk
  success = 6, # number of records succeeded
  failure = 4, # number of records failed
  warnings = [],
  failed_records = [{"record": {...}, "error": "error_str", "code": 500}]
)

Add file attachment in email

To add one or more Attachments to a Notification (viz. Email), call wf_instance.add_attachment() for each file with local-path. Ensure that file_path is proper, otherwise it will raise FileNotFoundError.

from suprsend import Workflow

workflow_body = {...}
wf_instance = Workflow(body=workflow_body)

# this snippet can be used to add attachment to workflow
file_path = "/home/user/billing.pdf"
wf_instance.add_attachment(file_path)

🚧
A single workflow body size (including attachment) must not exceed 800KB (800 x 1024 bytes).

Dynamic workflow trigger

You can trigger workflow from python SDK using supr_client.trigger_workflow method.

from suprsend import Workflow
# Prepare Workflow body
workflow_body = {
  "name": "workflow_name",
  "template": "template_slug",
  "notification_category": "notification_category", # notification category transactional/promotional/system
  "delay": "time_delay",  # time delay after which the first notification will be sent
  "trigger_at": "date string in ISO 8601", #to trigger scheduled notifications

  "users": [
    {
      "distinct_id": "distinct_id", # unique identifier of the user
      # if $channels is present, communication will be triggered on mentioned channels only.
      # "$channels": ["email"],

      # User communication channel can be added as [optional]:
      # "$email":["[email protected]"],
      # "$whatsapp":["+15555555555"],
      # "$sms":["+15555555555"],
      # "$androidpush": [{"token": "__android_push_token__", "provider": "fcm", "device_id": ""}],  
      # "$iospush":[{"token": "__ios_push_token__", "provider": "apns", "device_id": ""}],
      # "$slack": {
      #  "email": "[email protected]",
      #  "access_token": "xoxb-XXXXXXXX"
      #}   --- slack using email

      # "$slack": {
      #  "user_id": "U/WXXXXXXXX",
      #  "access_token": "xoxb-XXXXXX"
      #} --- slack using member_id

      # "$slack": {
      #  "channel": "CXXXXXXXX",
      #  "access_token": "xoxb-XXXXXX"
      #} --- slack channel

      # "$slack": {
      #  "incoming_webhook": {
      #  "url": "https://hooks.slack.com/services/TXXXXXXXXX/BXXXXXXXX/XXXXXXXXXXXXXXXXXXX"
      # }
      #} --- slack incoming webhook
      
      # "$ms_teams": {
      #"tenant_id": "c1981ab2-9aaf-xxxx-xxxx",
			#"service_url": "https://smba.trafficmanager.net/amer",
			#"conversation_id": "19:c1524d7c-a06f-456f-8abe-xxxx"
      #} --- MS teams user or channel using conversation_id

      # "$ms_teams": {
      #"tenant_id": "c1981ab2-9aaf-xxxx-xxxx",
			#"service_url": "https://smba.trafficmanager.net/amer",
			#"user_id": "29:1nsLcmJ2RKtYH6Cxxxx-xxxx"
      #} --- MS teams user using user_id

      # "$ms_teams": {
      #  "incoming_webhook": {
      #  "url": "https://wnk1z.webhook.office.com/webhookb2/XXXXXXXXX"
      # }
      #} --- MS teams incoming webhook
    }
  ],

  # delivery instruction [optional]. how should notifications be sent, and whats the success metric
  "delivery": {
    "smart": <boolean_value>,
    "success": "success_metric",
    "time_to_live": "TTL duration", # will be applicable for smart = TRUE
    "mandatory_channels": [] # list of mandatory channels e.g ["email"], will be applicable for smart = TRUE
  },
  # data can be any json / serializable python-dictionary
  "data": {
    "key":"value",
    "nested_key": {
      "nested_key1": "some_value_1",
      "nested_key2": {
        "nested_key3": "some_value_3",
      },
    }
  }
}   
wf = Workflow(body=workflow_body, idempotency_key="__uniq_request_id__", brand_id="default")
# Trigger workflow
response = supr_client.trigger_workflow(wf)
print(response)

For configuring a workflow from backend, you can pass following properties in your method

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 eg. "2021-08-27T20:14:51.643Z"	Optional
`users`	Array object of target users. Atleast 1 user mandatory. `distinct_id` for each user mandatory. You can pass up to 100 entries in users array 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" } Further details are given in the below section	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](https://handlebarsjs.com/guide/)` language	"data": { "key": { "key": "value", "key": "value" } },	Optional
`brand_id`	Brand_id of the tenant to trigger notification on behalf of your tenants	string	Optional
`idempotency_key`	unique key in the request call for idempotent requests	string	Optional

👍
+CountryCode Required for SMS and Whatsapp
For setting $sms and $whatsapp, +<countrycode> is mandatory to send along with phone number. Eg: +1 for US

2878 — To find the template slug name on SuprSend platform, click on the clipboard icon on Templates page.
Templates > Template Details Page

Response structure

When you call supr_client.trigger_workflow, 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.

Note: The actual processing/execution of workflow happens asynchronously.

# Response structure
{
    "success": True, # if true, request was accepted.
    "status": "success",
    "status_code": 202, # http status code
    "message": "OK",
}

{
    "success": False, # error will be present in message
    "status": "fail",
    "status_code": 500, # http status code
    "message": "error message",
}

Once your request is accepted, you can check the status of your request in the ' SuprSend Logs' section.

Bulk API for triggering multiple workflows

Bulk API allows you to send multiple workflow requests in a single call. There isn't any limit on number-of-records that can be added to bulk_workflows instance.

Use .append() on bulk_workflows instance to add however-many-records to call in bulk.

from suprsend import Workflow

bulk_ins = supr_client.bulk_workflows.new_instance()

# one or more workflow instances
workflow1 = Workflow(body={...}) # body must be a proper workflow request json/dict
workflow2 = Workflow(body={...}) # body must be a proper workflow request json/dict

# --- use .append on bulk instance to add one or more records
bulk_ins.append(workflow1)
bulk_ins.append(workflow2)
# OR
bulk_ins.append(workflow1, workflow2)

# -------
response = bulk_ins.trigger()

print(response)

Response

Response is an instance of suprsend.BulkResponse class

# Response structure
from suprsend import BulkResponse

BulkResponse(
  status = "success",
  total = 10, # number of records sent in bulk
  success = 10, # number of records succeeded
  failure = 0, # number of records failed
  failed_records = []
)

BulkResponse(
  status = "fail",
  total = 10, # number of records sent in bulk
  success = 0, # number of records succeeded
  failure = 10, # number of records failed
  failed_records = [{"record": {...}, "error": "error_str", "code": 500}]
)

BulkResponse(
  status = "partial",
  total = 10, # number of records sent in bulk
  success = 6, # number of records succeeded
  failure = 4, # number of records failed
  failed_records = [{"record": {...}, "error": "error_str", "code": 500}]
)

Trigger Workflow from API

📘

Payload Schema

Sending notification to multiple recipients

📘
Use lists to broadcast to a large list of users

Identifying recipients inline

Add User Communication Channel

Sending cross-user notifications

Sending notification to anonymous user

Multi-tenant notifications

Idempotent requests

Response structure

Bulk API for triggering multiple workflows

Response

Add file attachment in email

🚧

Dynamic workflow trigger

👍
`+CountryCode` Required for SMS and Whatsapp

Response structure

Bulk API for triggering multiple workflows

Response

📘

Payload Schema

Sending notification to multiple recipients

📘Use lists to broadcast to a large list of users

Identifying recipients inline

Add User Communication Channel

Sending cross-user notifications

Sending notification to anonymous user

Multi-tenant notifications

Idempotent requests

Response structure

Bulk API for triggering multiple workflows

Response

Add file attachment in email

🚧

Dynamic workflow trigger

👍+CountryCode Required for SMS and Whatsapp

Response structure

Bulk API for triggering multiple workflows

Response

📘
Use lists to broadcast to a large list of users

👍
`+CountryCode` Required for SMS and Whatsapp