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.
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.
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.
You can use webhook event notifications to alert your app to certain events.
| Use case | Event type | Description | Target tools | Required member consents |
|---|---|---|---|---|
| Gym check-in / check-out | GYM_CHECKIN, GYM_CHECKOUT | Occurs whenever a customer has physically checked in or out of a gym | Third-party class booking providers, BI tools | C2B opt-in |
| Equipment check-in | EQUIPMENT_CHECKIN | Occurs whenever a customer has physically logged in to equipment in a gym | MMS, third-party class booking providers, BI tools | None |
| Membership delete | MEMBERSHIP_DELETE | Occurs once member data gets deleted from EGYM | MMS, third-party class booking providers, BI tools | C2B opt-in |
| Genius onboarding completed | GENIUS_ONBOARDING_COMPLETED | Occurs when a member completes EGYM Genius onboarding | MMS, third-party class booking providers, BI tools | C2B and HEALTH_DATA opt-ins |
| Test | TEST | Test event for webhook endpoint verification | Any webhook endpoint | None |
The customer Gym Checkin/Gym Checkout event notifies your application once a customer has physically checked in or out of a gym.
The customer Equipment Checkin event notifies your application once a customer has logged in to equipment in a gym.
The customer membership delete event notifies your application once member data gets deleted from EGYM.
The Genius onboarding completed event notifies your application once a member has completed onboarding and created a training plan with EGYM Genius.
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.
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
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:
- Authenticate with your API credentials
- Use the Webhook API endpoints to:
- Create webhook subscriptions
- Update webhook URLs and secrets
- List configured webhooks
- Delete webhook subscriptions
A user-friendly interface for webhook configuration will be available in the future, eliminating the need for API-based setup.