Skip to Content

Onboarding

Before you can start sending or receiving data, both sides need to exchange a few credentials and configuration values.

What Insight Health provides to you

PropertyTypeDescription
API Key*
stringA unique key identifying your integration. Sent in the X-API-Key header on every request.
Signing Key*
stringA shared secret used to compute and verify HMAC-SHA256 request signatures. Never transmitted over the wire.
EHR Identifier*
stringYour assigned EHR name used in the URL path (e.g., nexus, medicat).
* Required field

What you provide to Insight Health

These items are only required if you want to receive outbound clinical notes from Insight Health.

PropertyTypeDescription
Webhook URL*
stringYour HTTPS endpoint where Insight Health will POST clinical notes and summaries.
API Key*
stringAn API key you generate for Insight Health to include when calling your webhook.
Signing Key*
stringA shared secret you generate for Insight Health to sign outbound request bodies.
Technical Contact*
stringAn engineer Insight Health can reach for integration troubleshooting.
* Required field

All credentials are exchanged out-of-band and never via email. Insight Health coordinates a secure credential exchange during onboarding. Treat API keys and signing keys as secrets — store them in environment variables or a secrets manager and never commit them to source control.

Last updated on