curl --request POST \
--url https://api.pocketflows.com/triggers/{id}/activate \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.pocketflows.com/triggers/{id}/activate"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.pocketflows.com/triggers/{id}/activate', 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/triggers/{id}/activate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.pocketflows.com/triggers/{id}/activate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
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/triggers/{id}/activate")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pocketflows.com/triggers/{id}/activate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
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>"
}Activate a trigger
curl --request POST \
--url https://api.pocketflows.com/triggers/{id}/activate \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.pocketflows.com/triggers/{id}/activate"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.pocketflows.com/triggers/{id}/activate', 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/triggers/{id}/activate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.pocketflows.com/triggers/{id}/activate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
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/triggers/{id}/activate")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pocketflows.com/triggers/{id}/activate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
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
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 trigger
Response
A Trigger object
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 steps of the trigger
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
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
Deprecated. Will always be null