Skip to main content
Version: Current

WhatsApp Trigger

Description

Triggers a workflow when a WhatsApp webhook event is received from the WhatsApp Business Platform.

The activity listens for configured WhatsApp events such as incoming messages, delivery updates, and read receipts. Event data extracted from the webhook payload is exposed as workflow outputs for downstream processing.


Common Capabilities

Process Data Support

info

Outputs from this activity are available in the Process Data drawer and can be bound to downstream workflow activities.

Learn more → Using Process Data


Design-Time Configuration

Endpoint URL

Specifies the webhook endpoint URL that receives WhatsApp event notifications from the WhatsApp Business Platform.

The workflow is triggered whenever a matching webhook event is received.

Event

Specifies the WhatsApp event type that should trigger the workflow.

Supported values include:

  • Message Received
  • Message Sent
  • Message Delivered
  • Message Read

Verify Token

Specifies the verification token used during WhatsApp webhook endpoint verification.

The token value must match the token configured in the Meta webhook configuration for the associated WhatsApp Business application.


Outputs

SessionId

Represents the messaging session identifier.

Typically corresponds to the WhatsApp phone number associated with the conversation.

Message JSON

Contains the serialized JSON payload of the received WhatsApp message event.

Message ID

Represents the unique identifier of the WhatsApp message.

Message From

Represents the phone number of the sender.

Message Type

Represents the type of message received.

Possible values include:

  • text
  • image
  • video
  • audio
  • document
  • sticker

Message Text

Contains the text content of the message when the message type is text.

Message Media URL

Contains the media URL associated with the received message, when available.

Message Media ID

Represents the WhatsApp media identifier associated with the message.

This identifier can be used with the Download WhatsApp Media activity to retrieve the media content.

Status JSON

Contains the serialized JSON payload of the WhatsApp status event.

Status ID

Represents the unique identifier of the message associated with the status update.

Status Value

Represents the delivery state of the message.

Possible values include:

  • sent
  • delivered
  • read

Notes

note
  • The webhook endpoint configured for the WhatsApp Business application must be publicly reachable.
  • The Verify Token configured in the activity must exactly match the token configured in Meta webhook settings.
  • Output availability depends on the selected event type and the webhook payload received from WhatsApp.