Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Workflows::Trigger

Create Trigger

Add a new trigger to a workflow. The event_type_key must be a valid workflow trigger event key — an invalid value returns 422. All condition FK fields accept the integer id or obfuscated public_id of a referenced resource in the same workspace/team scope.

post/workflows/{workflow_id}/triggers

Path parameters

workflow_idstring required

Integer id or obfuscated public_id of the workflow.

Request body

Example request

{
  "workflows_trigger": {
    "event_type_key": "$contact.tag_applied",
    "active": true,
    "contacts_tag_id": 7001
  }
}

Response

Created

idinteger

Trigger ID

public_idstring nullable

Obfuscated trigger ID

workflow_idinteger

Integer ID of the parent workflow

event_type_keystring nullable

The event that fires this trigger (e.g. $contact.tag_applied, $order.successful_purchase).

event_type_namestring nullable

Human-readable name of the event type.

activeboolean

Whether the trigger is active and will enroll contacts.

allow_anonymous_contactsboolean

Whether the trigger fires for anonymous (non-identified) contacts.

subscription_cancelation_reasonstring nullable

Only set on $order.cancelled (subscription cancellation) triggers — the cancellation-reason token the contact selected (e.g. too_expensive). null for every other event type.

contacts_tag_idinteger nullable

Raw integer Contacts::Tag id used as a condition filter.

funnel_idinteger nullable

Raw integer Funnel id used as a condition filter.

page_idinteger nullable

Raw integer Page id used as a condition filter.

product_idinteger nullable

Raw integer Product id used as a condition filter.

cancellation_product_idinteger nullable

Raw integer Product id for cancellation condition filtering.

product_variant_idinteger nullable

Raw integer Products::Variant id used as a condition filter.

cancellation_product_variant_idinteger nullable

Raw integer Products::Variant id for cancellation condition filtering.

subscription_variant_to_idinteger nullable

Raw integer Products::Variant id for subscription upgrade/downgrade triggers.

sales_pipelines_idinteger nullable

Raw integer Sales::Pipeline id used as a condition filter.

current_sales_pipelines_stage_idinteger nullable

Raw integer Sales::Pipelines::Stage id used as a condition filter.

appointments_calendar_idinteger nullable

Raw integer Appointments::Calendar id used as a condition filter.

appointments_event_type_idinteger nullable

Raw integer Appointments::EventType id used as a condition filter.

course_idinteger nullable

Raw integer Course id used as a condition filter.

courses_lesson_idinteger nullable

Raw integer Courses::Lesson id used as a condition filter.

courses_section_idinteger nullable

Raw integer Courses::Section id used as a condition filter.

community_idinteger nullable

Raw integer Community id used as a condition filter.

communities_space_idinteger nullable

Raw integer Communities::Space id used as a condition filter.

communities_space_group_idinteger nullable

Raw integer Communities::SpaceGroup id used as a condition filter.

emails_broadcasts_idinteger nullable

Raw integer Emails::Broadcast id used as a condition filter.

calendar_event_idinteger nullable

Raw integer CalendarEvent id used as a condition filter.

survey_workflow_idinteger nullable

Raw integer SurveyWorkflow id used as a condition filter.

workflows_step_idinteger nullable

Raw integer Workflows::Step id used as a condition filter.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": 11,
  "public_id": "TrXxYy",
  "workflow_id": 101,
  "event_type_key": "$contact.tag_applied",
  "event_type_name": "Contact tag applied",
  "active": true,
  "allow_anonymous_contacts": false,
  "subscription_cancelation_reason": null,
  "contacts_tag_id": 7001,
  "funnel_id": null,
  "page_id": null,
  "product_id": null,
  "cancellation_product_id": null,
  "product_variant_id": null,
  "cancellation_product_variant_id": null,
  "subscription_variant_to_id": null,
  "sales_pipelines_id": null,
  "current_sales_pipelines_stage_id": null,
  "appointments_calendar_id": null,
  "appointments_event_type_id": null,
  "course_id": null,
  "courses_lesson_id": null,
  "courses_section_id": null,
  "community_id": null,
  "communities_space_id": null,
  "communities_space_group_id": null,
  "emails_broadcasts_id": null,
  "calendar_event_id": null,
  "survey_workflow_id": null,
  "workflows_step_id": null,
  "created_at": "2025-06-01T00:00:00.000Z",
  "updated_at": "2025-06-01T00:00:00.000Z"
}