Event trigger types
GymOS exposes a wide range of event types to which custom workflows can be hooked via the Event Trigger functionality.
Trigger types are typically focused on a user type, i.e. a member, a lead, or a “participant”. A few are generic and span multiple targets. Each trigger has corresponding merge fields that may be used in certain trigger actions. These merge fields are documented here.
The trigger types and their purposes are provided below.
| General > Communications > Message received Occurs upon receipt of a message in the message centre |
| General > DropSlot Consultations > Consultation attended Occurs when a consultation is marked as attended |
| General > DropSlot Consultations > Consultation booked Occurs when a consultation is booked |
| General > DropSlot Consultations > Consultation cancelled Occurs when a consultation is cancelled |
| General > DropSlot Consultations > Consultation no-show Occurs when a consultation is marked as a no-show |
| General > DropSlot Consultations > Invitation expired Occurs on a nightly basis when an invitation has expired |
| General > DropSlot Consultations > Invitation issued Occurs when a consultation invitation is issued |
| General > Forms & Questionnaires > Form completed Occurs when a lead or member completes a form/questionnaire |
| General > Payment Links > Payment link completed Occurs when a successful payment is made to a QuikPay link |
| General > Store > Inventory count low Occurs when an inventory count becomes low |
| General > Store > Store order placed by member Occurs when a store order is placed via FitnessHub |
| Leads > Appointments > Lead appointment attended Occurs when a lead appointment is marked as attended |
| Leads > Appointments > Lead appointment booked Occurs when a lead books an appointment |
| Leads > Appointments > Lead appointment cancelled Occurs when a lead cancels their appointment |
| Leads > Appointments > Lead appointment no show Occurs when a lead is marked as a ‘no show’ for an appointment |
| Leads > Assignments > Lead call completed Occurs at the point at which a lead call is marked as complete |
| Leads > Assignments > Lead call scheduled Occurs at the point at which you schedule a lead call |
| Leads > Assignments > Lead journey point changed Occurs when a lead has their journey point changed manually |
| Leads > Campaigns > Lead campaign sign-up Occurs when a lead is subscribed to a campaign |
| Leads > Creation and conversion > Lead converted Occurs when a lead is converted to a member |
| Leads > Creation and conversion > Lead created Occurs when a lead record is created |
| Leads > Creation and conversion > Lead ingested from Meta Occurs when a new lead is imported from Meta |
| Leads > Creation and conversion > Lead ingested from Webhook Occurs when a new lead is imported via the GymOS webhook |
| Leads > Referrals > Referral converted to lead Occurs when a member referral is converted to a lead |
| Members > Absences > Scheduled absence commenced Occurs when a scheduled absence starts |
| Members > Absences > Scheduled absence concluded Occurs when a scheduled absence ends |
| Members > Absences > Scheduled absence created Occurs when a scheduled absence is recorded |
| Members > Achievements > Achievement logged Occurs when a new achievement is logged by/for a member |
| Members > Achievements > Bodyhop logged Occurs when a new Bodyhop is logged by/for a member |
| Members > Achievements > File uploaded Occurs when the member uploads a file for review |
| Members > Achievements > Weight change logged Occurs when a new weight change is logged by/for a member |
| Members > Achievements > Workout completed Occurs when a member logs an XRcize workout as complete |
| Members > Anniversaries > Birthday Occurs overnight on the member’s birthday |
| Members > Anniversaries > x month(s) anniversary of joining Occurs overnight on the member’s joining anniversary |
| Members > Anniversaries > x year(s) anniversary of joining Occurs overnight on the member’s joining anniversary |
| Members > Assignments > Injury recorded Occurs when a new injury is recorded |
| Members > Assignments > Member call completed Occurs at the point at which a member call is marked as complete |
| Members > Assignments > Member call scheduled Occurs at the point at which you schedule a member call |
| Members > Assignments > Member journey point changed Occurs when a new journey point is assigned to a member |
| Members > Assignments > Mentor assigned Occurs when a new mentor is assigned to a member |
| Members > Assignments > Status changed Occurs when a member’s status is changed |
| Members > Checks and blocks > Document check expiring Occurs when a document check is due to expire |
| Members > Checks and blocks > Session booking block applied Occurs when a session booking block is automatically applied |
| Members > Creation and conversion > Member promoted to Employee/Manager Occurs when a member is promoted to an employee or manager |
| Members > Creation and conversion > Member sign-up Occurs when a new member record is created |
| Members > Credits > Credit pack purchased Occurs when a credit pack is purchased |
| Members > Credits > Credit usage slipping Occurs when a member’s credit use is slipping |
| Members > Credits > Running out of credits Occurs when a member is running low on credits |
| Members > Memberships > Membership added Occurs at the point a membership is assigned to a member |
| Members > Memberships > Membership anniversary Occurs at a given point after the membership start date |
| Members > Memberships > Membership cancelled Occurs at the point that a membership is marked to be cancelled |
| Members > Memberships > Membership credits allocated Occurs when credits are allocated as part of a membership |
| Members > Memberships > Membership ended naturally Occurs when a membership expires naturally (I.e. excludes cancellations) |
| Members > Memberships > Membership ending Occurs overnight as a membership approaches its end date |
| Members > Memberships > Membership pause commencing Occurs overnight x days before a membership is paused |
| Members > Memberships > Membership pause ending Occurs overnight x days before a membership pause concludes |
| Members > Memberships > Membership paused Occurs at the point that a membership pause period commences |
| Members > Memberships > Membership started Occurs overnight on the day that a membership commences |
| Members > Memberships > Membership unpaused Occurs at the point that a membership pause period concludes |
| Members > Metrics > Activity below x for y days (Calories) Occurs when calorie burn is below x for y consecutive days |
| Members > Metrics > Activity below x for y days (Minutes) Occurs when minutes activity is below x for y consecutive days |
| Members > Metrics > Member spend has exceeded x Occurs when a member’s spend in a period exceeds x |
| Members > Metrics > Sleep below x for y days Occurs when a member’s sleep is below x for y consecutive days |
| Members > Off-boarding > Leaver exited Occurs overnight after a leaver’s final day |
| Members > Off-boarding > Notified intent to leave Occurs when a leaver record is created |
| Members > Payments > Card added Occurs when a member adds a new payment card |
| Members > Payments > Card expiring Occurs when Stripe advises that a member’s card is expiring, or at the point of a membership payment being taken and GymOS determining that the card will not be valid at the point the next scheduled payment is due. |
| Members > Payments > Direct debit mandate added Occurs when a member adds a new Direct Debit mandate |
| Members > Payments > Direct debit mandate cancelled Occurs when a member cancels their Direct Debit mandate |
| Members > Payments > Membership payment failure Occurs when an automated membership payment fails |
| Members > Payments > Membership payment success Occurs when an automated membership payment succeeds |
| Members > Referrals > Referral made by member Occurs when a member makes a potential lead referral |
| Members > Risk IQ > Risk IQ mitigation workflow Can be triggered when actioning a Risk IQ alert |
| Members > Sessions > Attended a new session type Occurs when a member attends a new session type |
| Members > Sessions > Booked a new session type Occurs when a member books a new session type |
| Members > Sessions > Booking count has fallen to x Occurs when the number of attendees on a session falls to x |
| Members > Sessions > Booking count has risen to x Occurs when the number of attendees on a session rises to x |
| Members > Sessions > Check-in via kiosk or GPS Occurs when a member self checks-in via the kiosk or GPS |
| Members > Sessions > Member attendance lapsing Occurs when a member hasn’t attended for x days |
| Members > Sessions > No show Occurs when a member is marked as a ‘no show’ for a session |
| Members > Sessions > Session attended Occurs when a member is marked as having attended a session |
| Members > Sessions > Session booked Occurs when a session is booked by/for a member |
| Members > Sessions > Session booking cancelled Occurs when a member cancels their session booking |
| Members > Sessions > x lifetime sessions attended Occurs when a member attends their nth session (any session) |
| Members > Sessions > x no shows Occurs when a member has x no shows within a given period |
| Members > Sessions > x sessions attended Occurs when a member has attended x eligible sessions |
| Members > Sessions > x sessions booked Occurs when a member has booked x eligible sessions |
| Members > Sessions > x sessions cancelled Occurs when a member has cancelled x eligible sessions within a given period |