API keys are unique codes used to connect Hero with other systems — for example, to integrate with a triage provider or another partner platform. They allow data to flow securely between Hero and the connected service without sharing login details.
How to create an API key
From your Hero dashboard, click on Settings in the sidebar.
In the Settings menu, select My Practice.
Click on the API Key section to view your practice’s integration options.
Click Generate API Key.
You’ll be asked to select a partner from the dropdown list — choose the partner you want to connect with.
Once the key is generated, it will be displayed only once.
Make sure to copy it and store it somewhere secure.
After clicking Done, you will no longer be able to see the full key again.
Partners are third-party tools or services that integrate with your Hero Health system. Connecting a partner gives them controlled access to your practice data through Hero's API. You can connect new partners, rotate their API keys, and disconnect them entirely from your practice settings.
Go to Apps and select the partner you want to connect.
Select Connect.
Hero will automatically set up the integration, including generating an API key for that partner. You do not need to configure anything manually.
Once complete, the partner will show as Connected.
Share the generated API key with your partner so they can authenticate their requests. You can view or copy the key at any time from the partner's page in Apps.
You can regenerate a partner's API key without disconnecting the integration. This is useful if a key has been compromised or needs to be refreshed as part of routine security practice.
Go to Apps and select the connected partner.
Select Rotate API key.
Confirm the action. A new key will be generated immediately.
The old key stops working straight away. Share the new key with your partner before rotating, or be prepared to send it to them promptly after, to avoid a gap in service.
Disconnecting a partner removes their access to your practice completely. It disables the integration and invalidates their API key. This cannot be undone without reconnecting.
Go to Apps and select the connected partner.
Select Disconnect.
Confirm the action.
The partner's access is removed immediately. If you want to reconnect them later, you will need to go through the connection flow again and share the new API key with them.
Action | What it does |
|---|---|
Connect | Sets up the integration, creates the API key, enables partner access |
Rotate API key | Generates a new key, invalidates the old one, keeps the integration active |
Disconnect | Disables the integration and all associated access, invalidates the API key |
If you need an API key revoked, or if you clicked Done without copying it, please contact the Hero support team at [email protected].
We can either revoke your existing key or securely share the key with you again, as it will no longer be visible in your account.
