Glossary
Wellhub Data Model
These are the standard fields used to represent employees across all Wellhub flows, regardless of the integration technology used. The Used In column indicates which flow(s) each field belongs to.
Note: Fields with a String format accept any textual value, including alphanumeric and symbol characters.
| Field | Description | Format | Used In |
|---|---|---|---|
| Name | Employee's full name. Used in communications | String | Eligibility, Payroll, Reports |
| Employee email address. Must be unique per company Tax ID; duplicates accepted at ME/CP level | Valid email address | Eligibility, Payroll, Reports | |
| National ID | National identification registry. Must be unique per company Tax ID; duplicates accepted at ME/CP level | Alphanumeric; format validated by country mask (e.g. CPF in Brazil) | Eligibility, Payroll, Reports |
| Employee ID | Employee identifier within the company's HR system. Must be unique per company Tax ID; duplicates accepted at ME/CP level | Alphanumeric | Eligibility, Payroll, Reports |
| Cost Center | Employee's cost center | String | Eligibility, Payroll, Reports |
| Department | Employee's department | String | Eligibility, Payroll, Reports |
| Office ZIP Code | Employee's office ZIP code | String | Eligibility, Payroll, Reports |
| Payroll ID | Identifies the employee in the company's payroll software | String | Eligibility, Payroll, Reports |
| Company Tax ID | Identifies to which company an employee belongs | Alphanumeric; special characters accepted | Eligibility, Reports |
| Discount Group / Subset ID | Determines which discount group an employee belongs to | Numeric; if empty, the discount group is removed | Eligibility |
| Mobile Number | Employee mobile number, can be used for identification. Unique under a given company | Must start with country code (+); digits with optional spaces, hyphens, or parentheses; mobile numbers only | Eligibility |
| Payroll Enabled | Whether the employee is allowed to use paycheck as a payment method | Yes or No | Eligibility |
| Custom Fields | Extra company-specific information not covered by standard fields. Must be pre-configured with Wellhub | String | Eligibility |
| Amount Due | Amount owed by the employee in local currency, as provided in the Payroll Deduction file | Currency symbol + two decimal amount (e.g. $123.45, R$20,00) | Payroll |
| Amount | Flexible benefit credit assigned to the employee | Numeric, up to 2 decimal places (e.g. 1000.00) | Flexible Benefits |
| Last Credited Month | Month in which the employee was most recently credited | Whole number, 1–12 | Flexible Benefits |
| Last Credited Year | Year in which the employee was most recently credited | YYYY | Flexible Benefits |
| Company Name | Display name of the company or subsidiary | String | Reports |
| Date | Date of the daily engagement snapshot | YYYY-MM-DD | Reports |
| Reference Month | Billing or reporting month the file covers | YYYY-MM | Reports |
| Eligible Employees | Total number of employees added to Wellhub; they are able to sign up and subscribe | Whole number | Reports |
| Members | Employees who signed up and have a Wellhub account | Whole number | Reports |
| Subscribers | Members who subscribed to a Wellhub plan | Whole number | Reports |
| Family Members | People employees bought subscriptions for and invited to Wellhub | Whole number | Reports |
| Subscriber Type | Indicates whether the subscriber is an employee or a family member | Employee or Family member | Reports |
| Family Member Name | Full name of the family member subscriber | String | Reports |
| Family Member Email | Email address of the family member subscriber | Valid email address | Reports |
| Family Member ID | Identifier for the family member within Wellhub | Alphanumeric | Reports |
| Check-in Date | Day when the check-in occurred | YYYY-MM-DD | Reports |
| Check-in Timezone | Timezone in which the check-in was performed; typically based on the partner location | Timezone name (e.g. America/Sao_Paulo) | Reports |
| Check-in Country | Country where the check-in took place | String | Reports |
| Check-in State | State or province where the check-in took place | String | Reports |
| Check-in City | City where the check-in took place | String | Reports |
| Check-in ZIP Code | ZIP or postal code of the check-in location | String | Reports |
| Check-in Type | How the employee engaged in the activity | In-person, Live class, or Partner app | Reports |
| Plan Name | Name of the Wellhub plan the employee is subscribed to | String | Reports |
| Pre-discount Plan Price | Plan price before company discount is applied | Currency amount | Reports |
| Company Discount | Discount the company offers employees on their plans | Currency amount | Reports |
| Post-discount Plan Price | Amount the employee pays after company discount, excluding taxes | Currency amount | Reports |
| Plan Currency | Currency of plan prices | 3-letter currency code (e.g. BRL, USD) | Reports |
| Subscription Start Date | Date the employee started their Wellhub plan, including any free trial period | YYYY-MM-DD | Reports |
| Status | Subscription status at the end of the reporting period | Active, Paused, Limited access, or Canceled | Reports |
| Transaction Day | Day on which a subscription transaction event occurred | YYYY-MM-DD | Reports |
| Transaction Event | Type of subscription lifecycle event | First subscription, Upgrade, Downgrade, Pause, Cancellation, or New subscription | Reports |
Key Terms
Business Concepts
Eligibility Identifier The attribute (or combination of attributes) used to uniquely identify an employee in Wellhub. Defined per company contract. Can be Email, Employee ID, Employee ID and National ID, or Mobile Number. Any attribute that does not compose the eligibility identifier for a company is optional. See Eligibility Identifiers.
Primary Identifier When an Eligibility Identifier is composed of multiple attributes, the primary identifier is the one that takes precedence when identifying an employee.
Email An employee's email address. Can serve as an Eligibility Identifier. Must be unique per company Tax ID.
National ID A national identification number (e.g. CPF in Brazil). Can serve as an Eligibility Identifier attribute. Format is validated by country mask.
Employee ID An employee's identifier within the company's HR system. Can serve as an Eligibility Identifier. Must be unique per company Tax ID.
Mobile Number An employee's mobile phone number. Must start with + followed by the country code. Accepted separators are spaces, hyphens, and parentheses. Fixed-line, shared cost, and emergency numbers are not accepted. Can serve as an Eligibility Identifier. Must be unique within a given company.
Wellhub The corporate wellness platform for which this Developer Hub provides integration documentation. Formerly known as Gympass.
Flow A business process that defines a specific type of data exchange with Wellhub (e.g., eligibility, payroll deductions). Flows are technology-agnostic. See Feature Flows.
Eligibility The process of managing which employees are allowed to use Wellhub's services. See the Eligibility Flow.
Eligible An employee record that has been submitted to Wellhub and is eligible to access Wellhub's benefits platform.
Full File An eligibility sub-flow in which the submitted file represents the complete current state of all eligible employees. Any employee not in the file is considered a leaver. See Eligibility Flow.
Newcomer An employee being added to Wellhub eligibility for the first time via a newcomers sub-flow. See Eligibility Flow.
Leaver An employee who is being removed from Wellhub eligibility, either explicitly (via a leavers file) or implicitly (by absence from a full file). See Eligibility Flow.
Family Member A person an employee has purchased a Wellhub subscription for and invited to the platform. Family members can use Wellhub independently and appear alongside the employee in subscription, check-in, and reporting data. Availability depends on the company's contract with Wellhub.
Member An employee (or family member) who has signed up and created an account on Wellhub, without subscribing to a plan.
Payroll Deductions The process by which Wellhub provides deduction files for companies to process benefit cost deductions from employee payroll. See the Payroll Flow.
Flexible Benefits The process by which organizations assign benefit credits to employees, who can then allocate those credits towards Wellhub benefit options. Credits can be added, updated, or removed. Available for Multi Entity and Channel Partner organizations. See the Flexible Benefits Flow.
Reports The process by which Wellhub provides usage and adoption data to organizations, covering engagement rates, check-ins, subscriber snapshots, and subscription history over the last 12 months. Available for Single Entity organizations. See the Reports Flow.
Entity A company or organizational unit as represented in Wellhub. Depending on your entity type, this may be a single company, a subsidiary, or a client company. See Entity Types.
Single Entity (SE) A company that integrates directly with Wellhub as a single legal entity. See Entity Types.
Multi Entity (ME) A corporate group or holding company with multiple subsidiaries, all integrated under one parent. See Entity Types.
Channel Partner (CP) An intermediary company (e.g., HR software vendor or benefits broker) that integrates with Wellhub on behalf of multiple independent client companies. See Entity Types.
Integration The technical method used to exchange data with Wellhub (e.g., REST API, SFTP). See Integrations.
API (Application Programming Interface) A programmatic interface that allows systems to communicate in real time over HTTPS. Wellhub provides a REST API for integration.
SFTP (Secure File Transfer Protocol) A file transfer protocol used for batch data exchange. Wellhub supports SFTP for eligibility, payroll, flexible benefits, and reports file transfers.
SSO (Single Sign-On) An authentication method that allows users to log in to Wellhub using their existing corporate identity provider. Currently used in the Wellhub Sign Up flow.
Credentials Authentication secrets (such as client ID and client secret for the API, or SSH keys for SFTP) used to identify and authorize an integration.
Job In the context of the REST API, a job is a batch operation that processes a set of eligibility records. A job contains one or more job items.
Sandbox Environment A non-production Wellhub environment used for development and testing. Data submitted here does not affect real employee records.
Production Environment The live Wellhub environment where real data is processed. Contrast with Sandbox.