Requirements 2Chat requires an active account and an API access token from your account settings to connect. Both are set up on its own site.[3] https://2chat.co
Get your 2Chat credentials API Key password Required In 2Chat, open Developers, then API Access, and copy your API key. You can create a new key there at any time.[1]
Connect 2Chat in WEXTL Log in to your WEXTL account, add the 2Chat 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 2Chat 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 →
2Chat triggers and actions on WEXTL The list below is a reference of every 2Chat node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every 2Chat node module below. Each one opens to show its input parameters, outputs, and connection requirements.
Watch Events Trigger Instant trigger for 2Chat events. Output fields[3] Field Type Event text ID text UUID text Conversation Key text Created At text Timestamp text Remote Phone Number text Channel Phone Number text Channel UUID text Sent By text Message UUID text Reaction text Edited At text
28 other output fields
Find a Number on WhatsApp Search WhatsApp registration check for a phone number. Input fields[3] Field Type From NumberRequired
choice Number to CheckRequired
text Include Extra Details boolean
Output fields[3] Field Type Is Valid boolean On WhatsApp boolean Number object Country Code text Region text Carrier text Time Zones array WhatsApp Info object Number ID text Contact Profile Picture text Is Business boolean Is Enterprise boolean Verified Name text Short Name text Push Name text Verified Level number Status Text text Business Information text
Get a Call Price Search Rate lookup before placing a call. Input fields[3] Field Type Phone NumberRequired
text
Output fields[3] Field Type Prefix text Location Name text Price Per Minute number
Get a Contact Search Single entry out of the contact directory. Input fields[3] Field Type ContactRequired
choice
Output fields[3] Field Type UUID text ID number First Name text Last Name text Channel UUID text Profile Picture URL text Details array Last Updated text
Get a WABA Conversation Window Search Reply window status for a contact. Input fields[3] Field Type WABA NumberRequired
choice Contact NumberRequired
text
Output fields[3] Field Type Success boolean Window Open boolean Last Inbound Message At text Expires At text Seconds Left number Allowed Message Types array
Get a WABA Message Search Single business message with status. Input fields[3] Field Type Conversation KeyRequired
text Message IDRequired
text
Output fields[3] Field Type ID text UUID text Conversation Key text Message object Text text Media object Created At text Remote Phone Number text Sent By text Is From Flow Run boolean Is From API boolean Is From Chatter boolean Is From Agent boolean WhatsApp Message ID text Delivery Ack number
5 other output fields
Get a WABA Number Search Business number profile and state. Input fields[3] Field Type WABA NumberRequired
choice
Output fields[3] Field Type UUID text Account UUID text Business ID text Friendly Name text Country Code text Verified Name text Phone Number text Formatted Phone Number text Phone Number ID text Channel Type text Connection Status text Enabled boolean Display Name text
8 other output fields
Get a WABA Template Search Template details with required parameters. Input fields[3] Field Type Template IDRequired
text
Output fields[3] Field Type Success boolean Template object UUID text Name text Status text Category text Language text Template Content text Content text Description text Components array Quality Score text Required Params object Send Supported boolean Unsupported Reasons array Body array Header array Header Media URL text Header Media Filename text Button array Counts object Example Payload text Message text
Get a WhatsApp Group Search Group profile with its member list. Input fields[3] Field Type Group IDRequired
text
Output fields[3] Field Type UUID text Channel UUID text WhatsApp Group ID text Profile Picture URL text WhatsApp Owner ID text Group Name text WhatsApp Created At text Subject text Size number Is Muted boolean Is Read Only boolean Channel Is Owner boolean Created At text
4 other output fields
Get a WhatsApp Message Search Single message with its delivery state. Input fields[3] Field Type Conversation KeyRequired
text Message IDRequired
text
Output fields[3] Field Type ID text UUID text Timestamp text Conversation Key text Message object Text text Media object Created At text Remote Phone Number text Channel Phone Number text Sent By text Is From Flow Run boolean Is From API boolean Is From Chatter boolean Is From Agent boolean
6 other output fields
Get a WhatsApp Number Search Single connected number with details. Input fields[3] Field Type WhatsApp NumberRequired
choice
Output fields[3] Field Type ID text UUID text Friendly Name text Phone Number text Country Code text Push Name text Server text Platform text Connection Status text Enabled boolean Is Business Profile boolean Channel Type text Sync Contacts boolean
4 other output fields
Get Account Usage Search Plan, rate limit and credit consumption. Output fields[3] Field Type Success boolean Account object Name text UUID text On Trial boolean Blocked boolean Created At text Expires At text Limits object Requests Per Minute number Usage object API Request Count number Max API Request Count number Number Check Count number Max Number Check Count number
Get an Ads Report Search Ad-driven conversation totals. Input fields[3] Field Type Days choice WABA Number choice
Output fields[3] Field Type Success boolean From text To text Days array Totals object Conversations number Ads number Daily array Ads array Timezone text
Get an SMS Channel Search Single SMS number with its capabilities. Input fields[3] Field Type SMS NumberRequired
choice
Output fields[3] Field Type UUID text Account UUID text Virtual Number Setup UUID text Phone Number text Friendly Name text Country Code text Supports SMS In boolean Supports SMS Out boolean Enabled boolean Created At text Updated At text
Get an SMS Message Search Single text message with cost. Input fields[3] Field Type Message IDRequired
text
Output fields[3] Field Type UUID text Destination text Source text Text text Direction text Fragments number Price number Virtual Number Setup ID number Created At text Updated At text Timestamp number
Get Call Details Search Billing and agent data for one call. Input fields[3] Field Type Call IDRequired
text
Output fields[3] Field Type UUID text Account UUID text Call ID text Direction text Active boolean From text To Number text Country Code text Status text Is WhatsApp Call boolean Is SIP Trunk Call boolean Caller ID UUID text Caller ID Used text
9 other output fields
Get Conversation Tags Search Tags attached to a chat. Input fields[3] Field Type Conversation KeyRequired
text LimitRequired
number
Output fields[3] Field Type UUID text Name text Color text Exclude From Campaigns boolean Created At text Updated At text Created By User ID number
Get Number Cities Search Buyable number locations by city. Input fields[3] Field Type Country CodeRequired
text Region choice
Output fields[3] Field Type ID number City Name text Country Code text
Get Number Regions Search Regions that offer phone numbers. Input fields[3] Field Type Country CodeRequired
text
Output fields[3] Field Type ID number Region Name text Country Code text
Get Number Requirements Search Country rules for number purchases. Input fields[3] Field Type Country CodeRequired
text Number Type choice
Output fields[3] Field Type Requirements array
Get WhatsApp Number Status Search Connection status and pairing code. Input fields[3] Field Type WhatsApp NumberRequired
choice
Output fields[3] Field Type Success boolean Connection Status text QR Code text Events array Event text Payload text Created At text
List Available Numbers Search Buyable numbers from one group. Input fields[3] Field Type Group IDRequired
text LimitRequired
number Number Contains text
Output fields[3] Field Type ID text Number text
List Call History Search Past calls with status and numbers. Input fields[3] Field Type LimitRequired
number Direction choice To Number text From Number text
Output fields[3] Field Type UUID text Account UUID text Call ID text Direction text Active boolean From text To Number text Country Code text Status text Is WhatsApp Call boolean Is SIP Trunk Call boolean Caller ID UUID text Caller ID Used text
8 other output fields
List Caller IDs Search Outbound caller ID numbers. Input fields[3] Field Type LimitRequired
number
Output fields[3] Field Type UUID text Account UUID text Channel UUID text Phone Number text Friendly Name text Country Code text Type text Verified boolean Created At text Updated At text Expires At text
List Catalog Collections Search Catalog groupings with approval state. Input fields[3] Field Type From NumberRequired
choice LimitRequired
number Business Number text
Output fields[3] Field Type ID text Name text Is Approved boolean Approval Status text Products array
List Catalog Products Search Catalog items with price and approval. Input fields[3] Field Type From NumberRequired
choice LimitRequired
number Business Number text
Output fields[3] Field Type ID text Is Hidden boolean URL text Name text Description text Availability text Max Available number Can Appeal boolean Retailer ID text Checkmark boolean Is Approved boolean Approval Status text Price text
2 other output fields
List Contacts Search Directory contacts, filtered by number. Input fields[3] Field Type LimitRequired
number WhatsApp Number choice
Output fields[3] Field Type UUID text ID number First Name text Last Name text Channel UUID text Profile Picture URL text Details array
List Number Reservations Search Numbers held ahead of purchase. Output fields[3] Field Type Reservations text
List Number Types Search Categories of buyable numbers. Output fields[3] Field Type ID number Name text
List SMS Channels Search Lines that can send or receive SMS. Input fields[3] Field Type LimitRequired
number
Output fields[3] Field Type UUID text Account UUID text Virtual Number Setup UUID text Phone Number text Friendly Name text Country Code text Supports SMS In boolean Supports SMS Out boolean Enabled boolean Created At text Updated At text
List SMS Conversations Search Contacts texting an SMS number. Input fields[3] Field Type SMS NumberRequired
choice LimitRequired
number
Output fields[3] Field Type Contact text Last Message Text text Last Message Direction text Last Message Timestamp number Last Message At text Message Count number
List SMS Messages Search One SMS conversation thread. Input fields[3] Field Type SMS NumberRequired
choice Contact NumberRequired
text LimitRequired
number
Output fields[3] Field Type UUID text Destination text Source text Text text Direction text Fragments number Price number Virtual Number Setup ID number Created At text Updated At text Timestamp number
List Tags Search Tags saved for chats. Input fields[3] Field Type LimitRequired
number
Output fields[3] Field Type UUID text Name text Color text Exclude From Campaigns boolean Created At text Updated At text Created By User ID number
List Users Search Account users with names and emails. Input fields[3] Field Type LimitRequired
number
Output fields[3] Field Type UUID text First Name text Last Name text Email text
List Virtual Numbers Search Virtual lines you own with their regions. Input fields[3] Field Type LimitRequired
number
Output fields[3] Field Type UUID text Account UUID text Phone Number text Formatted Phone Number text Country Code text Region Name text Emoji text Friendly Name text Record Inbound boolean Is Toll Free boolean Provider Type text Priced Per Minute boolean Incoming Price Per Minute number
7 other output fields
List WABA Conversations Search Business chats of one number. Input fields[3] Field Type WABA NumberRequired
choice LimitRequired
number Phone Digits text
Output fields[3] Field Type Conversation Key text Friendly Name text Region Name text Country Code text Device text Channel UUID text Phone Number text Timezone text Profile Picture URL text Is Group Chat boolean Last User Message Sent At text Last Activity At text Created At text
1 other output field
List WABA Messages Search Business messages, optionally per contact. Input fields[3] Field Type WABA NumberRequired
choice LimitRequired
number Contact Number text
Output fields[3] Field Type ID text UUID text Conversation Key text Message object Text text Media object Created At text Remote Phone Number text Channel Phone Number text Sent By text
List WABA Templates Search Template catalog with approval state. Input fields[3] Field Type WABA NumberRequired
choice LimitRequired
number
Output fields[3] Field Type UUID text Name text Status text Category text Language text Template Content text Content text Description text Components array Quality Score text Rejection Reason text Media URL text Updated At text
1 other output field
List WhatsApp Conversations Search Chat overview for one WhatsApp line. Input fields[3] Field Type WhatsApp NumberRequired
choice LimitRequired
number Phone Digits text
Output fields[3] Field Type Conversation Key text Friendly Name text Region Name text Country Code text Device text Channel UUID text Phone Number text Time Zone text Profile Picture URL text Is Group Chat boolean Last User Message Sent At text Last Activity At text Created At text
1 other output field
List WhatsApp Group Messages Search Past posts inside a group chat. Input fields[3] Field Type Group IDRequired
text LimitRequired
number
Output fields[3] Field Type ID text UUID text Conversation Key text Message object Text text Media object Created At text 2Chat Link text Sent By text Participant object Phone Number text Device text Push Name text
List WhatsApp Groups Search Groups joined by a number. Input fields[3] Field Type From NumberRequired
choice LimitRequired
number
Output fields[3] Field Type UUID text Channel UUID text WhatsApp Group ID text Profile Picture URL text WhatsApp Owner ID text Group Name text WhatsApp Created At text Subject text Size number Is Muted boolean Is Read Only boolean Channel Is Owner boolean Created At text
2 other output fields
List WhatsApp Messages Search Chat messages, optionally per contact. Input fields[3] Field Type From NumberRequired
choice LimitRequired
number Contact Number text
Output fields[3] Field Type UUID text Timestamp text Conversation Key text Message object Text text Media object Remote Phone Number text Channel Phone Number text Sent By text
List WhatsApp Numbers Search Connected WhatsApp numbers with their status. Input fields[3] Field Type LimitRequired
number Status choice
Output fields[3] Field Type UUID text Friendly Name text Phone Number text Country Code text Push Name text Server text Platform text Connection Status text Enabled boolean Is Business Profile boolean Channel Type text Sync Contacts boolean Created At text
1 other output field
Search Contacts Search Name or number search over contacts. Input fields[3] Field Type Search TextRequired
text LimitRequired
number WhatsApp Number choice
Output fields[3] Field Type UUID text ID number First Name text Last Name text Channel UUID text Profile Picture URL text Details array
Search Number Groups Search Finds purchasable number groups. Input fields[3] Field Type Country CodeRequired
text LimitRequired
number Region choice City choice City Name or Prefix text Number Type choice
Output fields[3] Field Type ID text Prefix text Location text Price object Setup Price text Monthly Price text Type text Requirements array Allow Number Selection boolean Eligible For Free Number boolean Features array
Add a Catalog Collection Action New collection with optional starting products. Input fields[3] Field Type From NumberRequired
choice NameRequired
text Products choice
Output fields[3] Field Type Success boolean
Add a Catalog Product Action New catalog item with an image and optional price. Input fields[3] Field Type From NumberRequired
choice NameRequired
text Image URLRequired
text Description text Price text Currency text Hidden boolean Product Link text Retailer ID text
Output fields[3] Field Type Success boolean
Add a Tag to a Conversation Action Labels a chat with a saved tag. Input fields[3] Field Type TagRequired
choice Conversation KeyRequired
text
Output fields[3] Field Type UUID text Name text Color text Exclude From Campaigns boolean Created At text Updated At text Created By User ID number
Add Catalog Product Images Action Gallery pictures for a catalog item. Input fields[3] Field Type From NumberRequired
choice ProductRequired
choice Image URLsRequired
array Image URL text
Output fields[3] Field Type Success boolean
Add Group Participants Action Adds members by phone number. Input fields[3] Field Type From NumberRequired
choice GroupRequired
choice Phone NumbersRequired
array Phone Number text
Output fields[3] Field Type Success boolean Participants text
Cancel a Number Reservation Action Gives up a held phone number. Input fields[3] Field Type Reservation IDRequired
text
Output fields[3] Field Type Success boolean Message text
Connect a WhatsApp Number Action Reconnects a WhatsApp number to 2Chat. Input fields[3] Field Type WhatsApp NumberRequired
choice
Output fields[3] Field Type Success boolean
Create a Contact Action New directory contact with optional details. Input fields[3] Field Type First NameRequired
text Contact Details array Detail object Last Name text WhatsApp Number choice Profile Picture URL text
Output fields[3] Field Type UUID text ID number First Name text Last Name text Channel UUID text Profile Picture URL text Details array Last Updated text
Create a Tag Action New tag, optionally applied to a chat. Input fields[3] Field Type NameRequired
text Conversation Key text
Output fields[3] Field Type UUID text Name text Color text Exclude From Campaigns boolean Created At text Updated At text Created By User ID number
Create a WABA Template Action Message template filed for WhatsApp approval. Input fields[3] Field Type WABA NumberRequired
choice NameRequired
text LanguageRequired
choice CategoryRequired
choice Body text Header choice Footer text Body Examples array Example object Header Example text Buttons array Button object
Output fields[3] Field Type Success boolean Template object UUID text Name text Status text Category text Language text Template Content text Content text Description text Components array Quality Score text Required Params object Send Supported boolean Unsupported Reasons array Body array Header array Header Media URL text Header Media Filename text Button array Counts object Example Payload text Message text
Create a WhatsApp Connection Action Begins pairing a WhatsApp number. Input fields[3] Field Type Phone NumberRequired
text Friendly Name text
Output fields[3] Field Type ID text UUID text Friendly Name text Phone Number text Country Code text Push Name text Server text Platform text Connection Status text Enabled boolean Is Business Profile boolean Channel Type text Sync Contacts boolean
4 other output fields
Create a WhatsApp Group Action New WhatsApp group seeded with members. Input fields[3] Field Type From NumberRequired
choice Group NameRequired
text Phone NumbersRequired
array Phone Number text Description text
Output fields[3] Field Type UUID text Name text WhatsApp Group ID text Participants text Accepted Numbers array Unaccepted Numbers array
Delete a Catalog Collection Action Deletes a grouping of catalog items. Input fields[3] Field Type From NumberRequired
choice CollectionRequired
choice
Output fields[3] Field Type Success boolean
Delete a Catalog Product Action Removes a listed item from your catalog. Input fields[3] Field Type From NumberRequired
choice ProductRequired
choice
Output fields[3] Field Type Success boolean
Delete a Catalog Product Image Action Deletes a gallery picture. Input fields[3] Field Type From NumberRequired
choice ProductRequired
choice Image PositionRequired
number
Output fields[3] Field Type Success boolean
Delete a Contact Action Deletes a directory entry irreversibly. Input fields[3] Field Type ContactRequired
choice
Output fields[3] Field Type Success boolean
Delete a Tag Action Clears a tag from all chats. Input fields[3] Field Type TagRequired
choice
Output fields[3] Field Type Success boolean
Delete a Virtual Number Action Releases a virtual phone line from your account. Input fields[3] Field Type Virtual NumberRequired
choice
Output fields[3] Field Type Success boolean
Delete a WABA Template Action Removes a template across all its languages. Input fields[3] Field Type Template IDRequired
text
Output fields[3] Field Type Success boolean Message text
Delete a WhatsApp Message Action Removes a message in one conversation. Input fields[3] Field Type Conversation KeyRequired
text Message IDRequired
text
Output fields[3] Field Type Success boolean Message UUID text WhatsApp Message ID text
Delete a WhatsApp Number Action Unlinks a WhatsApp line from 2Chat. Input fields[3] Field Type WhatsApp NumberRequired
choice
Output fields[3] Field Type Success boolean
Demote Group Participants Action Strips group admin status. Input fields[3] Field Type From NumberRequired
choice GroupRequired
choice Phone NumbersRequired
array Phone Number text
Output fields[3] Field Type Success boolean Participants text
Disconnect a WhatsApp Number Action Takes a WhatsApp line offline. Input fields[3] Field Type WhatsApp NumberRequired
choice
Output fields[3] Field Type Success boolean
Edit a Catalog Collection Action Adds or removes products in a collection. Input fields[3] Field Type From NumberRequired
choice CollectionRequired
choice Products to Add choice Products to Remove choice
Output fields[3] Field Type Success boolean
Edit a Catalog Product Action Edits listing details of a catalog item. Input fields[3] Field Type From NumberRequired
choice ProductRequired
choice Name text Image URL text Description text Price text Hidden choice Product Link text Retailer ID text Clear Fields choice
Output fields[3] Field Type Success boolean
Make an API Call universal Custom 2Chat 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
Promote Group Participants Action Grants group admin rights to members. Input fields[3] Field Type From NumberRequired
choice GroupRequired
choice Phone NumbersRequired
array Phone Number text
Output fields[3] Field Type Success boolean Participants text
Purchase a Number Action Buys a number from a chosen group. Input fields[3] Field Type Group IDRequired
text Number text
Output fields[3] Field Type Success boolean
Remove a Tag from a Conversation Action Unlabels a chat again. Input fields[3] Field Type TagRequired
choice Conversation KeyRequired
text
Output fields[3] Field Type Success boolean
Remove Group Participants Action Group member removal by number. Input fields[3] Field Type From NumberRequired
choice GroupRequired
choice Phone NumbersRequired
array Phone Number text
Output fields[3] Field Type Success boolean Participants text
Reserve a Number Action Temporary hold on a number. Input fields[3] Field Type Group IDRequired
text Number text
Output fields[3] Field Type UUID text Number text Created At text Expires At text
Send a WABA Message Action Business template or text message. Input fields[3] Field Type From NumberRequired
choice To NumberRequired
text Template choice Text text Header Media Filename text Body Values array Value object
Output fields[3] Field Type Success boolean Batched boolean Message UUID text
Send a WhatsApp Message Action Chat message with text, media or a map pin. Input fields[3] Field Type From NumberRequired
choice Send ToRequired
choice ContentRequired
choice
Output fields[3] Field Type Success boolean Batched boolean Message UUID text
Send an SMS Message Action Outbound SMS from a 2Chat number. Input fields[3] Field Type From NumberRequired
choice To NumberRequired
text TextRequired
text
Output fields[3] Field Type Success boolean Message UUID text
Set a Group Description Action New description text for a WhatsApp group. Input fields[3] Field Type From NumberRequired
choice GroupRequired
choice DescriptionRequired
text
Output fields[3] Field Type Success boolean
Set a Group Picture Action New icon for a group chat. Input fields[3] Field Type From NumberRequired
choice GroupRequired
choice Picture URLRequired
text
Output fields[3] Field Type Success boolean
Set a WhatsApp About Text Action Profile status line of a number. Input fields[3] Field Type From NumberRequired
choice About TextRequired
text
Output fields[3] Field Type Success boolean Batched boolean
Set a WhatsApp Image Status Action Picture status for a connected line. Input fields[3] Field Type From NumberRequired
choice Image URLRequired
text
Output fields[3] Field Type Success boolean
Set a WhatsApp Profile Picture Action Sets or removes a profile photo. Input fields[3] Field Type From NumberRequired
choice Picture URL text Remove Picture boolean
Output fields[3] Field Type Success boolean Batched boolean
Set a WhatsApp Text Status Action Posts a written status with an optional color. Input fields[3] Field Type From NumberRequired
choice TextRequired
text Background Color text Font number
Output fields[3] Field Type Success boolean
Set a WhatsApp Video Status Action Short clip status for a connected line. Input fields[3] Field Type From NumberRequired
choice Video URLRequired
text
Output fields[3] Field Type Success boolean
Sync WABA Templates Action Pulls current templates from WhatsApp. Input fields[3] Field Type WABA NumberRequired
choice
Output fields[3] Field Type Success boolean Is Syncing boolean Start Time Syncing text Message text
Update a Contact Action Edits contact names and picture. Input fields[3] Field Type ContactRequired
choice First Name text Last Name text WhatsApp Number choice Profile Picture URL text Clear Fields choice
Output fields[3] Field Type UUID text ID number First Name text Last Name text Channel UUID text Profile Picture URL text Details array Last Updated text
Update a Tag Action Tag name and color changes. Input fields[3] Field Type TagRequired
choice Name text Color text
Output fields[3] Field Type UUID text Name text Color text Exclude From Campaigns boolean Created At text Updated At text Created By User ID number
Other communication integrations on WEXTL