Health Platform GroupDevelopersContact our team
Browse documentation
Get startedGetting started

Integration guide

Getting started

Before development, agree what the integration will do, which services it will use and who is responsible for support. This guide covers planning, configuration, testing and launch.

Start with the experience

Write down what your customer needs to do, where the journey begins and what a successful outcome looks like. Include the hand-off to a service provider and how the customer finds support.

Example use case

An employee uses a benefits portal to find a healthcare service, follows a referral link and completes a booking with the provider. Record who handles support at each step.

Referral journeys

A referral introduces your customer to a healthcare service through a link or an agreed hand-off. Plan where the customer leaves your experience, what they see next and who handles their questions. Agree any attribution or reporting requirements with your integration contact before launch.

Embedded experiences

An embedded or co-branded journey brings the service closer to your own platform. Define the screens, branding, customer communications and support responsibilities together. Confirm the available integration method and any data-sharing requirements before choosing your implementation.

Prepare your environment

  1. 01

    Confirm your scope

    Agree the service, integration model, supported market and commercial arrangement with your HPG contact.

  2. 02

    Separate your configuration

    Keep base URLs, credentials and environment settings outside your application code. Use your organisation’s secrets manager for sensitive values.

  3. 03

    Define ownership

    Nominate a technical owner and an operational contact. Agree who handles customer questions, technical incidents and changes to the journey.

Test the whole journey

Use non-sensitive test data and follow the test plan for your agreed connection. Cover the successful path, then check what happens when something goes wrong.

  • Required fields, invalid inputs and unsupported choices.
  • Authentication failures and expired or missing configuration.
  • Slow responses, interrupted requests and safe retry behaviour.
  • Customer confirmations, redirects and support hand-offs.
  • Mobile layouts, keyboard navigation and clear error messages.

Your launch checklist

  • The end-to-end customer journey has been reviewed.
  • Production configuration is stored securely.
  • Support contacts and escalation ownership are agreed.
  • Your team can identify and investigate failed requests.
  • Customer-facing content and communications are approved.

Share the completed plan with your integration contact and agree the final steps to launch.

Integrations & provider onboarding

To discuss an integration or provider listing, send our partnerships team your organisation’s website, the products or services you offer and the systems you want to connect. Include the customer workflow and any existing API documentation.

Our team will review service availability, technical requirements and the onboarding steps for your proposed connection.

Speak with our partnerships team
Continue readingAPI referenceRequest patterns, credentials and response handling.

Browse documentation