Skip to main content
id
string
required

The ID of the trigger

created_at
string
required

The time when the trigger was created in ISO 8601 format

updated_at
string
required

The time when the trigger was last updated in ISO 8601 format

name
string
required

The name of the trigger

project_defined_event
string | null
required

The ID of the project-defined event that triggers the trigger

internal_event_definition
object
required

The internal event definition that triggers the trigger

steps
object[]
required

The steps of the trigger

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
status
enum<string>
required

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

Available options:
draft,
active,
inactive
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

attributed_revenue
number | null
required

The revenue attributed to the trigger

statistics
object
required

The statistics of the trigger. Includes information about customers enrolled, email statistics, and custom step statistics

trigger
string | null

Deprecated. Will always be null

I