This API call is still in beta phase. To learn more, please email support@sailthru.com
Create a transactional trigger for a valid template that is automatically executed in response to certain events on a given time
Currently, only 5 triggers per template are allowed. This is subject to increase in the future.
https://api.sailthru.com/trigger
| Parameter | Description | Example |
template | Name of the template | welcome-new-york-template |
| Parameter | Description | Example |
trigger_id | Trigger ID | 4e2f17e46803fa2847000000 |
When template parameter is used, all corresponding trigger(s) associated that template will be returned
| Field | Description | Example |
template | Name of the template | welcome-new-york-template |
triggers | List of trigger Items | |
Each trigger item has following structure
| Field | Description | Example |
trigger_id | Trigger ID | 4e2f17e46803fa2847000000 |
time | Trigger time | something like 10 mins 2 days 75 minutes |
event | Event | click or open or send or purchase |
zephyr | Zephyr Syntax | {api_send("template_name")} |
| Parameter | Description | Example |
executed | Show executed triggers | 1 |
| Parameter | Description | Example |
trigger_id | Trigger ID | 4e2f17e46803fa2847000000 |
When executed parameter is used, all executed triggers will be returned.
| Field | Description | Example |
triggers | List of trigger Items | |
Each trigger item has following structure
| Field | Description | Example |
trigger_id | Trigger ID | 4e2f17e46803fa2847000000 |
profile_id | Profile Id of a user | 4e40c53f030ed9876ee2f012 |
scheduled_time | When that trigger was scheduled | Thu, 06 Jan 2011 16:20:55 -0500 |
executed_time | When that trigger was executed | Thu, 06 Jan 2011 17:20:55 -0500 |
zephyr | Zephyr Syntax | {api_send("template_name")} |
| Parameter | Description | Example |
scheduled | Show scheduled triggers | 1 |
When scheduled parameter is used, all scheduled triggers will be returned.
| Parameter | Description | Example |
trigger_id | Trigger ID | 4e2f17e46803fa2847000000 |
| Field | Description | Example |
triggers | List of trigger Items | |
Each trigger item has following structure
| Field | Description | Example |
trigger_id | Trigger ID | 4e2f17e46803fa2847000000 |
profile_id | Profile Id of a user | 4e40c53f030ed9876ee2f012 |
scheduled_time | When that trigger was scheduled | Thu, 06 Jan 2011 16:20:55 -0500 |
zephyr | Zephyr Syntax | {api_send("template_name")} |
| Parameter | Description | Example |
template | Name of the template | welcome-new-york-template |
time | Trigger time, must be integer value | 10 |
time_unit | Trigger time unit | minutes or hours or days |
event | Event | click or open or send or purchase |
zephyr | Zephyr Syntax | {api_send("template_name")} |
Delete existing single trigger or all triggers for a template
| Parameter | Description | Example |
template | Name of the template | welcome-new-york-template |
| Parameter | Description | Example |
trigger_id | Trigger ID | 4e2f17e46803fa2847000000 |
if trigger_id parameter is not present, all triggers associated with the template will be deleted
