Requirements To use Heyy on WEXTL you need an active account and an API access token from your account settings.[3] https://heyy.io
Get your Heyy credentials API Key password Required In Heyy, open Settings, then API Keys, create a key and paste it here. Every request with this key can reach your whole workspace.[1]
Connect Heyy in WEXTL Log in to your WEXTL account, add the Heyy 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 Heyy 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 →
Heyy triggers and actions on WEXTL The list below is a reference of every Heyy node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any Heyy node module below to inspect its input parameters, outputs, and connection requirements.
Watch Events (Instant) Trigger Instant trigger for Heyy webhook events. Output fields[3] Field Type Delivery ID text Event text Message text
Watch New Chats Trigger Checks for new conversations on a schedule. Output fields[3] Field Type ID text Status text Is Unread boolean Open Until date Unread Count number Channel ID text Contact ID text Handle ID text Latest Message text Created At date Updated At date
Watch New Contacts Trigger Picks up each newly added contact on a poll. Output fields[3] Field Type ID text First Name text Last Name text Full Name text Is Subscribed boolean Handles array Labels array Attributes array Created At date Updated At date
Get a Campaign Search Reads how a campaign is scheduled and when it last ran. Input fields[3] Field Type CampaignRequired
choice
Output fields[3] Field Type ID text Name text Automation ID text Recurrence text Scheduled At date Variables text Latest Execution ID text Latest Execution text Group ID text Created At date Updated At date
Get a Channel Search Reads the type and vendor of a messaging channel. Input fields[3] Field Type ChannelRequired
choice
Output fields[3] Field Type ID text Name text Type text Status text Vendor text Vendor ID text Created At date Updated At date
Get a Chat Search Reads whether a conversation has unread messages. Input fields[3] Field Type ChatRequired
choice
Output fields[3] Field Type ID text Status text Is Unread boolean Open Until date Unread Count number Channel ID text Contact ID text Handle ID text Latest Message text Created At date Updated At date
Get a Contact Search Reads a contact profile with its subscription state. Input fields[3] Field Type ContactRequired
choice
Output fields[3] Field Type ID text First Name text Last Name text Full Name text Is Subscribed boolean Handles array Labels array Attributes array Created At date Updated At date
Get a File Search Reads the name, type and size of an uploaded file. Input fields[3] Field Type File IDRequired
text
Output fields[3] Field Type ID text Created At date Type text Name text Content Type text URL text Size number
Get a Journey Search Reads the steps and state of a journey. Input fields[3] Field Type JourneyRequired
choice
Output fields[3] Field Type ID text Name text Type text Status text Steps array Created At date Updated At date
Get a Label Search Reads the color and last update time of a label. Input fields[3] Field Type LabelRequired
choice
Output fields[3] Field Type ID text Name text Color text Created At date Updated At date
Get a Message Template Search Reads the content and status of a message template. Input fields[3] Field Type TemplateRequired
choice
Output fields[3] Field Type ID text Name text Type text Status text Vendor ID text Message Content text Variables array Vendor Details text Created At date Updated At date
Get a Public File URL Search Shareable link for a stored file. Input fields[3] Field Type File IDRequired
text
Output fields[3] Field Type URL text
Get a Team Search Reads who belongs to a team and its emoji. Input fields[3] Field Type TeamRequired
choice
Output fields[3] Field Type ID text Icon text Name text Users array Created At date Updated At date
Get a User Search Reads the contact details of one agent. Input fields[3] Field Type UserRequired
choice
Output fields[3] Field Type ID text Email text Phone Number text First Name text Last Name text Full Name text Profile Picture text Roles array Created At date Updated At date
Get an Attribute Search Reads the type and visibility of a contact attribute. Input fields[3] Field Type AttributeRequired
choice
Output fields[3] Field Type ID text Name text Type text Display Name text Visibility text Details text Created At date Updated At date
Get an Automation Search Reads when an automation was created and last updated. Input fields[3] Field Type AutomationRequired
choice
Output fields[3] Field Type ID text Name text Status text Created At date Updated At date
Get the Workspace Search Reads when your workspace is open and its time zone. Output fields[3] Field Type ID text Name text Timezone text Availability array Created At date Updated At date
List Attributes Search Custom contact fields with their types. Input fields[3] Field Type LimitRequired
number Search text Filter Expression text Sort By text
Output fields[3] Field Type ID text Name text Type text Display Name text Visibility text Details text Created At date Updated At date
List Automations Search Automations along with their states. Input fields[3] Field Type LimitRequired
number Search text Status choice Filter Expression text Sort By text
Output fields[3] Field Type ID text Name text Status text Created At date Updated At date
List Campaigns Search Campaigns in the Heyy workspace. Input fields[3] Field Type LimitRequired
number Search text Filter Expression text Sort By text
Output fields[3] Field Type ID text Name text Automation ID text Recurrence text Scheduled At date Variables text Latest Execution ID text Latest Execution text Group ID text Created At date Updated At date
List Channels Search Channels such as WhatsApp numbers. Input fields[3] Field Type LimitRequired
number Search text Channel Type choice Status choice Filter Expression text Sort By text
Output fields[3] Field Type ID text Name text Type text Status text Vendor text Vendor ID text Created At date Updated At date
List Chats Search Conversations from the inbox. Input fields[3] Field Type LimitRequired
number Search text Status choice Unread choice Channel choice Contact choice Filter Expression text Sort By text
Output fields[3] Field Type ID text Status text Is Unread boolean Open Until date Unread Count number Channel ID text Contact ID text Handle ID text Latest Message text Created At date Updated At date
List Contacts Search People in your address book. Input fields[3] Field Type LimitRequired
number Search text Label choice Subscribed choice Email text Phone Number text Filter Expression text Sort By text
Output fields[3] Field Type ID text First Name text Last Name text Full Name text Is Subscribed boolean Handles array Labels array Attributes array Created At date Updated At date
List Journeys Search Automated sequences in the workspace. Input fields[3] Field Type LimitRequired
number Search text Filter Expression text Sort By text
Output fields[3] Field Type ID text Name text Type text Status text Steps array Created At date Updated At date
List Labels Search Labels you can put on contacts. Input fields[3] Field Type LimitRequired
number Search text Filter Expression text Sort By text
Output fields[3] Field Type ID text Name text Color text Created At date Updated At date
List Message Templates Search Reusable channel messages with their approval state. Input fields[3] Field Type LimitRequired
number Search text Status choice Filter Expression text Sort By text
Output fields[3] Field Type ID text Name text Type text Status text Vendor ID text Message Content text Variables array Vendor Details text Created At date Updated At date
List Teams Search Agent groups in the workspace. Input fields[3] Field Type LimitRequired
number Search text Filter Expression text Sort By text
Output fields[3] Field Type ID text Icon text Name text Users array Created At date Updated At date
List Users Search Agents who can use the inbox. Input fields[3] Field Type LimitRequired
number
Output fields[3] Field Type ID text Email text Phone Number text First Name text Last Name text Full Name text Profile Picture text Roles array Created At date Updated At date
List Webhooks Search Webhook subscriptions in the workspace. Input fields[3] Field Type LimitRequired
number Search text Filter Expression text Sort By text
Output fields[3] Field Type ID text Status text URL Host text Events array Created At date Updated At date
Add Campaign Recipients Action Signs people up for a messaging campaign. Input fields[3] Field Type CampaignRequired
choice ContactsRequired
choice
Output fields[3] Field Type Contact ID text Display Name text Phone Number text Email text Is Subscribed boolean
Add Labels to a Contact Action Tags a contact with labels from your workspace. Input fields[3] Field Type ContactRequired
choice LabelsRequired
choice
Output fields[3] Field Type ID text First Name text Last Name text Full Name text Is Subscribed boolean Handles array Labels array Attributes array Created At date Updated At date
Assign a Chat to a Team Action Hands a conversation over to a group of agents. Input fields[3] Field Type ChatRequired
choice Team choice Trigger Automations boolean
Output fields[3] Field Type ID text Status text Is Unread boolean Open Until date Unread Count number Channel ID text Contact ID text Handle ID text Latest Message text Created At date Updated At date
Assign a Chat to a User Action Gives a conversation to a single agent. Input fields[3] Field Type ChatRequired
choice User choice Trigger Automations boolean
Output fields[3] Field Type ID text Status text Is Unread boolean Open Until date Unread Count number Channel ID text Contact ID text Handle ID text Latest Message text Created At date Updated At date
Change a Chat Status Action Switches a conversation between open, closed and snoozed. Input fields[3] Field Type ChatRequired
choice StatusRequired
choice Trigger Automations boolean
Output fields[3] Field Type ID text Status text Is Unread boolean Open Until date Unread Count number Channel ID text Contact ID text Handle ID text Latest Message text Created At date Updated At date
Create a Campaign Action Builds a campaign around an automation. Input fields[3] Field Type NameRequired
text AutomationRequired
choice Variables (JSON) text Scheduled At date Recurrence Rules array
Output fields[3] Field Type ID text Name text Automation ID text Recurrence text Scheduled At date Variables text Latest Execution ID text Latest Execution text Group ID text Created At date Updated At date
Create a Contact Action Saves a new person with their phone or email. Input fields[3] Field Type First Name text Last Name text Phone Number text Email text Attributes array Attribute object Labels choice
Output fields[3] Field Type ID text First Name text Last Name text Full Name text Is Subscribed boolean Handles array Labels array Attributes array Created At date Updated At date
Create a Label Action Makes a colored label you can put on contacts. Input fields[3] Field Type NameRequired
text ColorRequired
text
Output fields[3] Field Type ID text Name text Color text Created At date Updated At date
Create a Message Template Action Defines a reusable channel message. Input fields[3] Field Type ChannelRequired
choice NameRequired
text LanguageRequired
choice CategoryRequired
choice Body text Header text Footer text Code text Buttons (JSON) text Attachments array Attachment object Advanced Settings (JSON) text
Output fields[3] Field Type ID text Name text Type text Status text Vendor ID text Message Content text Variables array Vendor Details text Created At date Updated At date
Create a Team Action Sets up a group of agents. Input fields[3] Field Type IconRequired
text NameRequired
text Members choice
Output fields[3] Field Type ID text Icon text Name text Users array Created At date Updated At date
Create an Attribute Action Adds a custom field for contacts. Input fields[3] Field Type TypeRequired
choice Display NameRequired
text Show in Inbox boolean Show in Contacts boolean Ask When Creating Contacts boolean
Output fields[3] Field Type ID text Name text Type text Display Name text Visibility text Details text Created At date Updated At date
Create or Update a Contact Action Adds a contact or updates the one that matches. Input fields[3] Field Type First Name text Last Name text Phone Number text Email text Attributes array Attribute object Labels choice
Output fields[3] Field Type ID text First Name text Last Name text Full Name text Is Subscribed boolean Handles array Labels array Attributes array Created At date Updated At date
Create or Update Contacts in Bulk Action Imports many contacts at once, matched by phone or email. Input fields[3] Field Type ContactsRequired
array Contact object
Output fields[3] Field Type Success boolean
Delete a Campaign Action Deletes a campaign you no longer run. Input fields[3] Field Type CampaignRequired
choice
Output fields[3] Field Type Deleted Ids array Not Found Ids array
Delete a Chat Action Deletes a conversation from the inbox. Input fields[3] Field Type ChatRequired
choice
Output fields[3] Field Type Deleted Ids array Not Found Ids array
Delete a Contact Action Removes someone from your Heyy address book. Input fields[3] Field Type ContactRequired
choice
Output fields[3] Field Type Deleted Ids array Not Found Ids array
Delete a Label Action Deletes a label that you created in Heyy. Input fields[3] Field Type LabelRequired
choice
Output fields[3] Field Type Deleted Ids array Not Found Ids array
Delete a Message Template Action Removes a reusable channel message. Input fields[3] Field Type TemplateRequired
choice
Output fields[3] Field Type Deleted Ids array Not Found Ids array
Delete a Team Action Disbands a team of agents. Input fields[3] Field Type TeamRequired
choice
Output fields[3] Field Type Deleted Ids array Not Found Ids array
Delete an Attribute Action Removes a custom contact field from Heyy. Input fields[3] Field Type AttributeRequired
choice
Output fields[3] Field Type Deleted Ids array Not Found Ids array
Make an API Call universal Your own Heyy REST API request. 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 Key text Value text Status code number
Mark a Chat as Not Sensitive Action Lifts the sensitive marker from a conversation. Input fields[3] Field Type ChatRequired
choice
Output fields[3] Field Type ID text Status text Is Unread boolean Open Until date Unread Count number Channel ID text Contact ID text Handle ID text Latest Message text Created At date Updated At date
Mark a Chat as Read Action Marks a conversation as seen. Input fields[3] Field Type ChatRequired
choice
Output fields[3] Field Type ID text Status text Is Unread boolean Open Until date Unread Count number Channel ID text Contact ID text Handle ID text Latest Message text Created At date Updated At date
Mark a Chat as Sensitive Action Marks a conversation sensitive in the inbox. Input fields[3] Field Type ChatRequired
choice
Output fields[3] Field Type ID text Status text Is Unread boolean Open Until date Unread Count number Channel ID text Contact ID text Handle ID text Latest Message text Created At date Updated At date
Mark a Chat as Unread Action Marks a conversation as unseen. Input fields[3] Field Type ChatRequired
choice
Output fields[3] Field Type ID text Status text Is Unread boolean Open Until date Unread Count number Channel ID text Contact ID text Handle ID text Latest Message text Created At date Updated At date
Pause an Automation Action Halts an automation temporarily. Input fields[3] Field Type AutomationRequired
choice
Output fields[3] Field Type ID text Name text Status text Created At date Updated At date
Remove Campaign Recipients Action Unenrols people from a messaging campaign. Input fields[3] Field Type CampaignRequired
choice ContactsRequired
choice
Output fields[3] Field Type Deleted Ids array Not Found Ids array
Remove Labels from a Contact Action Detaches labels so a contact no longer carries them. Input fields[3] Field Type ContactRequired
choice LabelsRequired
choice
Output fields[3] Field Type ID text First Name text Last Name text Full Name text Is Subscribed boolean Handles array Labels array Attributes array Created At date Updated At date
Send a Message Action Delivers text or media to a recipient. Input fields[3] Field Type Send ToRequired
choice Text text Header text Footer text Reply to Message ID text Scheduled At date Attachments array Attachment object Extra Attachments (JSON) text
Output fields[3] Field Type ID text Chat ID text Channel ID text Type text Sender text Sources array Status text Scheduled At text Content text Created At date Updated At date
Send a Template Message Action Sends a ready-made template message. Input fields[3] Field Type Send ToRequired
choice TemplateRequired
choice Variables (JSON) text Scheduled At date Template Attachments array Attachment object
Output fields[3] Field Type ID text Chat ID text Channel ID text Type text Sender text Sources array Status text Scheduled At text Content text Created At date Updated At date
Start a Campaign Action Runs a campaign now. Input fields[3] Field Type CampaignRequired
choice Variables (JSON) text
Output fields[3] Field Type ID text Name text Automation ID text Recurrence text Scheduled At date Variables text Latest Execution ID text Latest Execution text Group ID text Created At date Updated At date
Subscribe a Contact Action Lets a contact receive messages again. Input fields[3] Field Type ContactRequired
choice
Output fields[3] Field Type ID text First Name text Last Name text Full Name text Is Subscribed boolean Handles array Labels array Attributes array Created At date Updated At date
Subscribe Contacts to a Journey Action Puts a group of contacts onto a journey. Input fields[3] Field Type JourneyRequired
choice ContactsRequired
choice
Output fields[3] Field Type ID text Journey ID text Contact ID text Status text Subscribed At date Last Completed Index number Created At date Updated At date
Trigger an Automation Action Starts an automation for a person. Input fields[3] Field Type AutomationRequired
choice ContactRequired
choice Variables (JSON) text Scheduled At date
Output fields[3] Field Type Success boolean
Unpause an Automation Action Restarts a halted automation. Input fields[3] Field Type AutomationRequired
choice
Output fields[3] Field Type ID text Name text Status text Created At date Updated At date
Unsubscribe a Contact Action Stops messages going to a contact. Input fields[3] Field Type ContactRequired
choice
Output fields[3] Field Type ID text First Name text Last Name text Full Name text Is Subscribed boolean Handles array Labels array Attributes array Created At date Updated At date
Unsubscribe Contacts from a Journey Action Ends the journey for a group of contacts. Input fields[3] Field Type JourneyRequired
choice ContactsRequired
choice
Output fields[3] Field Type ID text Journey ID text Contact ID text Status text Subscribed At date Last Completed Index number Created At date Updated At date
Update a Campaign Action Revises a messaging campaign. Input fields[3] Field Type CampaignRequired
choice Name text Automation choice Variables (JSON) text Scheduled At date Recurrence Rules array Clear Fields choice
Output fields[3] Field Type ID text Name text Automation ID text Recurrence text Scheduled At date Variables text Latest Execution ID text Latest Execution text Group ID text Created At date Updated At date
Update a Contact Action Changes the name or attributes of a contact. Input fields[3] Field Type ContactRequired
choice First Name text Last Name text Attributes array Attribute object Clear Attributes choice Clear Fields choice
Output fields[3] Field Type ID text First Name text Last Name text Full Name text Is Subscribed boolean Handles array Labels array Attributes array Created At date Updated At date
Update a Label Action Retitles a label or recolors it. Input fields[3] Field Type LabelRequired
choice Name text Color text
Output fields[3] Field Type ID text Name text Color text Created At date Updated At date
Update a Message Template Action Edits the wording and buttons of a message template. Input fields[3] Field Type TemplateRequired
choice Name text Category choice Body text Header text Footer text Code text Buttons (JSON) text Attachments array Attachment object Advanced Settings (JSON) text
Output fields[3] Field Type ID text Name text Type text Status text Vendor ID text Message Content text Variables array Vendor Details text Created At date Updated At date
Update a Team Action Revises a group of agents. Input fields[3] Field Type TeamRequired
choice Icon text Name text Members choice
Output fields[3] Field Type ID text Icon text Name text Users array Created At date Updated At date
Update an Attribute Action Revises a custom contact field. Input fields[3] Field Type AttributeRequired
choice Display Name text Show in Inbox choice Show in Contacts choice Ask When Creating Contacts choice Options array Option object
Output fields[3] Field Type ID text Name text Type text Display Name text Visibility text Details text Created At date Updated At date
Upload a File Action Stores a media file for later messages. Input fields[3] Field Type File TypeRequired
choice FileRequired
file
Output fields[3] Field Type ID text Created At date Type text Name text Content Type text URL text Size number
Other communication integrations on WEXTL