1. Whatsapp
  2. Buttons Message

Whatsapp

Buttons Message

Send a custom button message through Whatsapp.

Basic Usage

loading...

Parameters

Everything inside platforms.meta_whatsapp should be considered parameters for this notification. There are top level parameters that describe the message type and other general message behaviours, and then there are nested parameters dependent on the message type.

Only nested parameters for message_type: buttons is explained here, for all top level parameters, see the top level Whatsapp documentation

message_type

required
string

Indicates the type of message that is going to be sent. This also will determine what the contents of the params object should be.

Available message types are:


params

required
object

Contains the parameters for the message and will depend on the message_type setting. See the message_type specific documentation above for the message type specific parameters.


params.buttons

required
object

Object is required if the message_type is buttons. This object should change to match what message_type is set to.

Default: null


params.buttons.body

required
object

The body, or text, that will be send alongside the buttons.

Default: null


params.buttons.buttons

required
array

Contains button objects.

Button object:

editor
        {
  "id": "car",
  "title": "Car Damage",
}

      

params.buttons.buttons[].id

required
string

The id is the value that will be available in the data when the user clicks the button. The id needs to be a string and can be up to 20 characters long.

params.buttons.buttons[].title

required
string
The title is the text that will be displayed on the button. The title needs to be a string and can be up to 20 characters long.

Default: null


Result

Examples