Skip to content

Trigger reference ​

Every trigger an automation can start from, with the values each one provides. Insert a value into any text setting by writing its name in double curly brackets, for example {{leadname}}. Conditions (Filter, If / else, Switch) compare the same values.

There are 158 triggers in 45 areas.

How to read this page ​

ColumnMeaning
ValueThe name to write between the curly brackets.
What it holdsThe label shown in the builder.
TypeDecides which comparisons a condition can use. See Conditions.
OptionsFor "One of a list" values: the exact values it can take.

Two kinds of trigger behave differently from the rest:

  • Daily checks. Marked "Daily check" below. Cashfin scans for the situation (an overdue invoice, low stock) instead of reacting to one edit. An automation runs at most once a day for the same record on these triggers.
  • Record triggers ("created", "updated", "deleted", "status changed"). They fire whoever made the change: a person in the dashboard, the API, an import, or another automation. An automation never re-triggers itself from its own step.

Appointments ​

Appointment type created ​

Trigger key: appointment_created

An appointment type is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{appointmentid}}Appointment type (id)ID
{{title}}TitleText
{{category}}CategoryText
{{duration}}Duration (minutes)Number
{{bookingurl}}Booking linkText
{{status}}StatusOne of a listactive, inactive, archived
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Appointment type deleted ​

Trigger key: appointment_deleted

An appointment type is deleted.

ValueWhat it holdsTypeOptions
{{appointmentid}}Appointment type (id)ID
{{title}}TitleText
{{category}}CategoryText
{{duration}}Duration (minutes)Number
{{bookingurl}}Booking linkText
{{status}}StatusOne of a listactive, inactive, archived
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Appointment type status changed ​

Trigger key: appointment_status_changed

An appointment type moves from one status to another.

ValueWhat it holdsTypeOptions
{{appointmentid}}Appointment type (id)ID
{{title}}TitleText
{{category}}CategoryText
{{duration}}Duration (minutes)Number
{{bookingurl}}Booking linkText
{{status}}StatusOne of a listactive, inactive, archived
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listactive, inactive, archived
{{tostatus}}To statusOne of a listactive, inactive, archived

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Appointment type updated ​

Trigger key: appointment_updated

An appointment type is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{appointmentid}}Appointment type (id)ID
{{title}}TitleText
{{category}}CategoryText
{{duration}}Duration (minutes)Number
{{bookingurl}}Booking linkText
{{status}}StatusOne of a listactive, inactive, archived
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Approvals ​

Approval approved ​

Trigger key: approval_approved

A document is fully approved.

ValueWhat it holdsTypeOptions
{{code}}CodeText
{{section}}SectionText
{{referencecode}}Record codeText
{{title}}TitleText
{{amount}}AmountNumber
{{level}}Approval levelText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Approval rejected ​

Trigger key: approval_rejected

A document is rejected.

ValueWhat it holdsTypeOptions
{{code}}CodeText
{{section}}SectionText
{{referencecode}}Record codeText
{{title}}TitleText
{{amount}}AmountNumber
{{level}}Approval levelText
{{reason}}ReasonText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Approval requested ​

Trigger key: approval_requested

A document is sent for approval.

ValueWhat it holdsTypeOptions
{{code}}CodeText
{{section}}SectionText
{{referencecode}}Record codeText
{{title}}TitleText
{{amount}}AmountNumber
{{level}}Approval levelText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Bills ​

Bill created ​

Trigger key: bill_created

A bill is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{billid}}Bill (id)ID
{{billno}}Bill numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{billdate}}Bill date (YYYY-MM-DD)Text
{{duedate}}Due date (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{accountid}}Account (id)ID
{{description}}DescriptionText
{{status}}StatusOne of a listdraft, approved, paid, partially_paid
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Bill deleted ​

Trigger key: bill_deleted

A bill is deleted.

ValueWhat it holdsTypeOptions
{{billid}}Bill (id)ID
{{billno}}Bill numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{billdate}}Bill date (YYYY-MM-DD)Text
{{duedate}}Due date (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{accountid}}Account (id)ID
{{description}}DescriptionText
{{status}}StatusOne of a listdraft, approved, paid, partially_paid
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Bill status changed ​

Trigger key: bill_status_changed

A bill moves from one status to another.

ValueWhat it holdsTypeOptions
{{billid}}Bill (id)ID
{{billno}}Bill numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{billdate}}Bill date (YYYY-MM-DD)Text
{{duedate}}Due date (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{accountid}}Account (id)ID
{{description}}DescriptionText
{{status}}StatusOne of a listdraft, approved, paid, partially_paid
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listdraft, approved, paid, partially_paid
{{tostatus}}To statusOne of a listdraft, approved, paid, partially_paid

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Bill updated ​

Trigger key: bill_updated

A bill is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{billid}}Bill (id)ID
{{billno}}Bill numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{billdate}}Bill date (YYYY-MM-DD)Text
{{duedate}}Due date (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{accountid}}Account (id)ID
{{description}}DescriptionText
{{status}}StatusOne of a listdraft, approved, paid, partially_paid
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Bookings ​

Booking created ​

Trigger key: booking_created

A booking is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{bookingid}}Booking (id)ID
{{title}}TitleText
{{type}}TypeText
{{priority}}PriorityText
{{starttime}}Starts (date and time)Text
{{endtime}}Ends (date and time)Text
{{timezone}}Time zoneText
{{amount}}AmountNumber
{{outcome}}OutcomeText
{{status}}StatusOne of a listscheduled, pending, confirmed, engaged, completed, no-show, canceled, rescheduled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Booking deleted ​

Trigger key: booking_deleted

A booking is deleted.

ValueWhat it holdsTypeOptions
{{bookingid}}Booking (id)ID
{{title}}TitleText
{{type}}TypeText
{{priority}}PriorityText
{{starttime}}Starts (date and time)Text
{{endtime}}Ends (date and time)Text
{{timezone}}Time zoneText
{{amount}}AmountNumber
{{outcome}}OutcomeText
{{status}}StatusOne of a listscheduled, pending, confirmed, engaged, completed, no-show, canceled, rescheduled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Booking status changed ​

Trigger key: booking_status_changed

A booking moves from one status to another.

ValueWhat it holdsTypeOptions
{{bookingid}}Booking (id)ID
{{title}}TitleText
{{type}}TypeText
{{priority}}PriorityText
{{starttime}}Starts (date and time)Text
{{endtime}}Ends (date and time)Text
{{timezone}}Time zoneText
{{amount}}AmountNumber
{{outcome}}OutcomeText
{{status}}StatusOne of a listscheduled, pending, confirmed, engaged, completed, no-show, canceled, rescheduled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusOne of a listscheduled, pending, confirmed, engaged, completed, no-show, canceled, rescheduled
{{tostatus}}To statusOne of a listscheduled, pending, confirmed, engaged, completed, no-show, canceled, rescheduled

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Booking updated ​

Trigger key: booking_updated

A booking is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{bookingid}}Booking (id)ID
{{title}}TitleText
{{type}}TypeText
{{priority}}PriorityText
{{starttime}}Starts (date and time)Text
{{endtime}}Ends (date and time)Text
{{timezone}}Time zoneText
{{amount}}AmountNumber
{{outcome}}OutcomeText
{{status}}StatusOne of a listscheduled, pending, confirmed, engaged, completed, no-show, canceled, rescheduled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Brands ​

Brand created ​

Trigger key: product_brand_created

A brand is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{brandid}}Brand (id)ID
{{title}}TitleText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Brand deleted ​

Trigger key: product_brand_deleted

A brand is deleted.

ValueWhat it holdsTypeOptions
{{brandid}}Brand (id)ID
{{title}}TitleText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Brand updated ​

Trigger key: product_brand_updated

A brand is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{brandid}}Brand (id)ID
{{title}}TitleText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Campaigns ​

Campaign created ​

Trigger key: campaign_created

A campaign is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{campaignid}}Campaign (id)ID
{{title}}TitleText
{{subject}}SubjectText
{{type}}TypeText
{{medium}}MediumText
{{recipientgroup}}Recipient groupText
{{templateid}}Template (id)ID
{{scheduledat}}Scheduled for (date and time)Text
{{nextsendat}}Next send (date and time)Text
{{lastsentat}}Last sent (date and time)Text
{{recipientscount}}RecipientsNumber
{{sentcount}}SentNumber
{{failedcount}}FailedNumber
{{status}}StatusOne of a listdraft, scheduled, sending, queued, running, completed, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Campaign deleted ​

Trigger key: campaign_deleted

A campaign is deleted.

