POST
/
businesses
/
{id}
/
triggers
curl --request POST \
  --url https://api.pocketflows.com/businesses/{id}/triggers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "trigger": "<string>",
  "filter": "<string>",
  "metadata": {},
  "steps": [
    {
      "type": "email",
      "custom_step_id": "<string>",
      "email_template_id": "<string>"
    }
  ],
  "email_address": "<string>",
  "phone_number": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "trigger": "<string>",
  "steps": [
    {
      "type": "email",
      "custom_step_id": "<string>",
      "email_template_id": "<string>"
    }
  ],
  "status": "draft",
  "filter": "<string>",
  "email_address": "<string>",
  "phone_number": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The ID of the business

Body

application/json
​
name
string
required

The name of the trigger

​
trigger
string
required

The event that triggers the trigger

​
steps
object[]
required

The steps of the trigger

​
project_defined_event
enum<string> | null

Must be null or not passed

​
filter
string | null

A further filter on the trigger

​
metadata
object | null

Metadata for the trigger

​
email_address
string | null

The ID of an email address or project email address. Will be used to send emails as part of this trigger

​
phone_number
string | null

The ID of a phone number or project phone number. Will be used to send SMS messages as part of this trigger

Response

200 - application/json
The created `Trigger` object
​
id
string
required

The ID of the trigger

​
name
string
required

The name of the trigger

​
trigger
string
required

The event that triggers the trigger

​
steps
object[]
required

The steps of the trigger

​
status
required

The status of the trigger. One of "draft", "active", or "inactive"

Available options:
draft
​
filter
string | null
required

An additional filter that determines if the trigger should be run

​
email_address
string | null
required

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

​
phone_number
string | null
required

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