How-toFor engineers

Set up a GraphQL API call to Healthie

Configure a GraphQL API call action against Healthie, including which environment to point at and how to handle authentication.

A care flow orchestrates actions in Healthie through the GraphQL API call action. This page covers configuring it.

Add the action

Add a GraphQL API call action to a step, the same way as any other API call action.

Point the URL at the right Healthie environment

Healthie has two API environments, staging and production, with different endpoints. Check Healthie's own documentation for the current URLs.

Store the URL in a constant: the endpoint appears in every Healthie call, and the value differs between the Sandbox and Production environments. A constant makes changing it a one-line edit instead of an audit of every action.

Authenticate with an API key in the headers

Healthie authenticates with an API key in the request headers. Put the key in a constant too, and never type it directly into an action.

Configure the operation and variables

Write the GraphQL query or mutation, and pass values in as variables. Use Awell variables to insert care flow data, such as the patient identifier.

Store what comes back

Use JSON path to store response values in data points, so the rest of the care flow can use them. Skip this and the response is discarded.

Next steps

If a Healthie setup requires OAuth rather than a static key, see Connecting to systems that require OAuth.

On this page