ValueWhat it holdsTypeOptions
{{campaignid}}Campaign (id)ID
{{title}}TitleText
{{subject}}SubjectText
{{type}}TypeText
{{medium}}MediumText
{{recipientgroup}}Recipient groupText
{{templateid}}Template (id)ID
{{scheduledat}}Scheduled for (date and time)Text
{{nextsendat}}Next send (date and time)Text
{{lastsentat}}Last sent (date and time)Text
{{recipientscount}}RecipientsNumber
{{sentcount}}SentNumber
{{failedcount}}FailedNumber
{{status}}StatusOne of a listdraft, scheduled, sending, queued, running, completed, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Campaign status changed ​

Trigger key: campaign_status_changed

A campaign moves from one status to another.

ValueWhat it holdsTypeOptions
{{campaignid}}Campaign (id)ID
{{title}}TitleText
{{subject}}SubjectText
{{type}}TypeText
{{medium}}MediumText
{{recipientgroup}}Recipient groupText
{{templateid}}Template (id)ID
{{scheduledat}}Scheduled for (date and time)Text
{{nextsendat}}Next send (date and time)Text
{{lastsentat}}Last sent (date and time)Text
{{recipientscount}}RecipientsNumber
{{sentcount}}SentNumber
{{failedcount}}FailedNumber
{{status}}StatusOne of a listdraft, scheduled, sending, queued, running, completed, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listdraft, scheduled, sending, queued, running, completed, failed
{{tostatus}}To statusOne of a listdraft, scheduled, sending, queued, running, completed, failed

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Campaign updated ​

Trigger key: campaign_updated

A campaign is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{campaignid}}Campaign (id)ID
{{title}}TitleText
{{subject}}SubjectText
{{type}}TypeText
{{medium}}MediumText
{{recipientgroup}}Recipient groupText
{{templateid}}Template (id)ID
{{scheduledat}}Scheduled for (date and time)Text
{{nextsendat}}Next send (date and time)Text
{{lastsentat}}Last sent (date and time)Text
{{recipientscount}}RecipientsNumber
{{sentcount}}SentNumber
{{failedcount}}FailedNumber
{{status}}StatusOne of a listdraft, scheduled, sending, queued, running, completed, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Contacts ​

Contact created ​

Trigger key: contact_created

A contact is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{contactid}}Contact (id)ID
{{kind}}KindText
{{referenceid}}Customer, vendor or lead (id)ID
{{name}}NameText
{{firstname}}First nameText
{{lastname}}Last nameText
{{email}}EmailText
{{phone}}PhoneText
{{company}}CompanyText
{{source}}SourceText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Contact deleted ​

Trigger key: contact_deleted

A contact is deleted.

ValueWhat it holdsTypeOptions
{{contactid}}Contact (id)ID
{{kind}}KindText
{{referenceid}}Customer, vendor or lead (id)ID
{{name}}NameText
{{firstname}}First nameText
{{lastname}}Last nameText
{{email}}EmailText
{{phone}}PhoneText
{{company}}CompanyText
{{source}}SourceText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Contact updated ​

Trigger key: contact_updated

A contact is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{contactid}}Contact (id)ID
{{kind}}KindText
{{referenceid}}Customer, vendor or lead (id)ID
{{name}}NameText
{{firstname}}First nameText
{{lastname}}Last nameText
{{email}}EmailText
{{phone}}PhoneText
{{company}}CompanyText
{{source}}SourceText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Contracts ​

Contract created ​

Trigger key: contract_created

A contract is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{contractid}}Contract (id)ID
{{contractno}}Contract numberText
{{title}}TitleText
{{type}}TypeText
{{amount}}AmountNumber
{{starttime}}Starts (date and time)Text
{{endtime}}Ends (date and time)Text
{{status}}StatusOne of a listpublished, active, expired, canceled, draft
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Contract deleted ​

Trigger key: contract_deleted

A contract is deleted.

ValueWhat it holdsTypeOptions
{{contractid}}Contract (id)ID
{{contractno}}Contract numberText
{{title}}TitleText
{{type}}TypeText
{{amount}}AmountNumber
{{starttime}}Starts (date and time)Text
{{endtime}}Ends (date and time)Text
{{status}}StatusOne of a listpublished, active, expired, canceled, draft
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Contract status changed ​

Trigger key: contract_status_changed

A contract moves from one status to another.

ValueWhat it holdsTypeOptions
{{contractid}}Contract (id)ID
{{contractno}}Contract numberText
{{title}}TitleText
{{type}}TypeText
{{amount}}AmountNumber
{{starttime}}Starts (date and time)Text
{{endtime}}Ends (date and time)Text
{{status}}StatusOne of a listpublished, active, expired, canceled, draft
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusOne of a listpublished, active, expired, canceled, draft
{{tostatus}}To statusOne of a listpublished, active, expired, canceled, draft

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Contract updated ​

Trigger key: contract_updated

A contract is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{contractid}}Contract (id)ID
{{contractno}}Contract numberText
{{title}}TitleText
{{type}}TypeText
{{amount}}AmountNumber
{{starttime}}Starts (date and time)Text
{{endtime}}Ends (date and time)Text
{{status}}StatusOne of a listpublished, active, expired, canceled, draft
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Credit notes ​

Credit note created ​

Trigger key: credit_note_created

A credit note is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{creditnoteid}}Credit note (id)ID
{{creditnoteno}}Credit note numberText
{{title}}TitleText
{{invoiceid}}Invoice (id)ID
{{invoiceno}}Invoice numberText
{{kind}}KindText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{reason}}ReasonText
{{creditnotedate}}Credit note date (YYYY-MM-DD)Text
{{status}}StatusOne of a listissued
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Customers ​

Customer created ​

Trigger key: customer_created

A customer is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{customerid}}Customer (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{phone}}PhoneText
{{company}}CompanyText
{{type}}TypeText
{{country}}CountryText
{{city}}CityText
{{currency}}CurrencyText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Customer deleted ​

Trigger key: customer_deleted

A customer is deleted.

ValueWhat it holdsTypeOptions
{{customerid}}Customer (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{phone}}PhoneText
{{company}}CompanyText
{{type}}TypeText
{{country}}CountryText
{{city}}CityText
{{currency}}CurrencyText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Customer updated ​

Trigger key: customer_updated

A customer is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{customerid}}Customer (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{phone}}PhoneText
{{company}}CompanyText
{{type}}TypeText
{{country}}CountryText
{{city}}CityText
{{currency}}CurrencyText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Deals ​

Deal created ​

Trigger key: deal_created

A deal is opened.

ValueWhat it holdsTypeOptions
{{dealname}}Deal nameText
{{amount}}AmountNumber
{{source}}SourceText
{{stage}}StageText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Deal deleted ​

Trigger key: deal_deleted

A deal is deleted.

ValueWhat it holdsTypeOptions
{{dealid}}Deal (id)ID
{{dealname}}Deal nameText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{source}}SourceText
{{stage}}Stage (id)ID
{{probability}}ProbabilityNumber
{{status}}StatusOne of a listopen, won, lost
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Deal is rotting ​

Trigger key: deal_rotting · Daily check

Daily check: a deal has stayed in its stage longer than the stage allows.

ValueWhat it holdsTypeOptions
{{dealname}}Deal nameText
{{amount}}AmountNumber
{{source}}SourceText
{{stage}}StageText
{{daysinstage}}Days in stageNumber

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Deal lost ​

Trigger key: deal_lost

A deal is closed as lost.

ValueWhat it holdsTypeOptions
{{dealname}}Deal nameText
{{amount}}AmountNumber
{{source}}SourceText
{{reason}}ReasonText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Deal stage changed ​

Trigger key: deal_stage_changed

A deal moves to another pipeline stage.

ValueWhat it holdsTypeOptions
{{dealname}}Deal nameText
{{amount}}AmountNumber
{{source}}SourceText
{{fromstage}}From stageText
{{tostage}}To stageText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Deal updated ​

Trigger key: deal_updated

A deal is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{dealid}}Deal (id)ID
{{dealname}}Deal nameText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{source}}SourceText
{{stage}}Stage (id)ID
{{probability}}ProbabilityNumber
{{status}}StatusOne of a listopen, won, lost
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Deal won ​

Trigger key: deal_won

A deal is closed as won.

ValueWhat it holdsTypeOptions
{{dealname}}Deal nameText
{{amount}}AmountNumber
{{source}}SourceText
{{wonamount}}Won amountNumber

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Discounts ​

Discount created ​

Trigger key: discount_created

A discount is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{discountid}}Discount (id)ID
{{title}}TitleText
{{code}}CodeText
{{type}}TypeText
{{value}}ValueNumber
{{minimumamount}}Minimum amountNumber
{{usagelimit}}Usage limitNumber
{{usagecount}}Times usedNumber
{{startdate}}Starts (date and time)Text
{{enddate}}Ends (date and time)Text
{{status}}StatusOne of a listactive, scheduled, expired, disabled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Discount deleted ​

