Release Notes
June 11th, 2024 release
New Flow JSON version - 4.0 [Early Release]
We are introducing a new Flow JSON version which contains several enhancements (described in detail below). You can now create new Flows with this version to leverage the new functionality. Please note that version 4.0 is an early release, so please review the implications before beginning to send Flows to real users.
Upgrading Flows to version 4.0 from 3.1: Version 4.0 introduces two minor backwards incompatible changes, which means you may need to make some tweaks after cloning an existing version 3.1 Flow. Specifically:
All CheckboxGroup and RadioButtonsGroup components now require a label property (previously optional) The name property for all input and selection components cannot be empty. Previously values such as “”, “ “, “\n”, “\t”, “\n” were accepted; with version 4.0 these are no longer valid.No additional changes are required to port your version 3.1 Flow to version 4.0, which will unlock your access to the following new functionality:
[Component] Image and Document upload
New PhotoPicker and DocumentPicker components. These components allow users to share images and documents, respectively, within a Flow, leveraging the existing and familiar WhatsApp UX.[Component] Group components label improvements
The CheckboxGroup and RadioButtonsGroup components now support a higher character limit for the label property, and additionally support a new description property, which can be used to provide more information to users about the selection options.[Comoponents] Conditional Component Rendering
You can now show/hide components, based on user input or Business data, without the need to trigger a data_exchange to your Flows Endpoint, by leveraging the If and Switch Components within the Flow JSON.[Flow JSON Capabilities] Global Dynamic Data Access
You can now reference Form and dynamic data from any screen in the Flow JSON using global accessor syntax. This means you no longer need to explicitly propagate data from screen-to-screen.[Flow JSON Capabilities] Optional Form
The use of the Form component is now optional. This means that you can access user-entered data without the need to wrap your components inside a Form component.Developer Tooling Improvements
We are introducing several improvements to help developers onboard and use Flows.
[Developer Tools] Improved Flows Preview in the WhatsApp Manager Builder, and in Developer Docs
Better/snappier preview loading and saving performance.Ability to simulate iOS and dark theme modes.Mobile-like bottom sheet experience within the Flows Builder editor, which displays Flow JSON error(s).[Developer Tools] Update Application linked to a Flow through the Flows API
Added an optional application ID parameter to the Update Flow API request. [Developer Tools] Send-Time validation of the screen name in "navigate" action
Added validation of the screen parameter in the message payload at Flow message send time if the action is navigate: invalid screens (i.e. screens that are no defined in the Flow JSON, or screens which cannot act as a first screen) will be rejected, and an API error will be returned.Improved Flows experience for users
We are releasing several improvements to the UX of Flows. These changes are not tied to a Flow JSON version; that is, they will apply to any Flows being actively sent.
Progress Indicator
We have introduced a new feature to visually inform users about how much progress is left to complete the Flow. This is applicable for any Flows with more than one screen. Text Truncation improvements
Optimized the character limit strategy for components to maximize the amount of content displayed based on device resolution.Stopping WhatsApp Flows Support on Android OS 5.x.x
As announced in May, we have now stopped support for Flows on Android devices running OS 5.x.x and older. This means that Flow messages sent to users on such devices will not be delivered, and you will receive a webhook containing a “Message Undeliverable” error. For more details on this error, please refer to the error codes documentation.
May 2024 release
Deprecating data_channel_uri
Stopping WhatsApp Flows Support on Android OS 5.x.x
- Starting June 11th, 2024, WhatsApp Flows will only be supported on Android OS 6.0 and newer versions. This means that businesses will no longer be able to send Flow messages to users with Android OS 5.x.x devices and will receive a webhook containing a “Message Undeliverable” error when trying to do so. For more details on error, please refer to the error codes.
- Additionally, starting from July 9th, 2024, users on Android OS 5.x.x devices will no longer be able to interact with any existing Flow messages.
April 2024 release
Support the Optin component in the Flows UI builder
- Extend the support of the opt-in component in the Message Templates in Flows UI editor to allow users to add and modify an additional "Read More" screen.
- This feature enables you to display additional information (e.g., terms and conditions) on a separate screen instead of cluttering the main Flow screen. This would improve the user experience and simplifying the Flow creation process.
March 2024 release
Flows template gallery
- Adds a new screen for creating flow. The users can now interact with the template before using it for creating a flow.
Exposing "UpdatedAt" field
- New field “UpdatedAt” exposed for the GraphAPI endpoints.
- The field is updated for every flow when name, status, flow json, etc. changes.
- The field is returned with the GraphAPI endpoint and used on the WA Manager -> Flows page.
BugFix- "form_name" will be removed from business paylaod
- Bug fix for Android implementation where 'form_name' was unintentionally included in payload. If businesses are using this, then they may need to modify server implementations for a more sustainable setup.
February 2024 release
Details page
- Introduce a new details page that provides a clear overview of Flow endpoint performance, with data on availability, latency, requests, and errors.
- This page is available for published Flows with endpoint from the Flows Builder in WhatsApp Manager.
Monitoring API
- Introduce a new GraphAPI field in WA Flow object named “metric” which allows businesses retrieving a set of endpoint related metrics.
Send Flow via WhatsApp Manager
- Introduce a new feature in the Flows Builder that allows Flows to be sent directly via WhatsApp Manager. The functionality works only with phone numbers registered to Cloud API.
New flow template: appointment booking template
- Add a new flow JSON template “Book an Appointment” which can be used when creating a flow in Builder. The flow template can be found here.
- Add an endpoint example in NodeJS that works with the “Book an Appointment” flow JSON end to end. The endpoint code is available on Github and Glitch.
- Enhance the endpoint example on Github and Glitch to include app secret validation, endpoint error codes, script to create public/private keys, and other improvements.
Endpoint public key setup validation during sending flow messages via OnPrem
- On-Premises API may reject sending messages with flows connected to endpoints with error code 2068 if required setup is not complete, for example, public key is not uploaded or is invalid.
January 2024 release
Introduces support for Flow JSON version 3.1
Adds optional property ‘success’ for terminal screens to indicate whether terminating on that screen results in a successful flow completion.
A new field 'endpoint_uri' has been introduced and should be used instead of deprecated 'data_channel_uri'.
API changes
December 2023 release
Adds an end-to-end example for an endpoint server in Node.js that can be edited online on Glitch. The source code is also available on Github.
Introduces support for Flow JSON version 3.0
- Removes the “data_channel_uri” property from Flow JSON
- Introduces ability to specify Flow endpoint via API or WhatsApp Manager.
WhatsApp Manager changes
- Adds additional filtering options (by ID and status) on the listing page of Flows
- Adds support for deleting and deprecating Flows
- Adds the ability to clone Flows
Flows in Message Templates
- Adds support for attaching images when creating and attaching Forms in Message Templates
- Adds new custom form starter template when creating and attaching Forms in Message Templates
API changes
October 2023 release
Initial release of the WhatsApp Flows.
Introduces support for Flow JSON version 2.1
Introduces support for Data Api version 3.0
