Heartbeat icon

Heartbeat

Community platform for memberships, channels, direct messages, and member engagement.

1 trigger5 searches11 actionsInstant (webhooks)Auth: API key

AI-assisted documentation6 min read

This documentation is compiled from our integration source code, internal specs for Heartbeat, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Heartbeat on WEXTL →

To use Heartbeat on WEXTL you need an active account and an API access token from your account settings.[3]

  • API KeypasswordRequired

    To generate an API key, visit Settings > API Keys and click the “Create API Key” button.

    [1]
  1. Log in to your WEXTL account, add the Heartbeat 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.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Heartbeat account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Connecting Heartbeat to WEXTL®
Video slide demonstrates how to integrate Heartbeat in the WEXTL visual workflow builder.[4]

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 →

Watch EventsTrigger

No fields documented.

Get a UserAction
Input fields[3]
FieldType
User IDRequired
choice
Output fields[3]
FieldType
IDtext
Emailemail
Nametext
First Nametext
Last Nametext
Roletext
Is Adminboolean
Groupsarray
Onboarding Responsesarray
Biotext
Avatartext
Linked In Summarytext
Linked In Dataobject
Profile URLurl
Headlinetext
Companytext
Descriptiontext
Locationtext
Jobsarray
Schoolsarray
Skillsarray
List ChannelsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Emojitext
Typetext
List Chat HistorySearch
Input fields[3]
FieldType
Chat IDRequired
text
Limitnumber
Output fields[3]
FieldType
IDtext
User IDtext
Contenttext
Imagesarray
Filesarray
Created atdate
List UsersSearch
Input fields[3]
FieldType
Limitnumber
Emailemail
Output fields[3]
FieldType
IDtext
Emailemail
Nametext
First Nametext
Last Nametext
Roletext
Is Adminboolean
Groupsarray
Onboarding Responsesarray
Biotext
Avatartext
Linked In Summarytext
Linked In Dataobject
Profile URLurl
Headlinetext
Companytext
Descriptiontext
Locationtext
Jobsarray
Schoolsarray
Skillsarray
Search UsersSearch
Input fields[3]
FieldType
EmailRequired
email
Limitnumber
Output fields[3]
FieldType
IDtext
Emailemail
Nametext
First Nametext
Last Nametext
Roletext
Is Adminboolean
Groupsarray
Onboarding Responsesarray
Biotext
Avatartext
Linked In Summarytext
Linked In Dataobject
Profile URLurl
Headlinetext
Companytext
Descriptiontext
Locationtext
Jobsarray
Schoolsarray
Skillsarray
Create a CommentAction
Input fields[3]
FieldType
TextRequired
text
Thread IDRequired
text
Parent Comment IDRequired
text
User IDchoice
Output fields[3]
FieldType
IDtext
User IDtext
Contenttext
Imagesarray
Filesarray
Created atdate
Childrenarray
Create a Direct ChatAction
Input fields[3]
FieldType
User ID 1Required
choice
User ID 2choice
Output fields[3]
FieldType
Chat IDtext
URLurl
Create a ThreadAction
Input fields[3]
FieldType
Channel IDRequired
choice
TextRequired
text
User IDchoice
Output fields[3]
FieldType
IDtext
Channel IDtext
User IDtext
Contenttext
Filesarray
Created atdate
Urltext
Commentsarray
Create a UserAction
Input fields[3]
FieldType
EmailRequired
email
Full NameRequired
text
Role IDRequired
choice
Group IDschoice
UUIDtext
Profile Picturetext
Biotext
Statustext
LinkedInurl
Twitterurl
Instagramurl
Create Introduction Threadboolean
Output fields[3]
FieldType
IDtext
Emailtext
Nametext
First Nametext
Last Nametext
Roletext
Is Adminboolean
Groupsarray
Onboarding Responsesarray
Biotext
Avatartext
Linked In Summarytext
Linked In Dataobject
Profile Urltext
Headlinetext
Companytext
Descriptiontext
Locationtext
Jobsarray
Schoolsarray
Skillsarray
Create an InvitationAction
Input fields[3]
FieldType
Group IDschoice
Role IDRequired
choice
Output fields[3]
FieldType
IDtext
Codetext
Roleobject
IDtext
Nametext
Groupsarray
Delete a ChannelAction
Input fields[3]
FieldType
Channel IDRequired
choice
TextRequired
text
User IDchoice
Delete a UserAction
Input fields[3]
FieldType
User EmailRequired
email
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Reactivate a UserAction
Input fields[3]
FieldType
User EmailRequired
email
Send a Channel MessageAction
Input fields[3]
FieldType
Channel IDRequired
choice
TextRequired
text
Fromchoice
Output fields[3]
FieldType
IDtext
User IDtext
Contenttext
Imagesarray
Filesarray
Created atdate
Send a Direct MessageAction
Input fields[3]
FieldType
TextRequired
text
ToRequired
choice
Fromchoice
Output fields[3]
FieldType
IDtext
User IDtext
Contenttext
Imagesarray
Filesarray
Created atdate

Look for Heartbeat templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Heartbeat Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Heartbeat.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:11