Trigger key: discount_deleted

A discount is deleted.

ValueWhat it holdsTypeOptions
{{discountid}}Discount (id)ID
{{title}}TitleText
{{code}}CodeText
{{type}}TypeText
{{value}}ValueNumber
{{minimumamount}}Minimum amountNumber
{{usagelimit}}Usage limitNumber
{{usagecount}}Times usedNumber
{{startdate}}Starts (date and time)Text
{{enddate}}Ends (date and time)Text
{{status}}StatusOne of a listactive, scheduled, expired, disabled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Discount status changed ​

Trigger key: discount_status_changed

A discount moves from one status to another.

ValueWhat it holdsTypeOptions
{{discountid}}Discount (id)ID
{{title}}TitleText
{{code}}CodeText
{{type}}TypeText
{{value}}ValueNumber
{{minimumamount}}Minimum amountNumber
{{usagelimit}}Usage limitNumber
{{usagecount}}Times usedNumber
{{startdate}}Starts (date and time)Text
{{enddate}}Ends (date and time)Text
{{status}}StatusOne of a listactive, scheduled, expired, disabled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listactive, scheduled, expired, disabled
{{tostatus}}To statusOne of a listactive, scheduled, expired, disabled

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Discount updated ​

Trigger key: discount_updated

A discount is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{discountid}}Discount (id)ID
{{title}}TitleText
{{code}}CodeText
{{type}}TypeText
{{value}}ValueNumber
{{minimumamount}}Minimum amountNumber
{{usagelimit}}Usage limitNumber
{{usagecount}}Times usedNumber
{{startdate}}Starts (date and time)Text
{{enddate}}Ends (date and time)Text
{{status}}StatusOne of a listactive, scheduled, expired, disabled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Disputes ​

Dispute created ​

Trigger key: dispute_created

A dispute is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{disputeid}}Dispute (id)ID
{{disputeno}}Dispute numberText
{{title}}TitleText
{{type}}TypeText
{{reason}}ReasonText
{{claimamount}}Claim amountNumber
{{currency}}CurrencyText
{{resolution}}ResolutionText
{{resolvedat}}Resolved (date and time)Text
{{status}}StatusOne of a listopen, under_review, resolved, rejected
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Dispute deleted ​

Trigger key: dispute_deleted

A dispute is deleted.

ValueWhat it holdsTypeOptions
{{disputeid}}Dispute (id)ID
{{disputeno}}Dispute numberText
{{title}}TitleText
{{type}}TypeText
{{reason}}ReasonText
{{claimamount}}Claim amountNumber
{{currency}}CurrencyText
{{resolution}}ResolutionText
{{resolvedat}}Resolved (date and time)Text
{{status}}StatusOne of a listopen, under_review, resolved, rejected
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Dispute status changed ​

Trigger key: dispute_status_changed

A dispute moves from one status to another.

ValueWhat it holdsTypeOptions
{{disputeid}}Dispute (id)ID
{{disputeno}}Dispute numberText
{{title}}TitleText
{{type}}TypeText
{{reason}}ReasonText
{{claimamount}}Claim amountNumber
{{currency}}CurrencyText
{{resolution}}ResolutionText
{{resolvedat}}Resolved (date and time)Text
{{status}}StatusOne of a listopen, under_review, resolved, rejected
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusOne of a listopen, under_review, resolved, rejected
{{tostatus}}To statusOne of a listopen, under_review, resolved, rejected

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Dispute updated ​

Trigger key: dispute_updated

A dispute is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{disputeid}}Dispute (id)ID
{{disputeno}}Dispute numberText
{{title}}TitleText
{{type}}TypeText
{{reason}}ReasonText
{{claimamount}}Claim amountNumber
{{currency}}CurrencyText
{{resolution}}ResolutionText
{{resolvedat}}Resolved (date and time)Text
{{status}}StatusOne of a listopen, under_review, resolved, rejected
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Documents ​

Document created ​

Trigger key: document_created

A document is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{documentid}}Document (id)ID
{{title}}TitleText
{{description}}DescriptionText
{{status}}StatusText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Document deleted ​

Trigger key: document_deleted

A document is deleted.

ValueWhat it holdsTypeOptions
{{documentid}}Document (id)ID
{{title}}TitleText
{{description}}DescriptionText
{{status}}StatusText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Document status changed ​

Trigger key: document_status_changed

A document moves from one status to another.

ValueWhat it holdsTypeOptions
{{documentid}}Document (id)ID
{{title}}TitleText
{{description}}DescriptionText
{{status}}StatusText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusText
{{tostatus}}To statusText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Document updated ​

Trigger key: document_updated

A document is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{documentid}}Document (id)ID
{{title}}TitleText
{{description}}DescriptionText
{{status}}StatusText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Expenses ​

Expense created ​

Trigger key: expense_created

An expense is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{expenseid}}Expense (id)ID
{{title}}TitleText
{{amount}}AmountNumber
{{expensedate}}Expense date (YYYY-MM-DD)Text
{{duedate}}Due date (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{accountid}}Account (id)ID
{{description}}DescriptionText
{{status}}StatusOne of a listdraft, approved, paid
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Expense deleted ​

Trigger key: expense_deleted

An expense is deleted.

ValueWhat it holdsTypeOptions
{{expenseid}}Expense (id)ID
{{title}}TitleText
{{amount}}AmountNumber
{{expensedate}}Expense date (YYYY-MM-DD)Text
{{duedate}}Due date (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{accountid}}Account (id)ID
{{description}}DescriptionText
{{status}}StatusOne of a listdraft, approved, paid
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Expense status changed ​

Trigger key: expense_status_changed

An expense moves from one status to another.

ValueWhat it holdsTypeOptions
{{expenseid}}Expense (id)ID
{{title}}TitleText
{{amount}}AmountNumber
{{expensedate}}Expense date (YYYY-MM-DD)Text
{{duedate}}Due date (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{accountid}}Account (id)ID
{{description}}DescriptionText
{{status}}StatusOne of a listdraft, approved, paid
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listdraft, approved, paid
{{tostatus}}To statusOne of a listdraft, approved, paid

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Expense updated ​

Trigger key: expense_updated

An expense is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{expenseid}}Expense (id)ID
{{title}}TitleText
{{amount}}AmountNumber
{{expensedate}}Expense date (YYYY-MM-DD)Text
{{duedate}}Due date (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{accountid}}Account (id)ID
{{description}}DescriptionText
{{status}}StatusOne of a listdraft, approved, paid
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Files ​

File uploaded ​

Trigger key: file_uploaded

A picture, document or other file is uploaded to the business's media.

ValueWhat it holdsTypeOptions
{{mediaid}}File IDID
{{fileurl}}File linkText
{{filename}}File nameText
{{filetype}}File typeOne of a listimage, pdf, spreadsheet, video, other
{{format}}FormatText
{{bytes}}Size (bytes)Number
{{source}}SourceText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Inventory ​

Stock is low ​

Trigger key: stock_low · Daily check

A product or variant falls to or below its reorder point.

ValueWhat it holdsTypeOptions
{{product}}ProductText
{{stock}}Stock leftNumber
{{reorderpoint}}Reorder pointNumber

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Invoices ​

Invoice created ​

Trigger key: invoice_created

An invoice is created: from the dashboard, the API, a quote, an order or a subscription.

ValueWhat it holdsTypeOptions
{{invoiceid}}Invoice (id)ID
{{invoiceno}}Invoice numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{status}}StatusOne of a listdraft, not_sent, unpaid, partially_paid, overdue, paid, canceled, credited
{{duedate}}Due date (YYYY-MM-DD)Text
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Invoice is overdue ​

Trigger key: invoice_overdue · Daily check

Daily check: an invoice is past its due date with a balance.

ValueWhat it holdsTypeOptions
{{invoiceno}}Invoice numberText
{{title}}TitleText
{{balance}}BalanceNumber
{{dayspastdue}}Days past dueNumber

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Invoice status changed ​

Trigger key: invoice_status_changed

An invoice moves to another status (paid, partially paid, canceled, credited...).

ValueWhat it holdsTypeOptions
{{invoiceid}}Invoice (id)ID
{{invoiceno}}Invoice numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{status}}StatusOne of a listdraft, not_sent, unpaid, partially_paid, overdue, paid, canceled, credited
{{duedate}}Due date (YYYY-MM-DD)Text
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusOne of a listdraft, not_sent, unpaid, partially_paid, overdue, paid, canceled, credited
{{tostatus}}To statusOne of a listdraft, not_sent, unpaid, partially_paid, overdue, paid, canceled, credited

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Invoice updated ​

Trigger key: invoice_updated

