POpocketflows
Triggers

Create a trigger

Changed on
post/businesses/{id}/triggers

Request

Path parameters

idstring required

The ID of the business

Request body

OR

Response

The created Trigger object

idstring required

The ID of the trigger

created_atstring required

The time when the trigger was created in ISO 8601 format

updated_atstring required

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

namestring required

The name of the trigger

project_defined_eventstring nullable required

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

triggerstring nullable

Deprecated. Will always be null

status'draft' | 'active' | 'inactive' required

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

filterstring nullable required

An additional filter that determines if the trigger should be run

email_addressstring nullable 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_numberstring nullable 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

metadataobject required

Arbitrary metadata associated with this trigger

Changes

  • ac157ed1ba41Revision changes
    • warning

      added the new lead_captured enum value to the / response property for the response status

    • info

      added the new lead_captured enum value to the request property //