Heidi - Apps Documentation

Requirements

To use Heidi on WEXTL you need an active account and OAuth client credentials, granted by signing in with your account.[3]

Get your Heidi credentials

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

API KeypasswordRequired
Issued by Heidi to partner integrations.
[1]
Admin EmailtextRequired
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.
[1]

Connect Heidi in WEXTL

Log in to your WEXTL account, add the Heidi node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Heidi account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Heidi node modules

The list below is a reference of every Heidi node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Open any Heidi node module below to inspect its input parameters, outputs, and connection requirements.

Generate Clinical CodesSearch

Input fields[3]

Field	Type
Session IDRequired	choice

Output fields[3]

Field	Type
ID	text
Session ID	text
Consult note ID	text
Clinical entities	array
Created at	date
Updated at	date
Feedback	text

Get Live Session TranscriptSearch

Input fields[3]

Field	Type
Session IDRequired	choice
Recording Status	choice

Output fields[3]

Field	Type
User Uploaded Chunks	array
Live Chunks	array
Backup Chunks	array
Transcript In Use	text
Transcript	text

Get Patient ProfileSearch

Input fields[3]

Field	Type
Patient Profile IDRequired	choice

Output fields[3]

Field	Type
ID	text
EHR Patient ID	text
Managed By	text
First Name	text
Last Name	text
Birth Date	date
Gender	text
Phone	text
Email	text
Demographic String	text
Additional Context	text

Get SessionSearch

Input fields[3]

Field	Type
Session IDRequired	choice

Output fields[3]

Field	Type
Session ID	text
Session name	text
Patient	object
Name	text
Gender	text
Date of birth	date
Audio	array
Clinician notes	array
Consult note	object
Status	text
Result	text
Heading	text
Brain	text
Voice style	text
Generation method	text
Template ID	text
AI command ID	text
AI command text	text
Feedback	text
Duration	number
Created at	date
Updated at	date
Language code	text
Output language code	text
Documents	array
EHR appointment ID	text
EHR provider	text
EHR patient ID	text

Get Session TranscriptSearch

Input fields[3]

Field	Type
Session IDRequired	choice

Output fields[3]

Field	Type
Transcript	text

Get TeamSearch

Input fields[3]

Field	Type
Team IDRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
Country	text
Is subscribed	boolean
Subscribed plan	text
Tier	text
Plan cycle	text
Organization ID	text
Organization name	text

List Organization MembersSearch

Input fields[3]

Field	Type
Organization IDRequired	text
Page	number
Page Size	number
Order By	text
Descending Order	boolean
Search	text
Role IDs	text
Team IDs	text
Specialty IDs	text
Show Pending Invitations Only	boolean
Limit	number

Output fields[3]

Field	Type
ID	text
Team ID	text
Team name	text
User role	text
Name	text
Email	text
Specialty	text
Specialty ID	text
Country	text
Invitation accepted	boolean
Is team owner	boolean
Invitation expires at	date

List Patient ProfilesSearch

Input fields[3]

Field	Type
EHR Patient ID	text
EHR Provider	text
Page	number
Page Size	number
Limit	number

Output fields[3]

Field	Type
ID	text
EHR Patient ID	text
Managed By	text
First Name	text
Last Name	text
Birth Date	date
Gender	text
Phone	text
Email	text
Demographic String	text
Remember Consent	boolean
Additional Context	text
Session Count	number

List Session AttachmentsSearch

Input fields[3]

Field	Type
Session IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
User ID	text
Session ID	text
Name	text
Date	date
Type	text
Content	text
Status	text
Additional context	text
Unstructured	boolean

List Session DocumentsSearch

Input fields[3]

Field	Type
Session IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Session ID	text
Index	number
Name	text
Template ID	text
Content	text
Generation type	text
Brain	text

List SessionsSearch

Input fields[3]

Field	Type
Page Size	number
Limit	number

Output fields[3]

Field	Type
Session ID	text
Session name	text
Patient	object
Name	text
Gender	text
Date of birth	date
Audio	array
Clinician notes	array
Consult note	object
Status	text
Result	text
Heading	text
Brain	text
Voice style	text
Generation method	text
Template ID	text
AI command ID	text
AI command text	text
Feedback	text
Duration	number
Created at	date
Updated at	date
Language code	text
Output language code	text
Documents	array
EHR appointment ID	text
EHR provider	text
EHR patient ID	text

List TeamsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Team ID	text
Team name	text
User role	text
Free trial end date	date
Joined at	date
Member count	number

List TemplatesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Structure template	text
Template category	text
Template HTML	text
Author name	text

Add Sessions to Patient ProfileAction

Input fields[3]

Field	Type
Patient Profile IDRequired	choice
Session IDsRequired	choice

Output fields[3]

Field	Type
Sessions	array

Ask HeidiAction

Input fields[3]

Field	Type
Session IDRequired	choice
InstructionRequired	text
ContentRequired	text
Content Type	choice

Output fields[3]

Field	Type
Answer	text

Convert Note to Sectional FormatAction

Input fields[3]

Field	Type
Session IDRequired	choice

Output fields[3]

Field	Type
Sectional Note (by section heading)	text

Create Account LinkAction

Input fields[3]

Field	Type
Kinde User IDRequired	text

Create DocumentAction