An invoice is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{invoiceid}}Invoice (id)ID
{{invoiceno}}Invoice numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{duedate}}Due date (YYYY-MM-DD)Text
{{status}}StatusOne of a listdraft, not_sent, unpaid, partially_paid, overdue, paid, canceled, credited
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Job cards ​

Job card created ​

Trigger key: job_card_created

A job card is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{jobcardid}}Job card (id)ID
{{cardno}}Card numberText
{{title}}TitleText
{{productionid}}Production order (id)ID
{{outputqty}}QuantityNumber
{{currentstagekey}}Current stageText
{{status}}StatusOne of a listopen, complete, cancelled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Job card status changed ​

Trigger key: job_card_status_changed

A job card moves from one status to another.

ValueWhat it holdsTypeOptions
{{jobcardid}}Job card (id)ID
{{cardno}}Card numberText
{{title}}TitleText
{{productionid}}Production order (id)ID
{{outputqty}}QuantityNumber
{{currentstagekey}}Current stageText
{{status}}StatusOne of a listopen, complete, cancelled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listopen, complete, cancelled
{{tostatus}}To statusOne of a listopen, complete, cancelled

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Job card updated ​

Trigger key: job_card_updated

A job card is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{jobcardid}}Job card (id)ID
{{cardno}}Card numberText
{{title}}TitleText
{{productionid}}Production order (id)ID
{{outputqty}}QuantityNumber
{{currentstagekey}}Current stageText
{{status}}StatusOne of a listopen, complete, cancelled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Leads ​

Lead assigned ​

Trigger key: lead_assigned

A lead gets a new owner, automatically or by a person.

ValueWhat it holdsTypeOptions
{{leadname}}Lead nameText
{{company}}CompanyText
{{source}}SourceText
{{budget}}BudgetNumber
{{assignee}}Assignee (id)ID
{{assigneename}}AssigneeText

Not available on this trigger: Complete the task.

Lead converted ​

Trigger key: lead_converted

A lead becomes a customer.

ValueWhat it holdsTypeOptions
{{leadname}}Lead nameText
{{company}}CompanyText
{{source}}SourceText
{{budget}}BudgetNumber
{{customername}}Customer nameText

Not available on this trigger: Complete the task.

Lead created ​

Trigger key: lead_created

A lead is added from the dashboard, a form, the API or an import.

ValueWhat it holdsTypeOptions
{{leadname}}Lead nameText
{{company}}CompanyText
{{source}}SourceText
{{status}}StatusOne of a listnew, contacted, qualified, unqualified, converted, lost
{{budget}}BudgetNumber

Not available on this trigger: Complete the task.

Lead deleted ​

Trigger key: lead_deleted

A lead is deleted.

ValueWhat it holdsTypeOptions
{{leadid}}Lead (id)ID
{{leadname}}Lead nameText
{{company}}CompanyText
{{source}}SourceText
{{budget}}BudgetNumber
{{email}}EmailText
{{phone}}PhoneText
{{status}}StatusOne of a listnew, contacted, qualified, unqualified, converted, lost
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Assign owner, Complete the task.

Lead first-response SLA breached ​

Trigger key: lead_sla_breached · Daily check

Hourly check: a lead had no first contact within the configured hours.

ValueWhat it holdsTypeOptions
{{leadname}}Lead nameText
{{company}}CompanyText
{{source}}SourceText
{{budget}}BudgetNumber
{{hoursopen}}Hours openNumber

Not available on this trigger: Complete the task.

Lead is idle ​

Trigger key: lead_idle · Daily check

Daily check: an open lead has not been touched for the configured days.

ValueWhat it holdsTypeOptions
{{leadname}}Lead nameText
{{company}}CompanyText
{{source}}SourceText
{{budget}}BudgetNumber
{{idledays}}Days idleNumber

Not available on this trigger: Complete the task.

Lead lost ​

Trigger key: lead_lost

A lead is closed as lost.

ValueWhat it holdsTypeOptions
{{leadname}}Lead nameText
{{company}}CompanyText
{{source}}SourceText
{{budget}}BudgetNumber
{{outcome}}OutcomeText
{{reason}}ReasonText

Not available on this trigger: Complete the task.

Lead status changed ​

Trigger key: lead_status_changed

A lead moves from one status to another.

ValueWhat it holdsTypeOptions
{{leadname}}Lead nameText
{{company}}CompanyText
{{source}}SourceText
{{budget}}BudgetNumber
{{fromstatus}}From statusOne of a listnew, contacted, qualified, unqualified, converted, lost
{{tostatus}}To statusOne of a listnew, contacted, qualified, unqualified, converted, lost

Not available on this trigger: Complete the task.

Lead updated ​

Trigger key: lead_updated

A lead is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{leadid}}Lead (id)ID
{{leadname}}Lead nameText
{{company}}CompanyText
{{source}}SourceText
{{budget}}BudgetNumber
{{email}}EmailText
{{phone}}PhoneText
{{status}}StatusOne of a listnew, contacted, qualified, unqualified, converted, lost
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task.

Lists ​

List created ​

Trigger key: list_created

A list is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{listid}}List (id)ID
{{name}}NameText
{{description}}DescriptionText
{{type}}TypeText
{{status}}StatusOne of a listactive
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

List deleted ​

Trigger key: list_deleted

A list is deleted.

ValueWhat it holdsTypeOptions
{{listid}}List (id)ID
{{name}}NameText
{{description}}DescriptionText
{{type}}TypeText
{{status}}StatusOne of a listactive
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

List entry created ​

Trigger key: list_entry_created

A list entry is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{contactid}}List entry (id)ID
{{listid}}List (id)ID
{{name}}NameText
{{firstname}}First nameText
{{lastname}}Last nameText
{{email}}EmailText
{{phone}}PhoneText
{{company}}CompanyText
{{source}}SourceText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

List entry deleted ​

Trigger key: list_entry_deleted

A list entry is deleted.

ValueWhat it holdsTypeOptions
{{contactid}}List entry (id)ID
{{listid}}List (id)ID
{{name}}NameText
{{firstname}}First nameText
{{lastname}}Last nameText
{{email}}EmailText
{{phone}}PhoneText
{{company}}CompanyText
{{source}}SourceText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

List entry updated ​

Trigger key: list_entry_updated

A list entry is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{contactid}}List entry (id)ID
{{listid}}List (id)ID
{{name}}NameText
{{firstname}}First nameText
{{lastname}}Last nameText
{{email}}EmailText
{{phone}}PhoneText
{{company}}CompanyText
{{source}}SourceText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

List updated ​

Trigger key: list_updated

A list is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{listid}}List (id)ID
{{name}}NameText
{{description}}DescriptionText
{{type}}TypeText
{{status}}StatusOne of a listactive
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Messages ​

Message created ​

Trigger key: message_created

A message is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{messageid}}Message (id)ID
{{channel}}ChannelText
{{direction}}DirectionText
{{recipient}}RecipientText
{{body}}MessageText
{{errormessage}}ErrorText
{{sentat}}Sent (date and time)Text
{{status}}StatusOne of a listqueued, sent, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Message deleted ​

Trigger key: message_deleted

A message is deleted.

ValueWhat it holdsTypeOptions
{{messageid}}Message (id)ID
{{channel}}ChannelText
{{direction}}DirectionText
{{recipient}}RecipientText
{{body}}MessageText
{{errormessage}}ErrorText
{{sentat}}Sent (date and time)Text
{{status}}StatusOne of a listqueued, sent, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Trigger key: payment_link_created

A payment link is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{paymentlinkid}}Payment link (id)ID
{{title}}TitleText
{{type}}TypeText
{{section}}SectionText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{shorturl}}Short link codeText
{{status}}StatusOne of a listpublished, unpaid, pending, partially_paid, paid, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Trigger key: payment_link_deleted

A payment link is deleted.

ValueWhat it holdsTypeOptions
{{paymentlinkid}}Payment link (id)ID
{{title}}TitleText
{{type}}TypeText
{{section}}SectionText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{shorturl}}Short link codeText
{{status}}StatusOne of a listpublished, unpaid, pending, partially_paid, paid, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Trigger key: payment_link_status_changed

A payment link moves from one status to another.

ValueWhat it holdsTypeOptions
{{paymentlinkid}}Payment link (id)ID
{{title}}TitleText
{{type}}TypeText
{{section}}SectionText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{shorturl}}Short link codeText
{{status}}StatusOne of a listpublished, unpaid, pending, partially_paid, paid, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusOne of a listpublished, unpaid, pending, partially_paid, paid, canceled
{{tostatus}}To statusOne of a listpublished, unpaid, pending, partially_paid, paid, canceled

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Trigger key: payment_link_updated

