WhatsApp Flow API V2

WhatsApp Flows allows you to create interactive experiences within the familiar WhatsApp environment. It provides a platform to design, manage, and deliver customized Flows, thereby establishing a unique pathway for interaction.

Whether you are looking to collect simple data or create complex, logic-driven interactions, WhatsApp Flows provides a versatile set of tools that can be customized to meet any level of complexity.

Flows are classified into two types:

Static Flows (without end points)

Static Flows are predefined, fixed interaction paths. These flows are created in advance and follow a set structure, without much variability. In other words, the conversation follows a fixed sequence based on your pre-selected choices or actions.

Dynamic Flows (with end points)

Dynamic Flows, in contrast, offer greater flexibility and enable a more customized experience. These flows are not strictly predefined and can adapt based on end user input, allowing for a more tailored interaction.

The endpoint enables data exchange between Flows on the end user device and your business backend when you interact with Flows. This feature allows for the implementation of conditional logic within and across screens, enabling personalization and branching Flows. By default, Flows do not use an endpoint when created.

Endpoints provide dynamic data for screens and control routing. For example, after a screen is submitted, Flows can make a request to the endpoint to determine the next screen and the data to display on it.

You need to add an endpoint to Flows if:

  • You wish to populate dynamic data, such as available appointment times
  • You need to validate your information, such as checking whether an email is already registered

The Flows can be sent as:

Free Form

Once your WhatsApp Flow is created, you can send it by using a message with a Call To Action (CTA) in a user-initiated conversation. The Flow is triggered when you tap the CTA button. A Flow message works similar to any other type of message. For more information see, Send Flow Messages API.

Flows with Message Template

You can easily create a Flow using the Kaleyra platform's WhatsApp API by including the Flow JSON in the message template creation request. Alternatively, you can specify the ID or name of an existing published Flow.

Best Practices

These guidelines are designed to enhance the experience for both those interacting with WhatsApp Flow and developers:

  • Keep Flows short and concise
  • Limit each screen to a single task
  • Avoid overcrowded screens with too many components

For more information about Flows and how to Create a Flow see, the Meta Documentation page.

The WhatsApp Flows API V2 category contains the following topics: