Core Concepts

Before diving into implementation details, it helps to understand the two fundamental dimensions of any Wellhub integration: flows and integrations.

Flows vs. Integrations

A flow is a business process that defines what data is exchanged with Wellhub and why. For example, the Eligibility flow describes how employee eligibility records are created, updated, and removed. Flows are technology-agnostic — the same business rules apply regardless of whether you use the API or SFTP to implement them. Wellhub currently supports:

  • Eligibility — Manage which employees are eligible to access Wellhub.
  • Payroll — Download benefit deduction data for payroll processing.
  • Flexible Benefits — Manage flexible benefit credits for employees.
  • Reports — Access usage and adoption reports.
  • Sign-up — Manage employee self-enrollment flows.

An integration is the technical method used to implement one or more flows. Wellhub currently supports:

  • REST API — Real-time, programmatic data exchange over HTTPS.
  • SFTP File Exchange — Batch file-based data exchange using structured files (CSV or XLSX) transferred over SFTP.
  • SSO — Single Sign-On for user authentication on Sign Up.

Not every integration supports every flow. Refer to the Feature Flows overview or the Integrations overview for a full compatibility matrix.

The Integration Lifecycle

A typical Wellhub integration follows these steps:

  1. Understand your flows — Identify which business processes you need to integrate (e.g., eligibility management, payroll deductions).
  2. Choose your integration technology — Based on your technical capabilities and the flows you need, select the appropriate technology (API, SFTP, or SSO).
  3. Set up your environment — Configure credentials, keys, or certificates as required by your chosen technology (which can be performed on Wellhub Clients Portal).
  4. Implement the flows — Follow the implementation guides for each flow under your chosen integration technology.
  5. Test in sandbox — Validate your integration in the sandbox environment before going live.
  6. Go live — Switch to the production environment and begin exchanging data.

Environments

Wellhub provides two environments:

  • Sandbox — For development and testing. Data submitted here does not affect production. Currently only available for the REST API.
  • Production — The live environment where real employee data is processed.

Data Model & Glossary

For a full reference of all data fields used across Wellhub flows — including which fields belong to Eligibility, Payroll, or both — see the Glossary. The glossary also defines key terms used throughout this documentation.

Data Privacy and Security

Wellhub takes the privacy and security of the data it processes from its customers very seriously. Wellhub's processing activities are aligned with PCI-DSS and ISO 27001 certification and with local regulations (e.g. GDPR, LGPD). For detailed questions on Wellhub's security posture, reach out to your Wellhub Customer Engineering representative.

SFTP file exchange supports optional PGP encryption for both uploaded and downloaded files, providing an additional layer of protection for sensitive data in transit.

Next Steps

  • Read about Entity Types to understand how your organization is represented in Wellhub.
  • Browse Feature Flows to identify which flows apply to your use case.
  • Browse Integrations to choose your implementation technology.