A payment link is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{paymentlinkid}}Payment link (id)ID
{{title}}TitleText
{{type}}TypeText
{{section}}SectionText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{shorturl}}Short link codeText
{{status}}StatusOne of a listpublished, unpaid, pending, partially_paid, paid, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Payments ​

Payment failed ​

Trigger key: payment_failed

An incoming payment fails.

ValueWhat it holdsTypeOptions
{{amount}}AmountNumber
{{reference}}ReferenceText
{{title}}TitleText
{{code}}CodeText
{{method}}MethodOne of a listmpesa, bank, link, cashfin, external, offline
{{currency}}CurrencyText
{{section}}SectionText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Payment received ​

Trigger key: payment_received

An incoming payment succeeds.

ValueWhat it holdsTypeOptions
{{amount}}AmountNumber
{{reference}}ReferenceText
{{title}}TitleText
{{code}}CodeText
{{method}}MethodOne of a listmpesa, bank, link, cashfin, external, offline
{{currency}}CurrencyText
{{section}}SectionText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Payouts ​

Payout failed ​

Trigger key: payout_failed

A payout run finishes with at least one failed recipient.

ValueWhat it holdsTypeOptions
{{code}}CodeText
{{title}}TitleText
{{amount}}AmountNumber
{{reason}}ReasonText
{{reasonlabel}}Reason (label)Text
{{method}}MethodOne of a listmpesa, bank, link, cashfin, external, offline
{{recipients}}RecipientsNumber
{{sent}}SentNumber
{{failed}}FailedNumber
{{error}}ErrorText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Payout sent ​

Trigger key: payout_sent

A payout run finishes with every recipient paid.

ValueWhat it holdsTypeOptions
{{code}}CodeText
{{title}}TitleText
{{amount}}AmountNumber
{{reason}}ReasonText
{{reasonlabel}}Reason (label)Text
{{method}}MethodOne of a listmpesa, bank, link, cashfin, external, offline
{{recipients}}RecipientsNumber
{{sent}}SentNumber

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Process workflows ​

Process completed ​

Trigger key: workflow_completed

Every step of a process workflow is completed on a record.

ValueWhat it holdsTypeOptions
{{section}}SectionText
{{workflow}}Process workflowText
{{referencecode}}Record codeText
{{title}}TitleText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Process step completed ​

Trigger key: workflow_step_completed

A step of a process workflow is completed on a record.

ValueWhat it holdsTypeOptions
{{section}}SectionText
{{workflow}}Process workflowText
{{step}}StepText
{{stepkey}}Step keyText
{{referencecode}}Record codeText
{{title}}TitleText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Product categories ​

Product category created ​

Trigger key: product_category_created

A product category is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{categoryid}}Category (id)ID
{{title}}TitleText
{{slug}}SlugText
{{parentid}}Parent category (id)ID
{{status}}StatusOne of a listactive, inactive
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Product category deleted ​

Trigger key: product_category_deleted

A product category is deleted.

ValueWhat it holdsTypeOptions
{{categoryid}}Category (id)ID
{{title}}TitleText
{{slug}}SlugText
{{parentid}}Parent category (id)ID
{{status}}StatusOne of a listactive, inactive
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Product category status changed ​

Trigger key: product_category_status_changed

A product category moves from one status to another.

ValueWhat it holdsTypeOptions
{{categoryid}}Category (id)ID
{{title}}TitleText
{{slug}}SlugText
{{parentid}}Parent category (id)ID
{{status}}StatusOne of a listactive, inactive
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listactive, inactive
{{tostatus}}To statusOne of a listactive, inactive

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Product category updated ​

Trigger key: product_category_updated

A product category is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{categoryid}}Category (id)ID
{{title}}TitleText
{{slug}}SlugText
{{parentid}}Parent category (id)ID
{{status}}StatusOne of a listactive, inactive
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Product reviews ​

Product review created ​

Trigger key: product_review_created

A product review is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{reviewid}}Review (id)ID
{{productid}}Product (id)ID
{{producttitle}}ProductText
{{reviewername}}Reviewer nameText
{{revieweremail}}Reviewer emailText
{{stars}}StarsNumber
{{title}}TitleText
{{content}}ReviewText
{{reply}}ReplyText
{{status}}StatusOne of a listapproved, pending, rejected
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Production orders ​

Production order created ​

Trigger key: production_order_created

A production order is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{productionorderid}}Production order (id)ID
{{orderno}}Order numberText
{{title}}TitleText
{{outputproductid}}Product made (id)ID
{{outputqty}}QuantityNumber
{{outputunit}}UnitText
{{stockstatus}}Stock statusText
{{plannedstart}}Planned start (date and time)Text
{{plannedend}}Planned end (date and time)Text
{{actualstart}}Started (date and time)Text
{{actualend}}Finished (date and time)Text
{{status}}StatusOne of a listdraft, planned, in_progress, completed, cancelled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Production order status changed ​

Trigger key: production_order_status_changed

A production order moves from one status to another.

ValueWhat it holdsTypeOptions
{{productionorderid}}Production order (id)ID
{{orderno}}Order numberText
{{title}}TitleText
{{outputproductid}}Product made (id)ID
{{outputqty}}QuantityNumber
{{outputunit}}UnitText
{{stockstatus}}Stock statusText
{{plannedstart}}Planned start (date and time)Text
{{plannedend}}Planned end (date and time)Text
{{actualstart}}Started (date and time)Text
{{actualend}}Finished (date and time)Text
{{status}}StatusOne of a listdraft, planned, in_progress, completed, cancelled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listdraft, planned, in_progress, completed, cancelled
{{tostatus}}To statusOne of a listdraft, planned, in_progress, completed, cancelled

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Production order updated ​

Trigger key: production_order_updated

A production order is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{productionorderid}}Production order (id)ID
{{orderno}}Order numberText
{{title}}TitleText
{{outputproductid}}Product made (id)ID
{{outputqty}}QuantityNumber
{{outputunit}}UnitText
{{stockstatus}}Stock statusText
{{plannedstart}}Planned start (date and time)Text
{{plannedend}}Planned end (date and time)Text
{{actualstart}}Started (date and time)Text
{{actualend}}Finished (date and time)Text
{{status}}StatusOne of a listdraft, planned, in_progress, completed, cancelled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Products ​

Product created ​

Trigger key: product_created

A product is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{productid}}Product (id)ID
{{title}}TitleText
{{sku}}SKUText
{{type}}TypeText
{{price}}PriceNumber
{{compareatprice}}Compare-at priceNumber
{{costprice}}Cost priceNumber
{{stock}}StockNumber
{{reorderpoint}}Reorder pointNumber
{{categoryid}}Category (id)ID
{{brandid}}Brand (id)ID
{{status}}StatusOne of a listpublished, draft
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Product deleted ​

Trigger key: product_deleted

A product is deleted.

ValueWhat it holdsTypeOptions
{{productid}}Product (id)ID
{{title}}TitleText
{{sku}}SKUText
{{type}}TypeText
{{price}}PriceNumber
{{compareatprice}}Compare-at priceNumber
{{costprice}}Cost priceNumber
{{stock}}StockNumber
{{reorderpoint}}Reorder pointNumber
{{categoryid}}Category (id)ID
{{brandid}}Brand (id)ID
{{status}}StatusOne of a listpublished, draft
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Product status changed ​

Trigger key: product_status_changed

A product moves from one status to another.

ValueWhat it holdsTypeOptions
{{productid}}Product (id)ID
{{title}}TitleText
{{sku}}SKUText
{{type}}TypeText
{{price}}PriceNumber
{{compareatprice}}Compare-at priceNumber
{{costprice}}Cost priceNumber
{{stock}}StockNumber
{{reorderpoint}}Reorder pointNumber
{{categoryid}}Category (id)ID
{{brandid}}Brand (id)ID
{{status}}StatusOne of a listpublished, draft
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listpublished, draft
{{tostatus}}To statusOne of a listpublished, draft

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Product updated ​

Trigger key: product_updated

A product is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{productid}}Product (id)ID
{{title}}TitleText
{{sku}}SKUText
{{type}}TypeText
{{price}}PriceNumber
{{compareatprice}}Compare-at priceNumber
{{costprice}}Cost priceNumber
{{stock}}StockNumber
{{reorderpoint}}Reorder pointNumber
{{categoryid}}Category (id)ID
{{brandid}}Brand (id)ID
{{status}}StatusOne of a listpublished, draft
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Projects ​

Project created ​

Trigger key: project_created

A project is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{projectid}}Project (id)ID
{{customerid}}Customer (id)ID
{{title}}TitleText
{{billtype}}Billing typeText
{{rate}}RateNumber
{{estimatedtime}}Estimated timeNumber
{{percentage}}ProgressNumber
{{startdate}}Starts (date and time)Text
{{deadline}}Deadline (date and time)Text
{{completeddate}}Completed (date and time)Text
{{status}}StatusOne of a listactive, pending, completed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Project deleted ​

