Requirements
Healthie requires an active account and an API access token from your account settings to connect — both are set up on its own site.[3]
Get your Healthie credentials
- API KeypasswordRequired
To get a API key, log in to your account, go to Settings → Integrations / Developer Settings, and generate an API key (or request access from Healthie support if it’s not enabled on your account).
[1] - EnvironmentselectRequired
Connect Healthie in WEXTL
- Log in to your WEXTL account, add the Healthie node module to your workflow, and click Create new credential.Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Healthie 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 →
Healthie node modules
The list below is a reference of every Healthie node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every Healthie node module below — each one opens to show its input parameters, outputs, and connection requirements.
Watch EventsTrigger
Output fields[3]
| Field | Type |
|---|---|
| User ID | number |
| Email address | |
| Name | text |
| Date created | date |
Get a Billing ItemAction
Input fields[3]
| Field | Type |
|---|---|
Billing Item IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Amount paid | text |
| Amount paid string | text |
| Application fee amount | text |
| Card source | text |
| Charge backs | array |
| Coupon code | text |
| Cpt codes super bills ID | text |
| Created at | date |
| Currency | text |
| Deleted at | text |
| Failure reason | text |
| Gifted by | text |
| Gifted to | text |
| ID | text |
| Invoice ID | text |
| Is canceled | boolean |
| Is outside payment | boolean |
| Is recurring | boolean |
| Item position number | number |
| Net payment | text |
29other output fields
Get a CommentAction
Get a ConversationAction
Input fields[3]
| Field | Type |
|---|---|
Conversation IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Closed by | text |
| Closed date | text |
| Community chat | boolean |
| Community chat prefix | text |
| Conversation memberships | array |
| Conversation memberships count | number |
| Created at | date |
| Current user conversation membership | object |
| ID | text |
| Dietitian ID | text |
| First four invitees | array |
| ID | text |
| Includes multiple clients | boolean |
| Invitees | array |
| Is hidden for client | boolean |
| Last message content | text |
| Last note viewed ID | text |
| Name | text |
| Notes | array |
| Owner | object |
| ID | text |
| Name | text |
| text | |
| Patient ID | text |
2other output fields
Get a DocumentAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | choice |
| Care Plan ID | choice |
| Course ID | text |
| Course Item ID | choice |
| Custom Module ID | text |
Output fields[3]
| Field | Type |
|---|---|
| Can only share | boolean |
| Created at | date |
| Description | text |
| Display name | text |
| Email on welcome | boolean |
| Expiring URL | text |
| Extension | text |
| File content type | text |
| Form answer groups | array |
| Friendly type | text |
| ID | text |
| Include in charting | boolean |
| Internal notes | text |
| Metadata | text |
| Opens | array |
| Owner | object |
| ID | text |
| Name | text |
| text | |
| Rel user | object |
| ID | text |
| Name | text |
| text | |
| Rel user ID | text |
| Shareable org members | object |
| Total count | number |
| Edges | array |
| Shareable patients | object |
| Total count | number |
| Edges | array |
9other output fields
Get a LocationAction
Get a NoteAction
Input fields[3]
| Field | Type |
|---|---|
Note IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Attached audio URL | text |
| Attached image URL | text |
| Content | text |
| Conversation ID | text |
| Created at | date |
| Creator | object |
| ID | text |
| Name | text |
| text | |
| Creator display name | text |
| Deleted by user | boolean |
| Document ID | text |
| Document name | text |
| ID | text |
| Image name | text |
| Is autoresponse | boolean |
| On behalf user | text |
| Recipient ID | text |
| Scheduled at | text |
| Scheduled conversation ID | text |
| Task | text |
| Updated at | date |
| User ID | text |
1other output field
Get a TaskAction
Input fields[3]
| Field | Type |
|---|---|
Task IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Assignees | object |
| Total count | number |
| Edges | array |
| Client | object |
| ID | text |
| Name | text |
| text | |
| Client ID | text |
| Complete | boolean |
| Completed at | text |
| Completed by | text |
| Completed by ID | text |
| Content | text |
| Created at | date |
| Created by generator ID | text |
| Created by ID | text |
| Creator | object |
| ID | text |
| Name | text |
| text | |
| Due date | date |
| Hidden | boolean |
| ID | text |
| Note | object |
| typename | text |
| ID | text |
| Note path | text |
| Position | number |
| Priority | number |
| Ref source | text |
7other output fields
Get a UserAction
Input fields[3]
| Field | Type |
|---|---|
User IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Shard aware ID | text |
| text | |
| First name | text |
| Last name | text |
| Name | text |
| Full name | text |
| Active | boolean |
| Is patient | boolean |
| Is org | boolean |
| Is org admin | boolean |
| Is owner | boolean |
| Created at | date |
| Updated at | date |
| Phone number | text |
| Timezone | text |
| Avatar URL | text |
| Dietitian ID | text |
| User group ID | text |
| Group name | text |
11other output fields
Get an AppointmentAction
Input fields[3]
| Field | Type |
|---|---|
Appointment IDRequired | choice |
| Include Deleted | boolean |
Output fields[3]
| Field | Type |
|---|---|
| Actual duration | number |
| Add to gcal link | text |
| Appointment category | text |
| Appointment inclusions count | number |
| Appointment label | text |
| Appointment location ID | text |
| Appointment request ID | text |
| Appointment type | object |
| ID | text |
| Name | text |
| Appointment type ID | text |
| Assigned groups | array |
| Attended clients | array |
| Attendees | array |
| Attendees on waitlist | array |
| Background color | text |
| Can be rescheduled | boolean |
| Can client cancel | boolean |
| Can client reschedule | boolean |
| Cancellation reason | text |
| Client confirmed | boolean |
| Client updating | boolean |
81other output fields
Get an Appointment RequestAction
Input fields[3]
| Field | Type |
|---|---|
Appointment Request IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Appointment location | object |
| ID | text |
| Name | text |
| Appointment type | object |
| ID | text |
| Name | text |
| Booking params | object |
| Source | text |
| Preferred language | text |
| Requested duration minutes | number |
| Notes | text |
| Closed at | text |
| Closed by | text |
| Created at | date |
| Current status | text |
| text | |
| First appointment | text |
| First name | text |
| ID | text |
| Last name | text |
| Patient | object |
| ID | text |
| Name | text |
| text | |
| Phone | text |
| Provider | object |
| ID | text |
| Name | text |
| text | |
| Provider notes | text |
| Reason | text |
| Selected contact type | text |
| Selected state | text |
| Slots | array |
1other output field
Get an AvailabilityAction
Input fields[3]
| Field | Type |
|---|---|
Availability IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Appointment location ID | text |
| Appointment type ID | number |
| Contact type ID | number |
| Created at | date |
| Day of week | number |
| Duration string | text |
| End on | text |
| ID | text |
| Is repeating | boolean |
| Origin start date | text |
| Range end | date |
| Range start | date |
| Repeating availability ID | text |
| Resource ID | text |
| Timezone abbr | text |
| Updated at | date |
| User | object |
| ID | text |
| Name | text |
| text | |
| User ID | number |
List Appointment RequestsSearch
Input fields[3]
| Field | Type |
|---|---|
| Appointment Location IDs | choice |
| Current Statuses | array |
| Status | choice |
| Range Start | date |
| Range End | date |
| Order By | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Appointment location | object |
| ID | text |
| Name | text |
| Appointment type | object |
| ID | text |
| Name | text |
| Booking params | object |
| Source | text |
| Preferred language | text |
| Requested duration minutes | number |
| Notes | text |
| Closed at | text |
| Closed by | text |
| Created at | date |
| Current status | text |
| text | |
| First appointment | text |
| First name | text |
| ID | text |
| Last name | text |
| Patient | object |
| ID | text |
| Name | text |
| text | |
| Phone | text |
| Provider | object |
| ID | text |
| Name | text |
| text | |
| Provider notes | text |
| Reason | text |
| Selected contact type | text |
| Selected state | text |
| Slots | array |
1other output field
List AppointmentsSearch
Input fields[3]
| Field | Type |
|---|---|
| Color Scheme ID | text |
| Current Week | boolean |
| End Date | date |
| Exclude Appointments with Invoice | boolean |
| Filter | choice |
| Filter by Appointment Location IDs | choice |
| Filter by Appointment Status | text |
| Filter by Appointment Statuses | array |
| Status | text |
| Filter by Appointment Type ID | choice |
| Filter by Appointment Type IDs | choice |
| Filter by Contact Types | text |
| Filter by Chart Note Written | boolean |
| Filter by Client Confirmed | boolean |
| Filter by Location ID | choice |
| Filter by Provider Confirmed | boolean |
| Filter Synced Appointments | boolean |
| Filter by Invoices | boolean |
| Use Provider Inclusions | boolean |
| Include Blockers | boolean |
| Include Nil Blockers | boolean |
25other input fields
Output fields[3]
| Field | Type |
|---|---|
| Actual duration | number |
| Add to gcal link | text |
| Appointment category | text |
| Appointment inclusions count | number |
| Appointment label | text |
| Appointment location ID | text |
| Appointment request ID | text |
| Appointment type | object |
| ID | text |
| Name | text |
| Appointment type ID | text |
| Assigned groups | array |
| Attended clients | array |
| Attendees | array |
| Attendees on waitlist | array |
| Background color | text |
| Can be rescheduled | boolean |
| Can client cancel | boolean |
| Can client reschedule | boolean |
| Cancellation reason | text |
| Client confirmed | boolean |
| Client updating | boolean |
81other output fields
List AvailabilitiesSearch
Input fields[3]
| Field | Type |
|---|---|
Appointment Location IDRequired | choice |
Appointment Type IDRequired | choice |
| Availability Provider ID | text |
| End Date | date |
| End Date Padding | number |
| Include Repeating | boolean |
| Is Organization | boolean |
| Is Repeating | boolean |
| One Time | boolean |
| Provider ID | text |
| Provider IDs | array |
| Provider ID | text |
| Include Suborganizations | boolean |
| Show Availability | boolean |
| Start Date | date |
| Start Date Padding | number |
| User ID | choice |
| Organization ID | text |
| Timezone | text |
| State License | text |
| Tag IDs | array |
| Tag ID | choice |
4other input fields
Output fields[3]
| Field | Type |
|---|---|
| Appointment location ID | text |
| Appointment type ID | number |
| Contact type ID | number |
| Created at | date |
| Day of week | number |
| Duration string | text |
| End on | text |
| ID | text |
| Is repeating | boolean |
| Origin start date | text |
| Range end | date |
| Range start | date |
| Repeating availability ID | text |
| Resource ID | text |
| Timezone abbr | text |
| Updated at | date |
| User | object |
| ID | text |
| Name | text |
| text | |
| User ID | number |
List Billing ItemsSearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | text |
User IDRequired | choice |
| Created At Start | date |
| Created At End | date |
| Keywords | text |
| Offerings Only | boolean |
| Provider ID | text |
| Sort By | text |
| Order By | choice |
| Status | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Amount paid | text |
| Amount paid string | text |
| Application fee amount | text |
| Card source | text |
| Charge backs | array |
| Coupon code | text |
| Cpt codes super bills ID | text |
| Created at | date |
| Currency | text |
| Deleted at | text |
| Failure reason | text |
| Gifted by | text |
| Gifted to | text |
| ID | text |
| Invoice ID | text |
| Is canceled | boolean |
| Is outside payment | boolean |
| Is recurring | boolean |
| Item position number | number |
| Net payment | text |
29other output fields
List CommentsSearch
List ConversationsSearch
Input fields[3]
| Field | Type |
|---|---|
| User ID | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Closed by | text |
| Closed date | text |
| Community chat | boolean |
| Community chat prefix | text |
| Conversation memberships | array |
| Conversation memberships count | number |
| Created at | date |
| Current user conversation membership | object |
| ID | text |
| Dietitian ID | text |
| First four invitees | array |
| ID | text |
| Includes multiple clients | boolean |
| Invitees | array |
| Is hidden for client | boolean |
| Last message content | text |
| Last note viewed ID | text |
| Name | text |
| Notes | array |
| Owner | object |
| ID | text |
| Name | text |
| text | |
| Patient ID | text |
2other output fields
List DocumentsSearch
Input fields[3]
| Field | Type |
|---|---|
Consolidated User IDRequired | choice |
File TypeRequired | text |
| Filter | text |
| Folder ID | choice |
| For Template Use | boolean |
| Keywords | text |
| Private User ID | choice |
| Provider ID | number |
| Viewable User ID | choice |
| Sort By | text |
| Order By | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Can only share | boolean |
| Created at | date |
| Description | text |
| Display name | text |
| Email on welcome | boolean |
| Expiring URL | text |
| Extension | text |
| File content type | text |
| Form answer groups | array |
| Friendly type | text |
| ID | text |
| Include in charting | boolean |
| Internal notes | text |
| Metadata | text |
| Opens | array |
| Owner | object |
| ID | text |
| Name | text |
| text | |
| Rel user | object |
| ID | text |
| Name | text |
| text | |
| Rel user ID | text |
| Shareable org members | object |
| Total count | number |
| Edges | array |
| Shareable patients | object |
| Total count | number |
| Edges | array |
9other output fields
List LocationsSearch
Input fields[3]
| Field | Type |
|---|---|
Has NameRequired | boolean |
Has Service FacilitiesRequired | boolean |
| Keywords | text |
| User ID | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| City | text |
| Country | text |
| ID | text |
| Line 1 | text |
| Line 2 | text |
| Name | text |
| Npi | text |
| Other ID | text |
| Other ID qual | text |
| Place of service | object |
| typename | text |
| ID | text |
| Place of service ID | text |
| State | text |
| To oneline | text |
| User | object |
| ID | text |
| Name | text |
| text | |
| User ID | text |
| Zip | text |
List NotesSearch
Input fields[3]
| Field | Type |
|---|---|
| Conversation ID | choice |
| IDs | choice |
| Keywords | text |
| Organizational Chat | boolean |
| Provider ID | text |
| Scheduled Notes | boolean |
| Since Note ID | choice |
| Sort By | text |
| Order By | choice |
| With Tasks | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Attached audio URL | text |
| Attached image URL | text |
| Content | text |
| Conversation ID | text |
| Created at | date |
| Creator | object |
| ID | text |
| Name | text |
| text | |
| Creator display name | text |
| Deleted by user | boolean |
| Document ID | text |
| Document name | text |
| ID | text |
| Image name | text |
| Is autoresponse | boolean |
| On behalf user | text |
| Recipient ID | text |
| Scheduled at | text |
| Scheduled conversation ID | text |
| Task | text |
| Updated at | date |
| User ID | text |
1other output field
List TasksSearch
Input fields[3]
| Field | Type |
|---|---|
Client IDRequired | text |
| Assigned To User | boolean |
| Assignees | choice |
| Completed Status | text |
| Created By Self | boolean |
| Keywords | text |
| Show Hidden | boolean |
| Smart | boolean |
| Type | text |
| Sort By | text |
| Order By | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Assignees | object |
| Total count | number |
| Edges | array |
| Client | object |
| ID | text |
| Name | text |
| text | |
| Client ID | text |
| Complete | boolean |
| Completed at | text |
| Completed by | text |
| Completed by ID | text |
| Content | text |
| Created at | date |
| Created by generator ID | text |
| Created by ID | text |
| Creator | object |
| ID | text |
| Name | text |
| text | |
| Due date | date |
| Hidden | boolean |
| ID | text |
| Note | object |
| typename | text |
| ID | text |
| Note path | text |
| Position | number |
| Priority | number |
| Ref source | text |
7other output fields
List TransactionsSearch
List UsersSearch
Input fields[3]
| Field | Type |
|---|---|
| Active Status | choice |
| Conversation ID | choice |
| Convo Patients Only | boolean |
| Expect Conversation ID | boolean |
| From Superadmin | boolean |
| Group ID | text |
| Has Credit Card On File | boolean |
| ID | text |
| IDs | choice |
| Keywords | text |
| Limited To Provider | boolean |
| Provider ID | text |
| Show All By Default | boolean |
| Sort By | choice |
| Order By | choice |
| Tag IDs | choice |
| With Feature Toggles | boolean |
| Include Suborg Patients | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Shard aware ID | text |
| text | |
| First name | text |
| Last name | text |
| Name | text |
| Full name | text |
| Active | boolean |
| Is patient | boolean |
| Is org | boolean |
| Is org admin | boolean |
| Is owner | boolean |
| Created at | date |
| Updated at | date |
| Phone number | text |
| Timezone | text |
| Avatar URL | text |
| Dietitian ID | text |
| User group ID | text |
| Group name | text |
11other output fields
Create a Billing ItemAction
Input fields[3]
| Field | Type |
|---|---|
| Amount Paid | text |
| Created At | date |
| Metadata | array |
KeyRequired | text |
| Value | text |
| Note | text |
| Offering Coupon ID | choice |
| Offering ID | choice |
| Payment Due Date | date |
| Payment Medium | text |
| Recipient ID | choice |
| Requested Payer ID | choice |
| Requested Payment ID | text |
| Sender ID | choice |
| Should Charge | boolean |
| Stripe Customer Detail ID | text |
| Stripe Idempotency Key | text |
| User Package Selection ID | text |
Output fields[3]
| Field | Type |
|---|---|
| Billing Item | object |
| Amount paid | text |
| Amount paid string | text |
| Application fee amount | text |
| Card source | text |
| Charge backs | array |
| Coupon code | text |
| Cpt codes super bills ID | text |
| Created at | date |
| Currency | text |
| Deleted at | text |
| Messages | array |
Create a CommentAction
Create a ConversationAction
Input fields[3]
| Field | Type |
|---|---|
| Appointment ID | choice |
| Owner ID | choice |
| Added Users | array |
| Note | object |
| Title | text |
| Content | text |
| Select All Status | text |
| Simple Added Users | text |
| Name | text |
Output fields[3]
| Field | Type |
|---|---|
| Conversation | object |
| Closed by | text |
| Closed date | text |
| Community chat | boolean |
| Community chat prefix | text |
| Conversation memberships | array |
| Conversation memberships count | number |
| Created at | date |
| Current user conversation membership | object |
| Dietitian ID | text |
| First four invitees | array |
| Messages | array |
Create a DocumentAction
Input fields[3]
| Field | Type |
|---|---|
Care Plan IDRequired | choice |
Clients IDsRequired | array |
| Client ID | number |
Course IDRequired | number |
| Description | text |
| Display Name | text |
| File | text |
| File String | text |
| Folder ID | choice |
| From Date | date |
| From Program Create | boolean |
| Generate CCDA for Rel User ID | boolean |
| Generate Human Readable CCDA for Rel User ID | boolean |
| Include in Charting | boolean |
| Is Photo ID | boolean |
| On Form for User ID | number |
| Org Level | boolean |
| Payout ID | number |
| Provider IDs | array |
| Provider ID | number |
| RCF ID | number |
| Rel User ID | number |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
| Document | object |
| Can only share | boolean |
| Created at | date |
| Description | text |
| Display name | text |
| Email on welcome | boolean |
| Expiring URL | text |
| Extension | text |
| File content type | text |
| Form answer groups | array |
| Friendly type | text |
| Messages | array |
Create a LocationAction
Input fields[3]
| Field | Type |
|---|---|
| User ID | choice |
| Place of Service ID | text |
| NPI | text |
| Other ID | text |
| Other ID Qualifier | text |
| Name | text |
| Address Line 1 | text |
| Address Line 2 | text |
| City | text |
| State | text |
| Zip Code | text |
| Country | text |
Output fields[3]
| Field | Type |
|---|---|
| Location | object |
| City | text |
| Country | text |
| ID | text |
| Line 1 | text |
| Line 2 | text |
| Name | text |
| Npi | text |
| Other ID | text |
| Other ID qual | text |
| Place of service | object |
| Messages | array |
Create a NoteAction
Input fields[3]
| Field | Type |
|---|---|
Conversation IDRequired | choice |
| Attached Audio | text |
| Attached Document | text |
| Attached Image | text |
| Attached Image String | text |
| Content | text |
| Created At | date |
| Hide Org Chat Confirmation | boolean |
| Organization Chat | boolean |
| Scheduled At | date |
| Updated At | date |
| User ID | choice |
Output fields[3]
| Field | Type |
|---|---|
| Note | object |
| Attached audio URL | text |
| Attached image URL | text |
| Content | text |
| Conversation ID | text |
| Created at | date |
| Creator | object |
| Creator display name | text |
| Deleted by user | boolean |
| Document ID | text |
| Document name | text |
| Messages | array |
Create a TaskAction
Input fields[3]
| Field | Type |
|---|---|
| Assignee IDs | choice |
| Client ID | text |
| Complete | boolean |
| Completed By ID | choice |
| Content | text |
| Created By ID | text |
| Due Date | date |
| Note ID | choice |
| Priority | number |
| Reminder | object |
| Is Enabled | boolean |
| Reminder ID | text |
| Interval Type | choice |
| Interval Value | text |
| Reminder Time | number |
| Remove Reminder | boolean |
| Seen | boolean |
Output fields[3]
| Field | Type |
|---|---|
| Task | object |
| Assignees | object |
| Client | object |
| Client ID | text |
| Complete | boolean |
| Completed at | text |
| Completed by | text |
| Completed by ID | text |
| Content | text |
| Created at | date |
| Created by generator ID | text |
| Messages | array |
Create an AppointmentAction
Input fields[3]
| Field | Type |
|---|---|
Appointment Location IDRequired | choice |
Appointment Type IDRequired | choice |
User IDRequired | choice |
| Contact Type | text |
| Datetime | date |
| Timezone | time |
| Appointment Request ID | choice |
| Attendee IDs | choice |
| CPT Code ID | text |
| Date | date |
| End Date | date |
| End Time | time |
| Exclude No Credits | boolean |
| External Video Chat URL | url |
| Insurance Billing Enabled | boolean |
| Is Blocker | boolean |
| Is Zoom Chat | boolean |
| Location | text |
| Max Attendees | text |
| Metadata | array |
KeyRequired | text |
| Value | text |
10other input fields
Output fields[3]
| Field | Type |
|---|---|
| Apppointment | object |
| Actual duration | number |
| Add to gcal link | text |
| Appointment category | text |
| Appointment inclusions count | number |
| Appointment label | text |
| Appointment location ID | text |
| Appointment request ID | text |
| Appointment type | object |
| Appointment type ID | text |
| Assigned groups | array |
| Messages | array |
Create an Appointment RequestAction
Input fields[3]
| Field | Type |
|---|---|
TimezoneRequired | time |
ReasonRequired | text |
| Organization ID | text |
| First Name | text |
| Last Name | text |
| Phone | text |
| Provider ID | text |
| Patient ID | text |
| Appointment Type ID | choice |
| Appointment Location ID | choice |
| Selected Contact Type | text |
| Selected State | text |
| Slots | array |
| Booking Parameters | array |
KeyRequired | text |
| Value | text |
| Should Assign Provider | boolean |
Output fields[3]
| Field | Type |
|---|---|
| Apppointment Request | object |
| Appointment location | object |
| Appointment type | object |
| Booking params | object |
| Closed at | text |
| Closed by | text |
| Created at | date |
| Current status | text |
| text | |
| First appointment | text |
| First name | text |
| Messages | array |
Create an AvailabilityAction
Input fields[3]
| Field | Type |
|---|---|
Appointment Location IDRequired | choice |
Appointment Type IDRequired | choice |
| Contact Type ID | choice |
| User ID | choice |
| Day of Week | number |
| End On | text |
| End Time | time |
| Is Repeating | boolean |
| Range Start | date |
| Time | time |
| Timezone | time |
| End DateTime | text |
| Range End | date |
| Start DateTime | text |
Output fields[3]
| Field | Type |
|---|---|
| Availability | object |
| Appointment location ID | text |
| Appointment type ID | number |
| Contact type ID | number |
| Created at | date |
| Day of week | number |
| Duration string | text |
| End on | text |
| ID | text |
| Is repeating | boolean |
| Origin start date | text |
| Messages | array |
Delete a Billing ItemAction
Delete a CommentAction
Delete a DocumentAction
Delete a LocationAction
Delete a NoteAction
Delete a TaskAction
Delete an AppointmentAction
Input fields[3]
| Field | Type |
|---|---|
Appointment IDRequired | choice |
| Appointment Inclusion UUID | text |
| Delete Recurring | boolean |
| Cancellation Reason | object |
| Reason ID | text |
| Other Cancellation Reason | text |
Output fields[3]
| Field | Type |
|---|---|
| Apppointment | object |
| Actual duration | number |
| Add to gcal link | text |
| Appointment category | text |
| Appointment inclusions count | number |
| Appointment label | text |
| Appointment location ID | text |
| Appointment request ID | text |
| Appointment type | object |
| Appointment type ID | text |
| Assigned groups | array |
| Messages | array |
Delete an Appointment RequestAction
Delete an AvailabilityAction
Make an API Calluniversal
Update a Billing ItemAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | choice |
| Amount Paid | text |
| Chosen Refund Amount | text |
| Created At | date |
| Is Canceled | boolean |
| Is Paused | boolean |
| Metadata | array |
KeyRequired | text |
| Value | text |
| New Payment Date | date |
| Note | text |
| Payment Medium | text |
| Recipient ID | text |
| Resend Payment | boolean |
| Resend Receipt | boolean |
| Sender ID | text |
| Stripe Idempotency Key | text |
Output fields[3]
| Field | Type |
|---|---|
| Billing Item | object |
| Amount paid | text |
| Amount paid string | text |
| Application fee amount | text |
| Card source | text |
| Charge backs | array |
| Coupon code | text |
| Cpt codes super bills ID | text |
| Created at | date |
| Currency | text |
| Deleted at | text |
| Messages | array |
Update a ConversationAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | choice |
| Closed By ID | choice |
| Hide Close Confirmation | boolean |
| Name | text |
| Select All Status | text |
| Simple Added Users | text |
Output fields[3]
| Field | Type |
|---|---|
| Conversation | object |
| Closed by | text |
| Closed date | text |
| Community chat | boolean |
| Community chat prefix | text |
| Conversation memberships | array |
| Conversation memberships count | number |
| Created at | date |
| Current user conversation membership | object |
| Dietitian ID | text |
| First four invitees | array |
| Messages | array |
Update a DocumentAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | choice |
| Care Plan ID | choice |
| Related User ID | choice |
| Folder ID | choice |
| Share Users | array |
| Doc Share ID | number |
| Description | text |
| Display Name | text |
| Email on Welcome | boolean |
| Include in Charting | boolean |
| Internal Notes | text |
| Metadata | array |
KeyRequired | text |
| Value | text |
| Parse CCDA | boolean |
| Share with Related | boolean |
| Shared on Welcome | boolean |
| Shared with Dietitians | boolean |
Output fields[3]
| Field | Type |
|---|---|
| Document | object |
| Can only share | boolean |
| Created at | date |
| Description | text |
| Display name | text |
| Email on welcome | boolean |
| Expiring URL | text |
| Extension | text |
| File content type | text |
| Form answer groups | array |
| Friendly type | text |
| Messages | array |
Update a LocationAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | choice |
| User ID | choice |
| Place of Service ID | text |
| NPI | text |
| Other ID | text |
| Other ID Qualifier | text |
| Name | text |
| Address Line 1 | text |
| Address Line 2 | text |
| City | text |
| State | text |
| Zip Code | text |
| Country | text |
Output fields[3]
| Field | Type |
|---|---|
| Location | object |
| City | text |
| Country | text |
| ID | text |
| Line 1 | text |
| Line 2 | text |
| Name | text |
| Npi | text |
| Other ID | text |
| Other ID qual | text |
| Place of service | object |
| Messages | array |
Update a NoteAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | choice |
| User ID | choice |
| Conversation ID | choice |
| Content | text |
| Scheduled At | date |
| Attached Audio | text |
| Attached Document | text |
| Attached Image | text |
| Attached Image String | text |
Output fields[3]
| Field | Type |
|---|---|
| Note | object |
| Attached audio URL | text |
| Attached image URL | text |
| Content | text |
| Conversation ID | text |
| Created at | date |
| Creator | object |
| Creator display name | text |
| Deleted by user | boolean |
| Document ID | text |
| Document name | text |
| Messages | array |
Update a TaskAction
Input fields[3]
| Field | Type |
|---|---|
| Task ID | choice |
| Client ID | text |
| Content | text |
| Assignee IDs | choice |
| Complete | boolean |
| Completed By ID | text |
| Created By ID | text |
| Due Date | date |
| Hidden | boolean |
| Position | number |
| Priority | number |
| Reminder | object |
| Reminder ID | text |
| Interval Type | choice |
| Interval Value | text |
| Is Enabled | boolean |
| Reminder Time | number |
| Remove Reminder | boolean |
| Seen | boolean |
Output fields[3]
| Field | Type |
|---|---|
| Task | object |
| Assignees | object |
| Client | object |
| Client ID | text |
| Complete | boolean |
| Completed at | text |
| Completed by | text |
| Completed by ID | text |
| Content | text |
| Created at | date |
| Created by generator ID | text |
| Messages | array |
Update a UserAction
Input fields[3]
| Field | Type |
|---|---|
| User ID | choice |
| Active Care Plan ID | choice |
| Assign Tasks Seen | boolean |
| Avatar | text |
| Avatar String | text |
| Blast Seen | boolean |
| Card Type Label | text |
| Consented to Labs | boolean |
| Current Email | |
| Current Password | text |
| Default Onboarding Flow ID | text |
| Dismissed Calendar Prompt | boolean |
| Dismissed Charting Note Addendum Warning | boolean |
| Dismissed Insurance Eligibility Warning | boolean |
| Dismissed Fullscript | boolean |
| Dismissed Products Tab | boolean |
| Date of Birth | text |
| First Name | text |
| Gender | text |
31other input fields
Output fields[3]
| Field | Type |
|---|---|
| User | object |
| ID | text |
| Shard aware ID | text |
| text | |
| First name | text |
| Last name | text |
| Name | text |
| Full name | text |
| Active | boolean |
| Is patient | boolean |
| Is org | boolean |
| Messages | array |
Update an AppointmentAction
Input fields[3]
| Field | Type |
|---|---|
Appointment IDRequired | choice |
Appointment Location IDRequired | choice |
Appointment Type IDRequired | choice |
DateRequired | date |
| Date and Time | date |
| Time | time |
| End Date | date |
| End Time | time |
| Timezone | time |
| Attended Clients | array |
| Attended Client ID | text |
| Attendee IDs | choice |
| Cancellation Reason ID | text |
| Cancellation Initiated By | choice |
| Client Confirmed | boolean |
| Confirmed | boolean |
| Contact Type | text |
| CPT Code ID | text |
| External Video Chat URL | url |
| Insurance Billing Enabled | boolean |
| Is Blocker | boolean |
17other input fields
Output fields[3]
| Field | Type |
|---|---|
| Apppointment | object |
| Actual duration | number |
| Add to gcal link | text |
| Appointment category | text |
| Appointment inclusions count | number |
| Appointment label | text |
| Appointment location ID | text |
| Appointment request ID | text |
| Appointment type | object |
| Appointment type ID | text |
| Assigned groups | array |
| Messages | array |
Update an Appointment RequestAction
Input fields[3]
| Field | Type |
|---|---|
IDRequired | choice |
| Patient ID | text |
| Status | choice |
| Provider Notes | text |
Output fields[3]
| Field | Type |
|---|---|
| Apppointment Request | object |
| Appointment location | object |
| Appointment type | object |
| Booking params | object |
| Closed at | text |
| Closed by | text |
| Created at | date |
| Current status | text |
| text | |
| First appointment | text |
| First name | text |
| Messages | array |
Templates
Look for Healthie templates in the WEXTL template library.
Browse templates →Explore alternative apps
- EasyPractice[2]Practice management software for clinics to schedule appointments, manage clients, and send invoices.
- ClinikoPractice management for healthcare providers — appointments, notes, and billing.
- DentallyBrowser-based dental practice software with charting, recalls, and NHS or private workflows.
- ChatwootOpen-source customer engagement platform for shared inboxes, live chat, and support workflows.
- AlfaDocsPractice management for dental clinics — patients, appointments, and records.
References
- WEXTL® Healthie Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Healthie.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:11