Endpoints
- GETList triggers for a business
- POSTCreate a trigger
- GETRetrieve a trigger
- POSTUpdate a trigger
- DELDelete a trigger
- GETView a trigger interactively
- POSTActivate a trigger
- POSTDeactivate a trigger
- POSTTest-send a trigger
- GETGet all variables associated with a trigger's steps
- GETGet the executions of a trigger
- POSTCreate a trigger draft from a trigger template
- GET
curl --request GET \
--url https://api.pocketflows.com/businesses/{id}/triggers \
--header 'Authorization: Basic <encoded-value>'{
"triggers": [
{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"name": "<string>",
"project_defined_event": "<string>",
"internal_event_definition": {
"type": "customer_created",
"segment": "<string>"
},
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"status": "draft",
"filter": "<string>",
"email_address": "<string>",
"phone_number": "<string>",
"attributed_revenue": 123,
"metadata": {},
"statistics": {
"emails": {
"sent": 123,
"delivered": 123,
"opened": 123,
"soft_bounced": 123,
"hard_bounced": 123,
"clicked": 123
},
"custom_steps": [
{
"custom_step": "<string>",
"sent": 123
}
],
"executions": {
"total": 123,
"pending": 123,
"started": 123,
"finished": 123,
"errored": 123
},
"sms": {
"sms_sent_count": 123,
"sms_sent_segments_count": 123,
"mms_sent_count": 123,
"mms_sent_segments_count": 123
},
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"trigger": "<string>"
}
]
}List triggers for a business
curl --request GET \
--url https://api.pocketflows.com/businesses/{id}/triggers \
--header 'Authorization: Basic <encoded-value>'{
"triggers": [
{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"name": "<string>",
"project_defined_event": "<string>",
"internal_event_definition": {
"type": "customer_created",
"segment": "<string>"
},
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"status": "draft",
"filter": "<string>",
"email_address": "<string>",
"phone_number": "<string>",
"attributed_revenue": 123,
"metadata": {},
"statistics": {
"emails": {
"sent": 123,
"delivered": 123,
"opened": 123,
"soft_bounced": 123,
"hard_bounced": 123,
"clicked": 123
},
"custom_steps": [
{
"custom_step": "<string>",
"sent": 123
}
],
"executions": {
"total": 123,
"pending": 123,
"started": 123,
"finished": 123,
"errored": 123
},
"sms": {
"sms_sent_count": 123,
"sms_sent_segments_count": 123,
"mms_sent_count": 123,
"mms_sent_segments_count": 123
},
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"trigger": "<string>"
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The ID of the business
Response
An object with a triggers key which contains an array of Trigger objects
An array of triggers
Show child attributes
Show child attributes
The ID of the trigger
The time when the trigger was created in ISO 8601 format
The time when the trigger was last updated in ISO 8601 format
The name of the trigger
The ID of the project-defined event that triggers the trigger
The internal event definition that triggers the trigger
Show child attributes
Show child attributes
The type of internal event definition. Must be either 'customer_created' or 'customer_joined_segment'
customer_created, customer_joined_segment The ID of the segment that the customer joined. Can only be provided with 'customer_joined_segment'
The steps of the trigger
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
The step type. Always "email" for this step
email The ID of the email template to use in this step
Optional. The ID of the custom step to use in this step. The type of the custom step must be "email" as well
The status of the trigger. One of "draft", "active", or "inactive"
draft, active, inactive An additional filter that determines if the trigger should be run
The ID of the email address or project email address associated with the trigger. Will be used to send emails as part of this trigger
The ID of the phone number or project phone number associated with the trigger. Will be used to send SMS messages as part of this trigger
The revenue attributed to the trigger
Arbitrary metadata associated with this trigger
The statistics of the trigger. Includes information about customers enrolled, email statistics, and custom step statistics
Show child attributes
Show child attributes
Email statistics including sent, delivered, opened, bounced, and clicked counts
Show child attributes
Show child attributes
The number of emails sent
The number of emails delivered
The number of emails opened
The number of emails that soft bounced
The number of emails that hard bounced
The number of emails clicked (null if tracking not enabled)
Execution statistics
Show child attributes
Show child attributes
Total number of executions
Number of pending executions
Number of started executions
Number of finished executions
Number of errored executions
SMS statistics
Show child attributes
Show child attributes
The number of SMS messages sent
The number of SMS messages segments
The number of MMS messages sent
The number of MMS messages segments
The number of customers enrolled in the campaign or trigger
The number of customers who have started receiving messages
The number of customers who have finished receiving all the messages
Deprecated. Will always be null