Create a trigger
curl --request POST \
--url https://api.pocketflows.com/businesses/{id}/triggers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"project_defined_event": "<string>",
"name": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"filter": "<string>",
"metadata": {},
"email_address": "<string>",
"phone_number": "<string>",
"excluded_customers": [
"<string>"
]
}
'import requests
url = "https://api.pocketflows.com/businesses/{id}/triggers"
payload = {
"project_defined_event": "<string>",
"name": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"filter": "<string>",
"metadata": {},
"email_address": "<string>",
"phone_number": "<string>",
"excluded_customers": ["<string>"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
project_defined_event: '<string>',
name: '<string>',
steps: [{type: 'email', email_template_id: '<string>', custom_step_id: '<string>'}],
filter: '<string>',
metadata: {},
email_address: '<string>',
phone_number: '<string>',
excluded_customers: ['<string>']
})
};
fetch('https://api.pocketflows.com/businesses/{id}/triggers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pocketflows.com/businesses/{id}/triggers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'project_defined_event' => '<string>',
'name' => '<string>',
'steps' => [
[
'type' => 'email',
'email_template_id' => '<string>',
'custom_step_id' => '<string>'
]
],
'filter' => '<string>',
'metadata' => [
],
'email_address' => '<string>',
'phone_number' => '<string>',
'excluded_customers' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pocketflows.com/businesses/{id}/triggers"
payload := strings.NewReader("{\n \"project_defined_event\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"filter\": \"<string>\",\n \"metadata\": {},\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"excluded_customers\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.pocketflows.com/businesses/{id}/triggers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"project_defined_event\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"filter\": \"<string>\",\n \"metadata\": {},\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"excluded_customers\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pocketflows.com/businesses/{id}/triggers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_defined_event\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"filter\": \"<string>\",\n \"metadata\": {},\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"excluded_customers\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"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,
"spam_reported": 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>"
}Triggers
Create a trigger
POST
/
businesses
/
{id}
/
triggers
Create a trigger
curl --request POST \
--url https://api.pocketflows.com/businesses/{id}/triggers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"project_defined_event": "<string>",
"name": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"filter": "<string>",
"metadata": {},
"email_address": "<string>",
"phone_number": "<string>",
"excluded_customers": [
"<string>"
]
}
'import requests
url = "https://api.pocketflows.com/businesses/{id}/triggers"
payload = {
"project_defined_event": "<string>",
"name": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"filter": "<string>",
"metadata": {},
"email_address": "<string>",
"phone_number": "<string>",
"excluded_customers": ["<string>"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
project_defined_event: '<string>',
name: '<string>',
steps: [{type: 'email', email_template_id: '<string>', custom_step_id: '<string>'}],
filter: '<string>',
metadata: {},
email_address: '<string>',
phone_number: '<string>',
excluded_customers: ['<string>']
})
};
fetch('https://api.pocketflows.com/businesses/{id}/triggers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pocketflows.com/businesses/{id}/triggers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'project_defined_event' => '<string>',
'name' => '<string>',
'steps' => [
[
'type' => 'email',
'email_template_id' => '<string>',
'custom_step_id' => '<string>'
]
],
'filter' => '<string>',
'metadata' => [
],
'email_address' => '<string>',
'phone_number' => '<string>',
'excluded_customers' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pocketflows.com/businesses/{id}/triggers"
payload := strings.NewReader("{\n \"project_defined_event\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"filter\": \"<string>\",\n \"metadata\": {},\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"excluded_customers\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.pocketflows.com/businesses/{id}/triggers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"project_defined_event\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"filter\": \"<string>\",\n \"metadata\": {},\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"excluded_customers\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pocketflows.com/businesses/{id}/triggers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_defined_event\": \"<string>\",\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"filter\": \"<string>\",\n \"metadata\": {},\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"excluded_customers\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"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,
"spam_reported": 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
Body
application/json
- Option 1
- Option 2
Response
200 - application/json
The created Trigger object