Heidi Integration

AI medical scribe — sessions, consult notes, and clinical documents from patient consultations. Existing AU/NZ partners only; Heidi is closed to new AU/NZ integrations. Route Heidi tickets, replies, and customer issues into CRM, chat, and escalation workflows. When Generate Clinical Codes arrives, automatically continue with Get Live Session Transcript or Get Patient Profile.

Explore Documentation

3-day trialCancel anytimeUp to 10 minutes quick set up

GDPR
Data Encryption
2FA
Local Data Region

Supported triggers and actions for Heidi integration

Triggers can detect changes in Heidi and run actions that can create, search or modify data inside Heidi automatically [3] — exactly how you set them.

Generate Clinical CodesGenerates and returns clinical codes (ICD, SNOMED, CPT and related coding systems) detected in a session. Coding must be enabled on the Heidi account.
Get Live Session TranscriptRetrieves the in-progress transcript for a session while a recording is still live.
Get Patient ProfileRetrieves detailed information about a specific patient profile by its ID.
Get SessionRetrieves a single Heidi session by its session ID, including patient details, notes, and the generated consult note.
Get Session TranscriptRetrieves the finalized transcript text for a session.
Get TeamRetrieves detailed information about a specific team.
List Organization MembersLists an organization's members, with pagination, sorting, and filtering.
List Patient ProfilesRetrieves a list of patient profiles. Optionally filter by EHR patient ID, EHR provider, or page through vendor-side pagination.
List Session AttachmentsLists the context documents attached to a session, including each document's parsing status.
List Session DocumentsRetrieves the list of documents generated for a session.
List SessionsReturns the sessions linked to the connected Heidi user, most recent first.
List TeamsLists every team the authenticated Heidi API User has joined.
List TemplatesRetrieves the list of available consult note and document templates.
Add Sessions to Patient ProfileAssociates one or more sessions with a patient profile, grouping them under a single patient's consultation history.
Ask HeidiSends a session's content to the Heidi AI Assistant along with an instruction and returns the streamed, joined response.
Convert Note to Sectional FormatConverts a session's latest consult note into a structured sectional note, keyed by section heading.
Create Account LinkLinks this Heidi API User to an existing Heidi account, for the account-linking (widget-embed) flow.
Create DocumentCreates a new document for a session from a Heidi template.
Create Patient ProfileCreates a new patient profile with the provided patient information.
Create SessionCreates a new Heidi session, optionally linked to a patient profile and an EHR appointment.
Delete Patient ProfilePermanently deletes a single patient profile by its ID. Not covered by Heidi's prose documentation — confirmed only in the Postman collection.
Delete Patient ProfilesPermanently deletes one or more patient profiles in a single batch call. This cannot be undone.
Delete Patient SessionsUnlinks one or more sessions from a patient profile. Not covered by Heidi's prose documentation — confirmed only in the Postman collection.
Delete Session AttachmentsRemoves one or more context documents from a session.
Finish RecordingMarks a segment-based transcription recording as complete.
Generate Consult NoteGenerates a consult note for a session from a Heidi template. The response is streamed by Heidi and joined into the final note text.
Generate Note from Custom TemplateGenerates a structured note for a session from a custom JSON template. Requires an existing free-text consult note for the session.
Link Note Section to EHR FieldLinks a consult note section heading to an EHR section ID so future sectional conversions report exactly where to route it.
Make an API CallPerforms an arbitrary authorized API request to the Heidi API.
Remove Account LinkUnlinks this Heidi API User from its linked Heidi account.
Transcribe Recording SegmentUploads one audio chunk to an in-progress segment-based transcription.
Transcribe Session AudioStarts a segment-based transcription job for a session and returns a recording ID.
Update Patient ProfileUpdates an existing patient profile with new information. Only the fields provided are updated.
Update SessionUpdates a Heidi session's patient details, clinician notes, language settings, and linked context sessions.
Upload Context DocumentUploads a context document (file) to a session for Heidi to parse and use as reference material. The document begins in PARSING status — poll List Session Attachments to see when it becomes READY.
Upload Session AudioUploads an audio recording to a session for transcription.

How to integrate Heidi in automation workflow?

3 simple steps to make your Heidi connected with other apps in automation workflows on WEXTL. Up to 10 minutes integration set up.

STEP 1

Select Heidi in workflow

Pick Heidi app in the workflow builder [4] - just one click to select the app.

