Skip to content

Webhooks

Webhooks enable EGYM to push real-time notifications to your application. They offer valuable additions to user journeys for gym operators and their members. We use HTTPS to send these notifications to a URL you specify. You can create multiple webhooks for a single gym.

Prerequisites and limitations

Webhooks are designed to work with MMS integrations. The gym-based MMS API key is used for authentication, and the EGYM accountId is used as the member identifier.

Some Webhook events require Data sharing (C2B) and Health Data consents from the member before data can be shared.

Webhook data must not be used for member retention.

Who it is for

Any type of application can subscribe, provided an MMS API v2 integration is in place. Typical partners are third-party Class booking providers, BI tools and Member Management Software providers.

Use cases

You can use webhook event notifications to alert your app to certain events.

Use caseEvent typeDescriptionTarget toolsRequired member consents
Gym check-in / check-outGYM_CHECKIN, GYM_CHECKOUTOccurs whenever a customer has physically checked in or out of a gymThird-party class booking providers, BI toolsC2B opt-in
Equipment check-inEQUIPMENT_CHECKINOccurs whenever a customer has physically logged in to equipment in a gymMMS, third-party class booking providers, BI toolsNone
Membership deleteMEMBERSHIP_DELETEOccurs once member data gets deleted from EGYMMMS, third-party class booking providers, BI toolsC2B opt-in
Genius onboarding completedGENIUS_ONBOARDING_COMPLETEDOccurs when a member completes EGYM Genius onboardingMMS, third-party class booking providers, BI toolsC2B and HEALTH_DATA opt-ins
TestTESTTest event for webhook endpoint verificationAny webhook endpointNone

Use Case 1 - Customer Gym Checkin/Gym Checkout Event

The customer Gym Checkin/Gym Checkout event notifies your application once a customer has physically checked in or out of a gym.

Use Case 2 - Customer Equipment Checkin Event

The customer Equipment Checkin event notifies your application once a customer has logged in to equipment in a gym.

Use Case 3 - Customer membership delete event

The customer membership delete event notifies your application once member data gets deleted from EGYM.

Use Case 4 - Genius onboarding completed event

The Genius onboarding completed event notifies your application once a member has completed onboarding and created a training plan with EGYM Genius.

Serve webhook endpoint

Serve this endpoint so that it can be accessed by us without additional configuration and/or VPNs. Only HTTPS endpoints with valid SSL certificates are allowed. Timeout for requests to your endpoint is 5 seconds, after that requests will be treated as unsuccessful.

Event call endpoint definition

Method: POST

Headers: x-api-key:{your_secret}, Content-Type:application/json

Payload: { "accountId": "[UUID]", "timestamp": 1667921312188, "type" : "GYM_CHECKIN" }

accountId - account id of the user, UUID

timestamp - UTC timestamp of the event

type - event type

How to enable webhooks

Configuration via API (current)

API configuration will be replaced

The webhook management API endpoints are currently used for configuration but will be replaced with a UI-based configuration interface in the future. We recommend using the API for now, and we will provide migration guidance when the UI becomes available.

To configure webhooks programmatically:

  1. Authenticate with your API credentials
  2. Use the Webhook API endpoints to:
    • Create webhook subscriptions
    • Update webhook URLs and secrets
    • List configured webhooks
    • Delete webhook subscriptions

Configuration via UI (future)

A user-friendly interface for webhook configuration will be available in the future, eliminating the need for API-based setup.