‹ Back to Knowledge Base

Webhook Events for GymMaster

5 min read Updated 11 days ago

For how to set up webhooks, the request format and retries, see Webhooks for GymMaster.

Each event below shows its name in the Webhook Manager, its event_type, when GymMaster sends it, and an example of a webhook GymMaster sent for it.

Dates such as membership_end_date are the dates GymMaster stores. If your club shows end dates as the last day a member can visit, GymMaster may show the date one day earlier than the payload.

Member events

Member Add (member_add)

Sent when a member or prospect is added, for example by staff, by an online sign-up, or by an import.

Field	Description
memberid	The new member.

Member Update (member_update)

Sent when a member’s details change. This includes their profile, addresses, emergency contacts and profile photo. GymMaster sends one webhook per save, even if many details change at the same time. Some other actions also change the member record and send this event, for example adding a membership.

Field	Description
memberid	The member that changed.

Member Delete (member_delete)

Sent when a member is deleted, or merged into another member.

Field	Description
memberid	The member that was deleted.
source	member deletion or member merge.

Member Checkin (member_checkin)

Sent when a member tries to get in at a door, for example with a fob, card, or the member app. It is sent for denied entry as well as granted entry. Check-ins to a class or appointment send Booking Checkin instead.

Field	Description
id	The ID of this visit.
memberid	The member that tried to get in.
doorid	The door they used.
access_code	1 when entry was granted. Any other number means entry was denied.
access_state	Granted, or the reason entry was denied.

Membership events

Membership Add (membership_add)

Sent when a membership is added to a member. The sale may not be finished yet. Use Membership Complete if you only want memberships that have been completed.

Field	Description
memberid	The member.
membershipid	The new membership.

Membership Complete (membership_complete)

Sent when the sale of a membership is completed, for example when staff finish adding it or a member finishes signing up online.

Field	Description
memberid	The member.
membershipid	The membership.

Membership Start (membership_start)

Sent when a completed membership starts. If the membership starts today or earlier, it is sent when the membership is completed. If it starts in the future, it is sent on the start date.

Field	Description
memberid	The member.
membershipid	The membership.

Membership Hold Add (membership_hold_add)

Sent when a hold is added to a membership.

Field	Description
memberid	The member.
membershipid	The membership on hold.
startdate	The first day of the hold.
enddate	The end date of the hold.

Membership Cancel (membership_cancel)

Sent when a membership is cancelled. The membership can still be in use until its end date.

Field	Description
memberid	The member.
membershipid	The cancelled membership.
membership_end_date	The date the cancellation takes effect.

Membership Expire (membership_expire)

Sent when a membership ends on its end date. Memberships that end because all their visits are used send Membership Deplete instead.

Field	Description
memberid	The member.
membershipid	The membership that ended.
membership_end_date	The end date of the membership.

Membership Deplete (membership_deplete)

Sent when a concession membership (one with a set number of visits) ends because the member used all of their visits.

Field	Description
memberid	The member.
membershipid	The membership that ended.
membership_end_date	The date the membership’s visits were due to expire.

Booking events

All booking events include bookingid (the booking) and memberid (the member it is for).

Booking Add (booking_add)

Sent when a member is booked into a class, service, or appointment, by staff or by the member.

Field	Description
bookingid	The new booking.
memberid	The member.
booking_type	What was booked: CLASS_ATTENDEE for a class, SERVICE for a service or appointment, or GROUP_ATTENDEE for group training. Bookings that are not for one member can show other values, such as CLASS or GROUP.

Booking Reschedule (booking_reschedule)

Sent when the date or time of a booking changes.

Booking Checkin (booking_checkin)

Sent when a member is checked in to a booking, including late arrivals.

Booking Checkout (booking_checkout)

Sent when a check-in to a booking is undone, so the member is shown as booked again.

Booking No Show (booking_no_show)

Sent when a booking is marked as a no-show.

Booking Cancel (booking_cancel)

Sent when a booking is cancelled.

Payment events

Journal Charge Paid Membership (First) (journal_charge_paid_ms_first)

Sent when the first regular charge of a membership is fully paid. Use it to find out that a new member has made their first payment.

Field	Description
memberid	The member.
membershipid	The membership the charge is for.
charge_date	The date of the charge.

Example journal_charge_paid_ms_first webhook

Journal Charge Paid Membership (journal_charge_paid_ms)

Sent when any later regular charge of a membership is fully paid. The first charge sends Journal Charge Paid Membership (First) instead, if you subscribe to it. If you do not subscribe to the first-charge event, the first charge sends this event.

Field	Description
memberid	The member.
membershipid	The membership the charge is for.
charge_date	The date of the charge.

Journal Payment Refunded Membership (journal_payment_refunded_ms)

Sent when a billing provider reports that a payment for a membership charge was refunded.

Field	Description
memberid	The member.
membershipid	The membership the payment was for.
payment_date	The date of the billing run that took the payment.

Example journal_payment_refunded_ms webhook

Payment Fail (payment_fail)

Sent when a payment from a billing run fails.

Field	Description
memberid	The member.
exportid	The ID of the billing record that failed.
failreason	The reason from the billing provider.
bptransactionid	The billing provider’s ID for the payment.

Test Webhook (test_webhook)

Sent only when you use Test Send with the Test Webhook event. It goes to every URL you have set up, and has no data other than test_webhook.

Common Questions This Covers

When does GymMaster send each webhook
What fields are in a GymMaster webhook payload
What does a GymMaster webhook look like