Getting Started

1. Granting User Access

Implement the integration using your Registration API in order to grant premium access to Wellhub users.

Requirements

  • Uniquely track Wellhub users for commercial reporting purposes and payment
  • Receive and store the following parameters:
    • Wellhub User ID (ex: gpw-29caecdf-2d5e-40b8-82b4-d0a044fa) - MANDATORY for all registration types
    • [optional] Country Code of User (ex: br)

Landing Page Recommendations

  • User should add their own name and email on the registration page in order to avoid Wellhub directly sharing user PII with you.
  • Ensure to give an option for signing up and also for log in only. It may be that the user already has an account and needs to be directed to log in.
  • If the user already has an account but tries to sign up again, please provide a clear error message and a link to direct the user to log in only.
  • It may be that they have a freemium account with you already, in which case they could upgrade their account to the premium version through this Wellhub integration. Please ensure the user is able to smoothly update their existing account to a premium paid version.
  • In the other case where a user is already a paying premium user, you should not link their account to Wellhub. When their direct subscription ends, they can then come back into Wellhub and upgrade their freemium account as explained above.

Integration via API

Do you already have a registration API? This is the preferred method for Wellhub to integrate with you. Please share your documentation with us to evaluate.

Other Required Information

To be able to do the full integration process, we need to receive some complementary marketing information from you related to the app description, language and market availability, and activities offered in the app. Please fill in this this survey.

2. Facilitating Payments

Reporting Usage Data

You should send the Events API in real time or daily to be considered a daily report

Events API data should be received as frequently as possible (preferably real-time or daily). At the end of each month, Wellhub will calculate the amount due based on the contractual terms and will request an invoice from you to process the payment.

Payments Process

Timeline & Policies

  • An invoice will be requested from you by the Wellhub team and should be received by the 10th of the month.
  • Payment will be made on the 25th of the month. If the invoice is not received on time for any reason, the payment will be delayed one month.

Invoices should be made using the following fiscal details:

All partners except those from Brazil: Gympass U.S., LLC 160 Varick St, New York, NY 10013, United States VAT/ TAX ID: EIN 82-2685557

Brazilian partners: GPBR Participações Ltda. CNPJ 15.664.649/0001-84 Rua Casa do Ator, 919 - Vila Olimpia São Paulo SP 04546-003 Brazil

3. Managing User Access

What is a "Leaver"?

A "Leaver" is anyone who has either cancelled, paused, or downgraded their Wellhub plan (to a tier that does not include your app) and therefore is no longer eligible to use your services.

How will you receive this information?

Wellhub has developed an automated webhook solution to send user cancellation and status change events in real-time. Please find all the details of our webhooks here. Wellhub will not pay for any visits related to users that have been sent via webhook until the user has repurchased a Wellhub plan and is, therefore, eligible to use your services again.

What is the UX for a "leaver"?

Due to the flexibility of a Wellhub plan our users are able to pause, cancel, or downgrade their plan and return to purchase a Wellhub plan whenever they want. That being said, it is important that you are able to disable access for these users and ensure a smooth UX.

Questions to consider:

  • What experience will a disabled user (leaver) have?

    • Will they be able to access a "free version" of your content?
    • Will they simply not be recognised by the system if they try to log in?
    • Any other possible UX that could take place?

  • If a user returns to purchase a Wellhub plan and goes back through the initial Activation process for your services:

    • Will the user automatically be re-granted access to the premium content?
    • Could there be any error due to an existing account?

Ideal User Experience

The ideal UX is for a user who has canceled, paused or downgraded their plan to not be granted access to the premium paid content. Nevertheless, users can continue to have access to the free/non-premium version of your app.

If a user repurchases their plan, you will receive a "change" status event via webhook. The user should be granted the premium content access again in their same account immediately.

If the UX will be different from the above, please reach out to us at wellnesspartners@gympass.com to discuss the options.