Trigger key: project_deleted

A project is deleted.

ValueWhat it holdsTypeOptions
{{projectid}}Project (id)ID
{{customerid}}Customer (id)ID
{{title}}TitleText
{{billtype}}Billing typeText
{{rate}}RateNumber
{{estimatedtime}}Estimated timeNumber
{{percentage}}ProgressNumber
{{startdate}}Starts (date and time)Text
{{deadline}}Deadline (date and time)Text
{{completeddate}}Completed (date and time)Text
{{status}}StatusOne of a listactive, pending, completed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Project status changed ​

Trigger key: project_status_changed

A project moves from one status to another.

ValueWhat it holdsTypeOptions
{{projectid}}Project (id)ID
{{customerid}}Customer (id)ID
{{title}}TitleText
{{billtype}}Billing typeText
{{rate}}RateNumber
{{estimatedtime}}Estimated timeNumber
{{percentage}}ProgressNumber
{{startdate}}Starts (date and time)Text
{{deadline}}Deadline (date and time)Text
{{completeddate}}Completed (date and time)Text
{{status}}StatusOne of a listactive, pending, completed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusOne of a listactive, pending, completed
{{tostatus}}To statusOne of a listactive, pending, completed

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Project updated ​

Trigger key: project_updated

A project is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{projectid}}Project (id)ID
{{customerid}}Customer (id)ID
{{title}}TitleText
{{billtype}}Billing typeText
{{rate}}RateNumber
{{estimatedtime}}Estimated timeNumber
{{percentage}}ProgressNumber
{{startdate}}Starts (date and time)Text
{{deadline}}Deadline (date and time)Text
{{completeddate}}Completed (date and time)Text
{{status}}StatusOne of a listactive, pending, completed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Purchase orders ​

Purchase order created ​

Trigger key: purchase_order_created

A purchase order is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{purchaseorderid}}Purchase order (id)ID
{{orderno}}Order numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{receivedstatus}}Received statusText
{{orderdate}}Order date (YYYY-MM-DD)Text
{{expecteddeliverydate}}Expected delivery (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{status}}StatusText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Purchase order deleted ​

Trigger key: purchase_order_deleted

A purchase order is deleted.

ValueWhat it holdsTypeOptions
{{purchaseorderid}}Purchase order (id)ID
{{orderno}}Order numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{receivedstatus}}Received statusText
{{orderdate}}Order date (YYYY-MM-DD)Text
{{expecteddeliverydate}}Expected delivery (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{status}}StatusText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Purchase order status changed ​

Trigger key: purchase_order_status_changed

A purchase order moves from one status to another.

ValueWhat it holdsTypeOptions
{{purchaseorderid}}Purchase order (id)ID
{{orderno}}Order numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{receivedstatus}}Received statusText
{{orderdate}}Order date (YYYY-MM-DD)Text
{{expecteddeliverydate}}Expected delivery (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{status}}StatusText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusText
{{tostatus}}To statusText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Purchase order updated ​

Trigger key: purchase_order_updated

A purchase order is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{purchaseorderid}}Purchase order (id)ID
{{orderno}}Order numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{receivedstatus}}Received statusText
{{orderdate}}Order date (YYYY-MM-DD)Text
{{expecteddeliverydate}}Expected delivery (YYYY-MM-DD)Text
{{vendorid}}Vendor (id)ID
{{status}}StatusText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Purchase requisitions ​

Purchase requisition created ​

Trigger key: purchase_requisition_created

A purchase requisition is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{requisitionid}}Requisition (id)ID
{{requisitionno}}Requisition numberText
{{title}}TitleText
{{description}}ReasonText
{{priority}}PriorityText
{{neededby}}Needed by (YYYY-MM-DD)Text
{{amount}}AmountNumber
{{currency}}CurrencyText
{{vendorid}}Vendor (id)ID
{{requestedby}}Requested by (id)ID
{{rejectionreason}}Rejection reasonText
{{submittedat}}Submitted (date and time)Text
{{approvedat}}Approved (date and time)Text
{{status}}StatusOne of a listdraft, pending_approval, approved, rejected, partially_ordered, ordered, closed, cancelled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Purchase requisition deleted ​

Trigger key: purchase_requisition_deleted

A purchase requisition is deleted.

ValueWhat it holdsTypeOptions
{{requisitionid}}Requisition (id)ID
{{requisitionno}}Requisition numberText
{{title}}TitleText
{{description}}ReasonText
{{priority}}PriorityText
{{neededby}}Needed by (YYYY-MM-DD)Text
{{amount}}AmountNumber
{{currency}}CurrencyText
{{vendorid}}Vendor (id)ID
{{requestedby}}Requested by (id)ID
{{rejectionreason}}Rejection reasonText
{{submittedat}}Submitted (date and time)Text
{{approvedat}}Approved (date and time)Text
{{status}}StatusOne of a listdraft, pending_approval, approved, rejected, partially_ordered, ordered, closed, cancelled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Purchase requisition status changed ​

Trigger key: purchase_requisition_status_changed

A purchase requisition moves from one status to another.

ValueWhat it holdsTypeOptions
{{requisitionid}}Requisition (id)ID
{{requisitionno}}Requisition numberText
{{title}}TitleText
{{description}}ReasonText
{{priority}}PriorityText
{{neededby}}Needed by (YYYY-MM-DD)Text
{{amount}}AmountNumber
{{currency}}CurrencyText
{{vendorid}}Vendor (id)ID
{{requestedby}}Requested by (id)ID
{{rejectionreason}}Rejection reasonText
{{submittedat}}Submitted (date and time)Text
{{approvedat}}Approved (date and time)Text
{{status}}StatusOne of a listdraft, pending_approval, approved, rejected, partially_ordered, ordered, closed, cancelled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listdraft, pending_approval, approved, rejected, partially_ordered, ordered, closed, cancelled
{{tostatus}}To statusOne of a listdraft, pending_approval, approved, rejected, partially_ordered, ordered, closed, cancelled

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Purchase requisition updated ​

Trigger key: purchase_requisition_updated

A purchase requisition is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{requisitionid}}Requisition (id)ID
{{requisitionno}}Requisition numberText
{{title}}TitleText
{{description}}ReasonText
{{priority}}PriorityText
{{neededby}}Needed by (YYYY-MM-DD)Text
{{amount}}AmountNumber
{{currency}}CurrencyText
{{vendorid}}Vendor (id)ID
{{requestedby}}Requested by (id)ID
{{rejectionreason}}Rejection reasonText
{{submittedat}}Submitted (date and time)Text
{{approvedat}}Approved (date and time)Text
{{status}}StatusOne of a listdraft, pending_approval, approved, rejected, partially_ordered, ordered, closed, cancelled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Quotes ​

Quote created ​

Trigger key: quote_created

A quote is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{quoteid}}Quote (id)ID
{{quoteno}}Quote numberText
{{title}}TitleText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{quotedate}}Quote date (YYYY-MM-DD)Text
{{expirydate}}Expiry date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpublished, draft, sent, approving, approved, rejected
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Quote deleted ​

Trigger key: quote_deleted

A quote is deleted.

ValueWhat it holdsTypeOptions
{{quoteid}}Quote (id)ID
{{quoteno}}Quote numberText
{{title}}TitleText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{quotedate}}Quote date (YYYY-MM-DD)Text
{{expirydate}}Expiry date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpublished, draft, sent, approving, approved, rejected
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Quote status changed ​

Trigger key: quote_status_changed

A quote moves from one status to another.

ValueWhat it holdsTypeOptions
{{quoteid}}Quote (id)ID
{{quoteno}}Quote numberText
{{title}}TitleText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{quotedate}}Quote date (YYYY-MM-DD)Text
{{expirydate}}Expiry date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpublished, draft, sent, approving, approved, rejected
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusOne of a listpublished, draft, sent, approving, approved, rejected
{{tostatus}}To statusOne of a listpublished, draft, sent, approving, approved, rejected

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Quote updated ​

Trigger key: quote_updated

A quote is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{quoteid}}Quote (id)ID
{{quoteno}}Quote numberText
{{title}}TitleText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{quotedate}}Quote date (YYYY-MM-DD)Text
{{expirydate}}Expiry date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpublished, draft, sent, approving, approved, rejected
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Receipts ​

Receipt created ​

Trigger key: receipt_created

A receipt is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{receiptid}}Receipt (id)ID
{{receiptno}}Receipt numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balancedue}}Balance dueNumber
{{currency}}CurrencyText
{{receiptdate}}Receipt date (YYYY-MM-DD)Text
{{section}}SectionText
{{transactionid}}Transaction (id)ID
{{status}}StatusText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Receipt deleted ​