STEP 2

Connect Heidi

When prompted, authorize access to Heidi in WEXTL once. Heidi credentials are encrypted and never shared with WEXTL. Authorization will be reused in any future API calls [3].

WEXTL wants to integrate with your Heidi account. Approve?

STEP 3

Build a workflow

Build your workflow with Heidi yourself or with WEXTL® AI Builder. Connect Heidi to any available integrations [5], or use HTTP node to go beyond them.

Heidi

How Heidi connects and integrates with WEXTL

Save and approve your credentials once — WEXTL® stores authorization information encrypted and reuses the authentication whenever Heidi app is called in workflows. That allows your support automations to run without your attention, per defined schedule [7]. Explore documentation [6] for a detailed list of fields that Heidi supports.

Full Heidi API documentation

The following table illustrates what fields Heidi integration require during authorization flow inside our workflow builder [4].

Demonstration of Heidi connection step inside WEXTL Workflow Builder [4].

Field	Type	Help
API KeyRequired	password	Issued by Heidi to partner integrations.
Admin EmailRequired	text	The admin identity this connection acts as. Heidi provisions one API User per email. Existing AU/NZ partners only — Heidi is closed to new AU/NZ integrations.

Connect Heidi to popular apps on WEXTL

Enter a name of the other app you want to sync with Heidi below. Click on selected app to explore integration options with Heidi. If the app you search for is not available in WEXTL yet, you can use HTTP node [10] instead to integrate it directly.

Example automation with Heidi integration

Select Generate Clinical Codes action from Heidi - this will be a starting point in your automation. Whenever event happens in Heidi, workflow will start [7] from Generate Clinical Codes node.

Search for Generate Consult Note, connect it as the next step of integration sequence. You can use filters between Generate Clinical Codes and Generate Consult Note, so only important data pass from Generate Clinical Codes to the next step. WEXTL gives you full control over the process of Heidi automation. All parts of workflow are visible on the canvas [4].

Heidi on WEXTL has 36 modules for crafting support automations. Explore Heidi documentation for more.

Heidi

Generate Clinical Codes

Halo

Performs action

Halo

Triggers

Heidi

Generate Consult Note

Demonstration of how visual Heidi automation [6] looks in WEXTL.

Frequently asked questions

Common questions about automating Heidi in your workflows.

Heidi has no triggers, but it provides 36 actions including "Generate Clinical Codes", "Get Live Session Transcript", and "Get Patient Profile". Pair them with triggers from other apps to automate Heidi tasks.

Integration has 36 actions, including "Generate Clinical Codes", "Get Live Session Transcript", and "Get Patient Profile", and more. Refer to our Heidi Documentation for detailed inputs and outputs.

No. Most automations are built visually on the canvas by picking triggers, actions, and mapping fields. You can add custom JavaScript with Functions when advanced logic is needed — but our customers do that in rare cases [4].

Yes. Connections are authenticated per account, credentials are encrypted at rest, and you can enforce approvals and team-level access controls on any automation.

The Heidi integration on WEXTL runs directly on its vendor public API — every field name, authentication method, and rate limit is controlled by Heidi official API and covered in documentation [3]. WEXTL handles the request signing and pagination for you.

Absolutely. Where Heidi provides native webhooks, you can use instant triggers to eliminate polling delay. For custom webhooks, WEXTL offers Custom Webhook node, so you can start automation whenever Heidi or any other service sends event to webhook URL.

WEXTL is an AI-first visual canvas. The platform allows you to describe automation in plain text — and AI will wire nodes for Heidi inside the workflow builder [4]. You can also use built-in workflow nodes (AI Agent, Human in the Loop, Condition, Aggregate Results) in pair with Heidi modules to craft complex integration flows with branches, filtering, and conditional logic. There are absolutely no limits of what you can build.

References

List of sources used to gather information about the Heidi integration.

Heidi integration source code, module specs and credentials implementation.
Internal Heidi integration documentation, structured input and output parameters, scopes, and authentication methods.
Official Heidi vendor API documentation — used to verify field meanings, authentication flows, and anything our own specs don't fully capture.
WEXTL® Visual Workflow Builder, anonymized data from our technical support team.
WEXTL® Apps Library
WEXTL® Heidi App Documentation
WEXTL® Workflow Scheduler
WEXTL® HTTP node documentation

Heidi Integration

Supported triggers and actions for Heidi integration