The WhatsApp Component is designed to connect with WhatsApp using the Graph API.
The current release of the component was tested with API v18.0.
Credentials
Before building any integration flow, ensure you have have the following WhatsApp requirements for API communications:
-
A Meta Business Account.
-
A WhatsApp Business Account, associated with your Meta Business Account.
-
A Business app, associated with your Meta Business Account.
To generate a permanent access token after creating a system user:
-
Sign in the Meta Business Account.
-
Locate your business account in the top-left dropdown menu and click its Settings (gear) icon.
-
Click Business settings.
-
Navigate to .
-
Select the appropriate system user from the list of system users.
-
Select the Generate new token button.
-
Select the app that will use the token.
-
Select any permissions the app needs to function properly and generate the token.
Now you can create new credentials for the component:
- Name Your Credential
-
A required string. Provide a name.
- WhatsApp Business Account ID
-
A required string. Follow the Facebook developers documentation to find the ID.
- System User Access Token
-
A required string. The token generated in the previous step.
- API version
-
An optional string. The version of the API you are useing. Read the Facebook changelog to find out what changes have been made.
Triggers
This component has no trigger functions. This means it will not be accessible to select as a first component during the integration flow design.
Actions
Send message
Send a message.
Input metadata
Please refer to the Input Schema file below for the full list of metadata fields.
Input Schema file
{
"type": "object",
"properties": {
"to": {
"type": "string",
"title": "To",
"required": true,
"help": {
"description": "WhatsApp ID or phone number of the customer you want to send a message to. See Phone Number Formats link below",
"link": "https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#phone-number-formats"
}
},
"type": {
"type": "string",
"title": "Type",
"help": {
"description": "The type of message you want to send. If omitted, defaults to text"
},
"required": false,
"enum": [
"contacts",
"location",
"text",
"template"
]
},
"contacts": {
"type": "object",
"required": false,
"title": "Contacts",
"help": {
"description": "Required when type=contacts"
},
"properties": {
"addresses": {
"type": "object",
"title": "Addresses",
"help": {
"description": "Full contact address(es) formatted as an addresses object"
},
"required": false,
"properties": {
"street": {
"type": "string",
"title": "Street",
"help": {
"description": "Street number and name"
},
"required": false
},
"city": {
"type": "string",
"title": "City",
"help": {
"description": "City name"
},
"required": false
},
"state": {
"type": "string",
"title": "State",
"help": {
"description": "State abbreviation"
},
"required": false
},
"zip": {
"type": "string",
"title": "ZIP",
"help": {
"description": "ZIP code"
},
"required": false
},
"country": {
"type": "string",
"title": "Country",
"help": {
"description": "Full country name"
},
"required": false
},
"country_code": {
"type": "string",
"title": "Country code",
"help": {
"description": "Two-letter country abbreviation"
},
"required": false
},
"type": {
"type": "string",
"title": "Type",
"help": {
"description": "Standard values are HOME and WORK"
},
"required": false
}
}
}
}
},
"template": {
"type": "object",
"title": "Template",
"help": {
"description": "Required when type=template"
},
"required": false,
"properties": {
"name": {
"type": "string",
"title": "Name",
"help": {
"description": "Name of the template"
},
"required": false
},
"language": {
"type": "object",
"title": "Language",
"help": {
"description": "Contains a language object. Specifies the language the template may be rendered in"
},
"required": false,
"properties": {
"policy": {
"type": "string",
"title": "Policy",
"help": {
"description": "The language policy the message should follow. The only supported option is deterministic"
},
"required": false
},
"code": {
"type": "string",
"title": "Code",
"help": {
"description": "The code of the language or locale to use. Accepts both language and language_locale formats (e.g., en and en_US). For all codes, see https://developers.facebook.com/docs/whatsapp/api/messages/message-templates#supported-languages"
},
"required": false
}
}
}
}
},
"text": {
"type": "object",
"title": "Text",
"help": {
"description": "Required for text messages"
},
"required": false,
"properties": {
"body": {
"type": "string",
"title": "Body",
"help": {
"description": "The text of the text message which can contain URLs which begin with http:// or https:// and formatting"
},
"required": false
},
"preview_url": {
"type": "boolean",
"title": "Preview URL",
"help": {
"description": "Set to true to have the WhatsApp Messenger and WhatsApp Business apps attempt to render a link preview of any URL in the body text string. URLs must begin with http:// or https://. If multiple URLs are in the body text string, only the first URL will be rendered"
},
"required": false
}
}
},
"location": {
"type": "object",
"title": "Location",
"help": {
"description": "Required when type=location"
},
"required": false,
"properties": {
"longitude": {
"type": "string",
"title": "Longitude",
"help": {
"description": "Longitude of the location"
},
"required": false
},
"latitude": {
"type": "string",
"title": "Latitude",
"help": {
"description": "Latitude of the location"
},
"required": false
},
"name": {
"type": "string",
"title": "Name",
"help": {
"description": "Name of the location"
},
"required": false
},
"address": {
"type": "string",
"title": "Address",
"help": {
"description": "Address of the location"
},
"required": false
}
}
},
"preview_url": {
"type": "boolean",
"title": "Preview URL",
"help": {
"description": "Required if type=text"
},
"required": false
},
"status": {
"type": "string",
"title": "Status",
"help": {
"description": "A message's status. You can use this field to mark a message as read"
},
"required": false
},
"context": {
"type": "object",
"title": "Context",
"help": {
"description": "Required if replying to any message in the conversation"
},
"required": false,
"properties": {
"message_id": {
"type": "string",
"title": "Message ID",
"help": {
"description": "ID of a previous message you are replying to"
},
"required": false
}
}
}
}
}Input message fields depend on the type of the message (contacts, location, text, or template).
For example, if type: template is specified, you must ensure the template is properly prepared and verified according to Meta’s requirements.
Read the official What’s App Message Templates documentation for more information.
An example of the input message with the template available for testing purposes:
{
"to": "+1234567890",
"type": "template",
"template": {
"name": "hello_world",
"language": {
"code": "en_US"
}
}
}