Trigger key: receipt_deleted

A receipt is deleted.

ValueWhat it holdsTypeOptions
{{receiptid}}Receipt (id)ID
{{receiptno}}Receipt numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balancedue}}Balance dueNumber
{{currency}}CurrencyText
{{receiptdate}}Receipt date (YYYY-MM-DD)Text
{{section}}SectionText
{{transactionid}}Transaction (id)ID
{{status}}StatusText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Receipt updated ​

Trigger key: receipt_updated

A receipt is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{receiptid}}Receipt (id)ID
{{receiptno}}Receipt numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balancedue}}Balance dueNumber
{{currency}}CurrencyText
{{receiptdate}}Receipt date (YYYY-MM-DD)Text
{{section}}SectionText
{{transactionid}}Transaction (id)ID
{{status}}StatusText
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Refunds ​

Refund created ​

Trigger key: refund_created

A refund is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{refundid}}Refund (id)ID
{{refundno}}Refund numberText
{{title}}TitleText
{{invoiceid}}Invoice (id)ID
{{invoiceno}}Invoice numberText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{method}}MethodText
{{reference}}ReferenceText
{{reason}}ReasonText
{{refunddate}}Refund date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpending, completed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Refund status changed ​

Trigger key: refund_status_changed

A refund moves from one status to another.

ValueWhat it holdsTypeOptions
{{refundid}}Refund (id)ID
{{refundno}}Refund numberText
{{title}}TitleText
{{invoiceid}}Invoice (id)ID
{{invoiceno}}Invoice numberText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{method}}MethodText
{{reference}}ReferenceText
{{reason}}ReasonText
{{refunddate}}Refund date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpending, completed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusOne of a listpending, completed
{{tostatus}}To statusOne of a listpending, completed

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Sales orders ​

Sales order created ​

Trigger key: order_created

A sales order is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{orderid}}Order (id)ID
{{orderno}}Order numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{stockstatus}}Stock statusText
{{type}}TypeText
{{duedate}}Due date (YYYY-MM-DD)Text
{{orderdate}}Order date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpublished, processing, paid, partially_paid, canceled, refunded, partially_refunded, credited
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Sales order deleted ​

Trigger key: order_deleted

A sales order is deleted.

ValueWhat it holdsTypeOptions
{{orderid}}Order (id)ID
{{orderno}}Order numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{stockstatus}}Stock statusText
{{type}}TypeText
{{duedate}}Due date (YYYY-MM-DD)Text
{{orderdate}}Order date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpublished, processing, paid, partially_paid, canceled, refunded, partially_refunded, credited
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Sales order status changed ​

Trigger key: order_status_changed

A sales order moves from one status to another.

ValueWhat it holdsTypeOptions
{{orderid}}Order (id)ID
{{orderno}}Order numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{stockstatus}}Stock statusText
{{type}}TypeText
{{duedate}}Due date (YYYY-MM-DD)Text
{{orderdate}}Order date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpublished, processing, paid, partially_paid, canceled, refunded, partially_refunded, credited
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusOne of a listpublished, processing, paid, partially_paid, canceled, refunded, partially_refunded, credited
{{tostatus}}To statusOne of a listpublished, processing, paid, partially_paid, canceled, refunded, partially_refunded, credited

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Sales order updated ​

Trigger key: order_updated

A sales order is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{orderid}}Order (id)ID
{{orderno}}Order numberText
{{title}}TitleText
{{amount}}AmountNumber
{{balance}}BalanceNumber
{{currency}}CurrencyText
{{stockstatus}}Stock statusText
{{type}}TypeText
{{duedate}}Due date (YYYY-MM-DD)Text
{{orderdate}}Order date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpublished, processing, paid, partially_paid, canceled, refunded, partially_refunded, credited
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Schedule & integrations ​

On a schedule ​

Trigger key: schedule

Runs at set times: every weekday at 08:00, the first of the month...

ValueWhat it holdsTypeOptions
{{firedat}}Ran atText
{{date}}DateText
{{time}}TimeText
{{weekday}}Day of the weekOne of a listMonday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Webhook received ​

Trigger key: webhook

Another system calls this automation's private URL with JSON. Use {{body.field}} to read what it sent.

ValueWhat it holdsTypeOptions
{{body}}Request bodyText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Social media ​

Social comment created ​

Trigger key: social_comment_created

A social comment is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{commentid}}Comment (id)ID
{{postid}}Post (id)ID
{{platform}}PlatformText
{{authorname}}AuthorText
{{message}}CommentText
{{posttitle}}Post titleText
{{accountname}}AccountText
{{commentedat}}Commented (date and time)Text
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Social post created ​

Trigger key: social_post_created

A social post is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{postid}}Post (id)ID
{{title}}TitleText
{{schedulefor}}Publish now or laterText
{{scheduledat}}Scheduled for (date and time)Text
{{publishedat}}Published (date and time)Text
{{status}}StatusOne of a listdraft, scheduled, publishing, published, partially_published, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Social post deleted ​

Trigger key: social_post_deleted

A social post is deleted.

ValueWhat it holdsTypeOptions
{{postid}}Post (id)ID
{{title}}TitleText
{{schedulefor}}Publish now or laterText
{{scheduledat}}Scheduled for (date and time)Text
{{publishedat}}Published (date and time)Text
{{status}}StatusOne of a listdraft, scheduled, publishing, published, partially_published, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Social post status changed ​

Trigger key: social_post_status_changed

A social post moves from one status to another.

ValueWhat it holdsTypeOptions
{{postid}}Post (id)ID
{{title}}TitleText
{{schedulefor}}Publish now or laterText
{{scheduledat}}Scheduled for (date and time)Text
{{publishedat}}Published (date and time)Text
{{status}}StatusOne of a listdraft, scheduled, publishing, published, partially_published, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listdraft, scheduled, publishing, published, partially_published, failed
{{tostatus}}To statusOne of a listdraft, scheduled, publishing, published, partially_published, failed

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Social post updated ​

Trigger key: social_post_updated

A social post is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{postid}}Post (id)ID
{{title}}TitleText
{{schedulefor}}Publish now or laterText
{{scheduledat}}Scheduled for (date and time)Text
{{publishedat}}Published (date and time)Text
{{status}}StatusOne of a listdraft, scheduled, publishing, published, partially_published, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Stock takes ​

Stock take created ​

Trigger key: stock_take_created

A stock take is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{stocktakeid}}Stock take (id)ID
{{referenceno}}Reference numberText
{{title}}TitleText
{{completedat}}Completed (date and time)Text
{{status}}StatusOne of a listdraft, completed, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Stock take deleted ​

Trigger key: stock_take_deleted

A stock take is deleted.

ValueWhat it holdsTypeOptions
{{stocktakeid}}Stock take (id)ID
{{referenceno}}Reference numberText
{{title}}TitleText
{{completedat}}Completed (date and time)Text
{{status}}StatusOne of a listdraft, completed, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Stock take status changed ​

Trigger key: stock_take_status_changed

A stock take moves from one status to another.

ValueWhat it holdsTypeOptions
{{stocktakeid}}Stock take (id)ID
{{referenceno}}Reference numberText
{{title}}TitleText
{{completedat}}Completed (date and time)Text
{{status}}StatusOne of a listdraft, completed, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listdraft, completed, canceled
{{tostatus}}To statusOne of a listdraft, completed, canceled

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Stock take updated ​

Trigger key: stock_take_updated

A stock take is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{stocktakeid}}Stock take (id)ID
{{referenceno}}Reference numberText
{{title}}TitleText
{{completedat}}Completed (date and time)Text
{{status}}StatusOne of a listdraft, completed, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Stock transfers ​

Stock transfer created ​

Trigger key: stock_transfer_created

A stock transfer is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{stocktransferid}}Stock transfer (id)ID
{{referenceno}}Reference numberText
{{title}}TitleText
{{toterritoryid}}To territory (id)ID
{{completedat}}Completed (date and time)Text
{{status}}StatusOne of a listapplying, completed, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Stock transfer deleted ​

Trigger key: stock_transfer_deleted

A stock transfer is deleted.

ValueWhat it holdsTypeOptions
{{stocktransferid}}Stock transfer (id)ID
{{referenceno}}Reference numberText
{{title}}TitleText
{{toterritoryid}}To territory (id)ID
{{completedat}}Completed (date and time)Text
{{status}}StatusOne of a listapplying, completed, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Stock transfer status changed ​

Trigger key: stock_transfer_status_changed

A stock transfer moves from one status to another.

