Skip to content

WhatsApp

WhatsApp is a free-to-use messaging app offering end-to-end encrypted chat, voice, and video communication, along with document and media sharing, available on multiple platforms.

Categories: communication

Type: whatsApp/v1


Connections

Version: 1

WhatsApp Custom Authorization

Properties

NameLabelTypeControl TypeDescriptionRequired
systemUserAccessTokenSystem user access tokenSTRINGTEXTtrue
phoneNumberIdPhone number IDSTRINGTEXTtrue

Actions

Send Message

Name: sendMessage

Send a message via WhatsApp

Properties

NameLabelTypeControl TypeDescriptionRequired
bodyMessageSTRINGTEXTMessage to send via WhatsApptrue
toSend Message ToSTRINGTEXTPhone number to send the message. It must start with ”+” signtrue

Output

Type: OBJECT

Properties

NameTypeControl Type
messaging_productSTRINGTEXT
contactsOBJECT
Properties {STRING(input), STRING(wa_id)}
OBJECT_BUILDER
messagesOBJECT
Properties {STRING(id)}
OBJECT_BUILDER

JSON Example

{
"label" : "Send Message",
"name" : "sendMessage",
"parameters" : {
"body" : "",
"to" : ""
},
"type" : "whatsApp/v1/sendMessage"
}

Triggers

Message Received

Name: messageReceived

Triggers when you get a new message from certain number.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeControl TypeDescriptionRequired
senderNumberSender NumberSTRINGTEXTType in the number from whom you want to triggertrue

Output

Type: OBJECT

Properties

NameTypeControl Type
objectSTRINGTEXT
entryOBJECT
Properties {STRING(id), {{STRING(messaging_product), {STRING(display_phone_number), STRING(phone_number_id)}(metadata)}(value), {{STRING(name)}(profile), STRING(wa_id)}(contacts), {STRING(from), STRING(id), STRING(timestamp), {STRING(body)}(text)}(messages)}(changes)}
OBJECT_BUILDER

JSON Example

{
"label" : "Message Received",
"name" : "messageReceived",
"parameters" : {
"senderNumber" : ""
},
"type" : "whatsApp/v1/messageReceived"
}