POST
/
businesses
/
{id}
/
triggers

Authorizations

Authorization
string
headerrequired

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

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
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
string
required

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

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

List triggers for a businessRetrieve a trigger