ValueWhat it holdsTypeOptions
{{stocktransferid}}Stock transfer (id)ID
{{referenceno}}Reference numberText
{{title}}TitleText
{{toterritoryid}}To territory (id)ID
{{completedat}}Completed (date and time)Text
{{status}}StatusOne of a listapplying, completed, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listapplying, completed, canceled
{{tostatus}}To statusOne of a listapplying, completed, canceled

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Stock transfer updated ​

Trigger key: stock_transfer_updated

A stock transfer is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{stocktransferid}}Stock transfer (id)ID
{{referenceno}}Reference numberText
{{title}}TitleText
{{toterritoryid}}To territory (id)ID
{{completedat}}Completed (date and time)Text
{{status}}StatusOne of a listapplying, completed, canceled
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Subscriptions ​

Subscription created ​

Trigger key: subscription_created

A subscription is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{subscriptionid}}Subscription (id)ID
{{subscriptionno}}Subscription numberText
{{title}}TitleText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{billingcycle}}Billing cycleText
{{startdate}}Start date (YYYY-MM-DD)Text
{{nextbillingdate}}Next billing date (YYYY-MM-DD)Text
{{lastbillingdate}}Last billing date (YYYY-MM-DD)Text
{{enddate}}End date (YYYY-MM-DD)Text
{{cancellationreason}}Cancellation reasonText
{{status}}StatusOne of a listactive, trial, paused, canceled, expired, published, pending
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Subscription deleted ​

Trigger key: subscription_deleted

A subscription is deleted.

ValueWhat it holdsTypeOptions
{{subscriptionid}}Subscription (id)ID
{{subscriptionno}}Subscription numberText
{{title}}TitleText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{billingcycle}}Billing cycleText
{{startdate}}Start date (YYYY-MM-DD)Text
{{nextbillingdate}}Next billing date (YYYY-MM-DD)Text
{{lastbillingdate}}Last billing date (YYYY-MM-DD)Text
{{enddate}}End date (YYYY-MM-DD)Text
{{cancellationreason}}Cancellation reasonText
{{status}}StatusOne of a listactive, trial, paused, canceled, expired, published, pending
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Subscription status changed ​

Trigger key: subscription_status_changed

A subscription moves from one status to another.

ValueWhat it holdsTypeOptions
{{subscriptionid}}Subscription (id)ID
{{subscriptionno}}Subscription numberText
{{title}}TitleText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{billingcycle}}Billing cycleText
{{startdate}}Start date (YYYY-MM-DD)Text
{{nextbillingdate}}Next billing date (YYYY-MM-DD)Text
{{lastbillingdate}}Last billing date (YYYY-MM-DD)Text
{{enddate}}End date (YYYY-MM-DD)Text
{{cancellationreason}}Cancellation reasonText
{{status}}StatusOne of a listactive, trial, paused, canceled, expired, published, pending
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusOne of a listactive, trial, paused, canceled, expired, published, pending
{{tostatus}}To statusOne of a listactive, trial, paused, canceled, expired, published, pending

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Subscription updated ​

Trigger key: subscription_updated

A subscription is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{subscriptionid}}Subscription (id)ID
{{subscriptionno}}Subscription numberText
{{title}}TitleText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{billingcycle}}Billing cycleText
{{startdate}}Start date (YYYY-MM-DD)Text
{{nextbillingdate}}Next billing date (YYYY-MM-DD)Text
{{lastbillingdate}}Last billing date (YYYY-MM-DD)Text
{{enddate}}End date (YYYY-MM-DD)Text
{{cancellationreason}}Cancellation reasonText
{{status}}StatusOne of a listactive, trial, paused, canceled, expired, published, pending
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Tasks ​

Task created ​

Trigger key: task_created

A task is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{taskid}}Task (id)ID
{{title}}TitleText
{{description}}DescriptionText
{{startdate}}Start date (YYYY-MM-DD)Text
{{enddate}}End date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpending, in_progress, completed, done
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Enroll in sequence, Exit sequence.

Task deleted ​

Trigger key: task_deleted

A task is deleted.

ValueWhat it holdsTypeOptions
{{taskid}}Task (id)ID
{{title}}TitleText
{{description}}DescriptionText
{{startdate}}Start date (YYYY-MM-DD)Text
{{enddate}}End date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpending, in_progress, completed, done
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Task status changed ​

Trigger key: task_status_changed

A task moves from one status to another.

ValueWhat it holdsTypeOptions
{{taskid}}Task (id)ID
{{title}}TitleText
{{description}}DescriptionText
{{startdate}}Start date (YYYY-MM-DD)Text
{{enddate}}End date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpending, in_progress, completed, done
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{fromstatus}}From statusOne of a listpending, in_progress, completed, done
{{tostatus}}To statusOne of a listpending, in_progress, completed, done

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Enroll in sequence, Exit sequence.

Task updated ​

Trigger key: task_updated

A task is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{taskid}}Task (id)ID
{{title}}TitleText
{{description}}DescriptionText
{{startdate}}Start date (YYYY-MM-DD)Text
{{enddate}}End date (YYYY-MM-DD)Text
{{status}}StatusOne of a listpending, in_progress, completed, done
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Enroll in sequence, Exit sequence.

Transactions ​

Transaction created ​

Trigger key: transaction_created

A transaction is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{transactionid}}Transaction (id)ID
{{title}}TitleText
{{code}}CodeText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{fees}}FeesNumber
{{channel}}ChannelText
{{type}}TypeText
{{transactiontype}}Direction (credit or debit)Text
{{remark}}RemarkText
{{reference}}ReferenceText
{{category}}CategoryText
{{paymentlinkid}}Payment link (id)ID
{{accountid}}Account (id)ID
{{status}}StatusOne of a listsuccess, pending, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Transaction status changed ​

Trigger key: transaction_status_changed

A transaction moves from one status to another.

ValueWhat it holdsTypeOptions
{{transactionid}}Transaction (id)ID
{{title}}TitleText
{{code}}CodeText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{fees}}FeesNumber
{{channel}}ChannelText
{{type}}TypeText
{{transactiontype}}Direction (credit or debit)Text
{{remark}}RemarkText
{{reference}}ReferenceText
{{category}}CategoryText
{{paymentlinkid}}Payment link (id)ID
{{accountid}}Account (id)ID
{{status}}StatusOne of a listsuccess, pending, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{fromstatus}}From statusOne of a listsuccess, pending, failed
{{tostatus}}To statusOne of a listsuccess, pending, failed

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Transaction updated ​

Trigger key: transaction_updated

A transaction is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{transactionid}}Transaction (id)ID
{{title}}TitleText
{{code}}CodeText
{{amount}}AmountNumber
{{currency}}CurrencyText
{{fees}}FeesNumber
{{channel}}ChannelText
{{type}}TypeText
{{transactiontype}}Direction (credit or debit)Text
{{remark}}RemarkText
{{reference}}ReferenceText
{{category}}CategoryText
{{paymentlinkid}}Payment link (id)ID
{{accountid}}Account (id)ID
{{status}}StatusOne of a listsuccess, pending, failed
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{customername}}Customer nameText
{{customeremail}}Customer emailText
{{changedfields}}Changed fieldsText

Not available on this trigger: Complete the task, Enroll in sequence, Exit sequence.

Vendors ​

Vendor created ​

Trigger key: vendor_created

A vendor is created, by a person, the API, an import or another automation.

ValueWhat it holdsTypeOptions
{{vendorid}}Vendor (id)ID
{{name}}NameText
{{company}}CompanyText
{{industry}}IndustryText
{{email}}EmailText
{{phone}}PhoneText
{{country}}CountryText
{{city}}CityText
{{type}}TypeText
{{balance}}BalanceNumber
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Vendor deleted ​

Trigger key: vendor_deleted

A vendor is deleted.

ValueWhat it holdsTypeOptions
{{vendorid}}Vendor (id)ID
{{name}}NameText
{{company}}CompanyText
{{industry}}IndustryText
{{email}}EmailText
{{phone}}PhoneText
{{country}}CountryText
{{city}}CityText
{{type}}TypeText
{{balance}}BalanceNumber
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Assign owner, Complete the task, Enroll in sequence, Exit sequence.

Vendor updated ​

Trigger key: vendor_updated

A vendor is edited. Changed fields lists what changed.

ValueWhat it holdsTypeOptions
{{vendorid}}Vendor (id)ID
{{name}}NameText
{{company}}CompanyText
{{industry}}IndustryText
{{email}}EmailText
{{phone}}PhoneText
{{country}}CountryText
{{city}}CityText
{{type}}TypeText
{{balance}}BalanceNumber
{{assignedto}}Assigned to (ids)Text
{{territoryid}}Territory (id)ID
{{changedfields}}Changed fieldsText

Not available on this trigger: Email the contact, SMS the contact, WhatsApp the contact, Complete the task, Enroll in sequence, Exit sequence.

Cashfin Business API Documentation