What actions can I run in Heidi?

36 actions are available, including "Generate Clinical Codes", "Get Live Session Transcript", and "Get Patient Profile", and more. Run them from any trigger in your automation stack — map fields once and they execute automatically.

Do I need to write code to automate this?

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 it is never required.

Is the integration secure?

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

Heidi Integrations

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 and replies into CRM, chat, and escalation workflows.

Explore Documentation

GDPR
Data Encryption
2FA
Local Data Region

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.

When to use Heidi

Common scenarios where Heidi automation saves time and reduces manual work.

Automate "Generate Clinical Codes" in Heidi as a workflow step — combine it with triggers, filters, and AI steps for full-pipeline coverage.
Run "Get Live Session Transcript" in Heidi from any upstream event — map fields once and let the automation handle the rest.
Include "Get Patient Profile" from Heidi in larger multi-tool workflows to move data end-to-end without hand-offs.

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.

Heidi Integrations

When to use Heidi

Frequently asked questions

Heidi Integrations

When to use Heidi

Connect Heidi to any app in workflows

Frequently asked questions

Connect Heidi to any app in workflows

Connect Heidi to any app in workflows

Connect Heidi to any app in workflows

Heidi Integrations

Heidi triggers and actions

When to use Heidi

Frequently asked questions

What triggers does Heidi support?

What actions can I run in Heidi?

Do I need to write code to automate this?

Is the integration secure?

Heidi Integrations

Heidi triggers and actions

When to use Heidi

Connect Heidi to any app in workflows

Frequently asked questions

What triggers does Heidi support?

What actions can I run in Heidi?

Do I need to write code to automate this?

Is the integration secure?

Connect Heidi to any app in workflows

Connect Heidi to any app in workflows

Connect Heidi to any app in workflows