Learn how to send events to trigger workflows, with code snippets and examples.
You can send event to Suprsend platform by using the supr_client.track_event
method. When you call supr_client.track_event
, 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. The actual processing/execution of event happens asynchronously.
Parameter | Description | Format | Obligation |
---|---|---|---|
distinct_id | distinct_id of user performing the event | int, bigint, string, UUID | mandatory |
event_name | string identifier for the event like product_purchased | string | mandatory |
properties | a dictionary representing event attributes like first_name Event properties can be used to pass template variables in case of event based trigger | Dictionary | optional |
Event naming guidelines:
Event Name or Property Name should not start with or , as we have reserved these symbols for our internal events and property names.
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. You can use this key to track webhooks related to workflow notifications.
Idempotency key should be unique that you generate for each request. You may use any string up to 255 characters in length. Any space at start and end of the key will be trimmed.
Here are some common approaches for assigning idempotency keys:
user147-new-comment-1687437670
To add one or more Attachments to a Notification (viz. Email), you can just append the filepath of attachment to the event instance.
event.add_attachment()
for each file with an accessible URL.Please add public accessible URL only as attachment file otherwise it will throw an error 404 not found
and workflow will not be triggered
You can use Bulk API to send multiple events. Use .append()
on bulk_events instance to add however-many-records to call in bulk.
Bulk API is supported in SuprSend python-sdk version 0.2.0 and above. If you are using an older version, please upgrade to the latest SDK version.