Input fields[3]

Field	Type
Session IDRequired	choice
TemplateRequired	choice
Voice Style	choice
BrainRequired	choice
Content Type	choice

Output fields[3]

Field	Type
ID	text
Session ID	text
Name	text
Template ID	text
Brain	text
Voice style	text
Content type	text
Content	text

Create Patient ProfileAction

Input fields[3]

Field	Type
First Name	text
Last Name	text
Birth Date	date
Gender	choice
EHR Patient ID	text
Phone	text
Email	email
Patient Sex Code	number
Identifiers	array
Demographic String	text
Additional Context	text

Output fields[3]

Field	Type
ID	text
EHR Patient ID	text
First Name	text
Last Name	text
Birth Date	date
Gender	text
Phone	text
Email	text
Demographic String	text
Additional Context	text

Create SessionAction

Input fields[3]

Field	Type
Patient Profile	choice
EHR Appointment ID	text

Output fields[3]

Field	Type
Session ID	text

Delete Patient ProfileAction

Input fields[3]

Field	Type
Patient Profile IDRequired	choice

Delete Patient ProfilesAction

Input fields[3]

Field	Type
Patient Profile IDsRequired	choice

Output fields[3]

Field	Type
Success	boolean

Delete Patient SessionsAction

Input fields[3]

Field	Type
Patient Profile IDRequired	choice
Session IDsRequired	choice

Delete Session AttachmentsAction

Input fields[3]

Field	Type
Session IDRequired	choice

Output fields[3]

Field	Type
Success	boolean

Finish RecordingAction

Input fields[3]

Field	Type
Session IDRequired	choice
Recording IDRequired	text

Output fields[3]

Field	Type
Is Success	boolean

Generate Consult NoteAction

Input fields[3]

Field	Type
Session IDRequired	choice
TemplateRequired	choice
Voice StyleRequired	choice
BrainRequired	choice
Content Type	choice
Addition	text

Output fields[3]

Field	Type
Consult Note	text

Generate Note from Custom TemplateAction

Input fields[3]

Field	Type
Session IDRequired	choice
Custom Template (JSON)Required	text

Output fields[3]

Field	Type
Result	text

Link Note Section to EHR FieldAction

Input fields[3]

Field	Type
Session IDRequired	choice
Section HeadingRequired	text
Linked EHR Section IDRequired	text

Output fields[3]

Field	Type
Updated Consult Note	text

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Remove Account LinkAction

No fields documented.

Transcribe Recording SegmentAction

Input fields[3]

Field	Type
Session IDRequired	choice
Recording IDRequired	text
Audio ChunkRequired	text
Chunk IndexRequired	number

Output fields[3]

Field	Type
Is Success	boolean

Transcribe Session AudioAction

Input fields[3]

Field	Type
Session IDRequired	choice

Output fields[3]

Field	Type
Recording ID	text

Update Patient ProfileAction

Input fields[3]

Field	Type
Patient Profile IDRequired	choice
First Name	text
Last Name	text
Birth Date	date
Gender	choice
Phone	text
Email	email
Identifiers	array
Demographic String	text
Remember Consent	boolean
Additional Context	text

Output fields[3]

Field	Type
ID	text
Source	text
EHR Patient ID	text
First Name	text
Last Name	text
Birth Date	date
Gender	text
Phone	text
Email	text
Demographic String	text
Additional Context	text

Update SessionAction

Input fields[3]

Field	Type
Session IDRequired	choice
Duration	number
Language Code	text
Output Language Code	text
Transcribe Mode	text
Patient	object
Name	text
Gender	choice
Date of Birth	date
Demographic Details	text
Clinician Notes	array
Note	text
EHR Patient ID	text
EHR Appointment ID	text
Generate Output Without Recording	boolean
Recording Status	text
Session Status	text
Consent Given	boolean
Created Time (Local)	text
Linked Sessions for Context	choice

Output fields[3]

Field	Type
Session ID	text
Session name	text
Patient	object
Name	text
Gender	text
Date of birth	date
Audio	array
Clinician notes	array
Consult note	object
Status	text
Result	text
Heading	text
Brain	text
Voice style	text
Generation method	text
Template ID	text
AI command ID	text
AI command text	text
Feedback	text
Duration	number
Created at	date
Updated at	date
Language code	text
Output language code	text
Documents	array
EHR appointment ID	text
EHR provider	text
EHR patient ID	text

Upload Context DocumentAction

Input fields[3]

Field	Type
Session IDRequired	choice
FileRequired	text
File name	text
Name	text
Date	date
Additional Context	text
Unstructured Document	boolean

Output fields[3]

Field	Type
ID	text
User ID	text
Session ID	text
Name	text
Date	date
Type	text
Content	text
Status	text
Additional context	text
Unstructured	boolean

Upload Session AudioAction

Input fields[3]

Field	Type
Session IDRequired	choice
Audio FileRequired	text
Recording Start Time	date
Recording End Time	date

Output fields[3]

Field	Type
Uploaded Audio	object
ID	text
Index	number
Status	text
Created At	text
Access URL	text
Expiry	text

Templates

Look for Heidi templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Support category →

References

WEXTL® Heidi Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Heidi.
WEXTL® visual workflow builder data.

Last updated: Aug 19, 2026 08:38

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.