Flow JSON

Leverage Flow JSON to build your user experience.

To visualize the complete user experience, use the Builder. The Builder emulates the entire Flow experience and can be updated on the fly. To navigate to the Builder:

1. Choose your business
2. Click on All tools in the left side navigation
3. Open WhatsApp Manager and select your WABA
4. On the left side navigation, go to Account tools > Flows

See this list of templates you can build with Flow JSON.

Introduction

Flow JSON enables businesses to create workflows in WhatsApp by accessing the features of WhatsApp Flows using a custom JSON object developed by Meta.

These workflows are initiated, run, and managed entirely inside WhatsApp. It can include multiple screens, data flows, and response messages.

Flow JSON consists of the following sections:

Top-level Flow JSON Properties

Flow JSON has several required and optional properties that are used in the process of compilation and validation of the Flow.

Required properties

• version - represents the version of Flow JSON to use during the compilation. Please refer to the list of versions for more details.

• screens - represents an array or screen as part of the user experience. This is like a set of different pages on your website.

Optional properties

• data_api_version - represents the version to use during communication with the WhatsApp Flows Data Endpoint. Currently, it is 3.0. If flow uses the data-channel capability, the validation system will ask to provide this property.

{
 "version": "3.1",                     
 "data_api_version": "3.0",            
 "routing_model": {"MY_FIRST_SCREEN": ["MY_SECOND_SCREEN"] },
 "screens": [...]
}

Screens

Screens are the main unit of a Flow. Each screen represents a single node in the state machine you define. These properties then make up the Flows screen property model:

"screen" : {
  "id": string,
  "terminal": ?boolean,
  "success": ?boolean,
  "title": ?string,
  "refresh_on_back": ?boolean,
  "data": ?object,
  "layout": object
}

Required properties

• id - unique identifier of the screen which works as a page url. SUCCESS is a reserved keyword and should not be used as a screen id.

• layout - associated screen UI Layout that is shown to the user. Layout can be predefined or it can represent a container with fully customizable content built using WhatsApp Flows Library.

Optional properties

• terminal (optional) - the business flow is the end state machine. It means that each Flow should have a terminal state where we terminate the experience and have the Flow completed. Multiple screens can be marked as terminal. It's mandatory to have a Footer component on the terminal screen.

• data (optional) - declaration of dynamic data that fills the components field in the Flow JSON. It uses JSON Schema to define the structure and type of the properties. Below you can find the simple example.

{
  "data": {
    "first_name": {
      "type": "string",
      "__example__": "John"
    }
  }
}

• title (optional) - screen level attribute that is rendered in the top navigation bar.

• success - (optional, only applicable on terminal screens) - Defaults to true. A Flow can have multiple terminal screens with different business outcomes. This property marks whether terminating on a terminal screen should be considered a successful business outcome.

• refresh_on_back (optional, and only applicable for Flows with a Data Endpoint) - Defaults to false. This property defines whether to trigger a data exchange request with the WhatsApp Flows Data Endpoint when using the back button while on this screen. The property is useful when you need to reevaluate the screen data when returning to the previous screen (example below).

• sensitive - (optional, only applicable for Flows version 5.1 and above) - Defaults to an empty array. When a Flow is completed, users will see a new message UI, which can be clicked and users will be able to view the responses submitted by them. This array contains the names of the fields in the screen that contain sensitive data, and should be hidden in the response summary for the consumers.

Additional information on refresh_on_back

Given a simple Flow example with the following screens:

1. User chooses an Appointment Type.
2. User selects Appointment Time.
3. User Confirms an appoinment.

The user may navigate back from the confirmation page to re-select an appointment time. By using the refresh_on_back property in the Confirmation screen's definition, you can control whether to refresh the list of available times, or to reload the previously shown list.

refresh_on_back=false (default)

If refresh_on_back=false, when the user goes back to the Appointment Time screen the Flow will not request the Flow Data Endpoint and the screen will be loaded with the previously provided data, and the user's prior input. This is the preferred behavior in most cases, given it avoids a roundtrip to the Flow Data Endpoint and provides a snappier experience for the user.

refresh_on_back=true

If, however, you need to revalidate or update the data for the screen, set refresh_on_back=true on the screen from which the back action is triggered (the Confirmation screen in this example). Once the user navigates back to the Appointment Time screen, the Flow will send a request to the Flow Data Endpoint and display the screen with the data from the response.

Flow Data Endpoint Request payload in case of refresh_on_back=true

The complete payload structure is defined here - in this case the action field will be BACK, and the screen will be set to the name of the Confirmation screen.

Additional information on sensitive fields

Given a Flow in which we mark certain fields as sensitive, we use the following masking configuration to display the summary upon the Flow's completion:

Layout

Layout represents screen UI Content. It can be predefined by the WhatsApp Flows team, or the business can use empty containers and build custom experience using the WhatsApp Flows Library.

Layout has the following properties:

1. type - the layout identifier that’s used in the template. In the current version of Flow JSON, there is only one layout available - "SingleColumnLayout" which represents a vertical flexbox container.

2. children - represents an array of components from the WhatsApp Flows Library.

Routing Model

You can define the routing model, which is a directed graph, as each screen can go to multiple other screens. There can be up to a maximum of 10 "branches", or connections, within the routing model.

Consider the following flow:

The following routing model can be built:

1. Item Catalog => [Item Details Page]

2. Item Details Page => [Item Catalog, Checkout]

3. Checkout => []

When to define routes

If you don't use an Endpoint, you don't need to define a routing model, it will be generated automatically. However, if you want to use a server to power your Flow, you'll have to provide a routing_model in your Flow JSON.

How to define routes

Routes are defined per screen via the routing_model property. It is a map of screen ids to an array of other screen ids it can transition to. The terminal screen is defined with terminal=true.

Routing rules

1. Route cannot be the current screen, but the route can be "refreshed" for validation purposes.

2. If there is an edge between two screens, then the user can go back and forth between them using the BACK button.

3. Only forward routes should be specified in the routing model. For example, if you have specified an edge from Screen_A to Screen_B then you shouldn't specify another edge from Screen_B to Screen_A.

4. Routes can be empty for a screen if there is no forward route from it.

5. There should be an entry screen in the routing model. A screen is eligible to be an entry screen if has no inbound edge.
   For example, Item Catalog is the entry screen in the following routing model : Item Catalog => [Checkout] .
   If your Flow is not using a Data Endpoint then an entry screen will be the one which is not set as the "next" screen in any of the "navigate" actions defined in the Flow.

6. All routes must end at the terminal screen.

Routing Model Flow JSON Example (Endpoint)

In the example below, there is a simple 3-screen Flow that uses an Endpoint. It is expected that the server will return the next screen with a response to data_exchange action. The server has to comply with defined routing_model in the Flow JSON:

{
  "version": "3.1",
  "data_api_version": "3.0",
  "routing_model": {
    "MY_FIRST_SCREEN": [
      "MY_SECOND_SCREEN"
    ],
    "MY_SECOND_SCREEN": [
      "MY_THIRD_SCREEN"
    ]
  },
  "screens": [
    {
      "id": "MY_FIRST_SCREEN",
      "title": "First Screen",
      "layout": {
        "type": "SingleColumnLayout",
        "children": [
          {
            "type": "Footer",
            "label": "Continue",
            "on-click-action": {
              "name": "data_exchange",
              "payload": {}
            }
          }
        ]
      }
    },
    {
      "id": "MY_SECOND_SCREEN",
      "title": "Second Screen",
      "data": {},
      "layout": {
        "type": "SingleColumnLayout",
        "children": [
          {
            "type": "Footer",
            "label": "Continue",
            "on-click-action": {
              "name": "data_exchange",
              "payload": {}
            }
          }
        ]
      }
    },
    {
      "id": "MY_THIRD_SCREEN",
      "title": "Third Screen",
      "terminal": true,
      "success": true,
      "data": {},
      "layout": {
        "type": "SingleColumnLayout",
        "children": [
          {
            "type": "Footer",
            "label": "Continue",
            "on-click-action": {
              "name": "data_exchange",
              "payload": {}
            }
          }
        ]
      }
    }
  ]
}

Properties

Properties can be static or dynamic. In Flow JSON the property is static if it is not a type binded to a data or form object.

Static properties

Static properties are simple. You set static properties once and they never change. Here is an example (see text and label properties of TextHeading and Footer components). Static properties is the simplest way to start building your Flow. You can always replace them later with dynamic content.

Dynamic properties

Dynamic properties enables you to set the content dynamically based on the server / screen data via the dynamic data reference mechanism, like so: "${data.username}". If you attempt to use the dynamic and static variant of the property together, you will get a compilation error. The dynamic data reference mechanism works with the following data types:

• string
• number
• boolean
• object
• array

You can dynamically reference these data types in all the components of Flow JSON. There are two types of dynamic properties:

• Form properties - "${form.field_name}" (data entered by the user in input fields). This is used to provide access to information that the user entered on the screen.
• Screen properties - "${data.field_name}" (data provided for the screen). This is used to provide access to information that is passed down by the server or the navigate action from the previous screen.

Declaring screen properties (No endpoint example)

If a screen expects dynamic data, declare it inside the data property. Data declaration uses the standart JSON Schema. A simple Flow example would replace text with dynamic data coming from the message payload:

A few things have been added:

1. Inside MY_FIRST_SCREEN we declared a data field

2. Inside the data field we declared hello_world_text. This is the data that we expect to receive for screen.

   • hello_world_text follows the JSON Schema specification to declare the expected type, in this example it is a string.
   • __example__ field serves as mock data for the template, which is useful while you’re developing your template without WhatsApp Flows Data Endpoint integration. This field is mandatory.

3. In TextHeading we’ve referenced the data via dynamic data reference syntax. ${data} represents an object that came from the WhatsApp Flows Data Endpoint or navigate actions in case of Flow without endpoint. You can treat it as a screen state that was set after the response is received.

4. Property of the state can be accessed using the following pattern - "${data.property_name}"

Declaring screen properties (Endpoint powered example)

If you want to power the screen by endpoint data, the example above will slightly change.

1. We've added data_api_version, routing_model and data_channel_uri to indicate that the flow is connected to server.

2. We've added data_api_version and routing_model to indicate that the flow is connected to server. data_channel_uri should also be added if the Flow JSON version is less than 3.0.

3. Flow expects to receive a payload from flow data server containing hello_world_text field.

<form>
  <label for="first_name">First name</label><br>
  <input type="text" id="first_name" name="first_name"><br>
  <label for="last_name">Last name</label><br>
  <input type="text" id="last_name" name="last_name">
  
  <input type="radio" id="html" name="fav_language" value="HTML">
  <label for="html">HTML</label><br>

  <input type="radio" id="css" name="fav_language" value="CSS">
  <label for="css">CSS</label><br>

  <input type="radio" id="javascript" name="fav_language" value="JavaScript">
  <label for="javascript">JavaScript</label>
</form>

{
  "type": "Footer",
  "label": "Submit data",
  "on-click-action": {
    "name": "navigate",
    "next": { "type": "screen", "name": "NEXT_SCREEN" },
    "payload": {
      "name": "${form.first_name}",
      "lang": "${form.favourite_language}"
    }
  }
}

{
  "type": "Footer",
  "label": "Submit data",
  "on-click-action": {
    "name": "data_exchange",
    "payload": {
      "name": "${form.first_name}",
      "lang": "${form.favourite_language}"
    }
  }
}

Supported starting with Flow JSON version 4.0

Global dynamic and form properties [Early Release]

Starting from Flow JSON Version 4.0, you can use Global Dynamic Referencing feature. It has the following syntax:

${screen.<screen_name>.(form | data).<field-name>}  

1. screen - global variable that gives access to screen storage
2. screen_name - name of the screen to refer
3. (form | data) - type of storage you want to reference - Form / Dynamic data
4. field-name - name of the field you want to reference

Where it can be used

1. Component properties that support dynamic data
2. Action payloads
3. Screen titles
4. Conditional components

Example 1 - Carrying data forward

Before Flow JSON Version 4.0, to transfer data from one screen to another you would need to use navigate action. For instance to transfer the data from SCREEN_ONE to SCREEN_TWO, you would write the following:

"on-click-action": {
  "name": "navigate",
  "next": {
           "type": "screen",
           "name": "SCREEN_TWO"
          },
   "payload": {
      "field1": "${data.field_one}",
      "field2": "${form.field_two}"
    }
}

In Flow JSON V4.0 you don't need to transfer the data via navigate since all data now is globally accessable, so instead you can keep payload as empty {}

"on-click-action": {
  "name": "navigate",
  "next": {
           "type": "screen",
           "name": "SCREEN_TWO"
          },
   "payload": {}
}

And on SCREEN_TWO you can reference it as:

{
  "type": "TextBody",
  "text": "${screen.SCREEN_ONE.data.field1}"
}

Example 2 - No screen data declaration for global fields

When you use global fields on the screen, you don't need to specify them in the data model. Global fields utilise data-model of the parent screens. See example below, we use ${screen.SCREEN_ONE.form.field1} and ${screen.SCREEN_ONE.data.field2} on SCREEN_TWO, since the data comes from SCREEN_ONE, we keep data model as empty on SCREEN_TWO

Example 3 - Forward references

When you use global fields on the screen, you can also reference "future" screens. The only caveat is that you need to handle empty values. This can be done with Conditional Rendering components. See example below:

1. SELECT_SERVICES screen references the data from SELECT_INSURANCE
2. When value from SELECT_INSURANCE screen is empty - we display You haven't selected any insurance type
3. When value is not empty, based on selected value - we display different text via Switch statement

Actions

Flow JSON provides a generic way to trigger asynchronous actions handled by a client through interactive UI elements. The following actions are supported:

navigate action

This action is a primary way to navigate between the screens of the flow. The data that's passed as payload of this action will be available on the next screen through dynamic data referencing - ${data.field_name}. You shouldn't use it on the Footer of a terminal screen because that will prevent the flow from terminating.

When to use

Use this action when you need to transition to another screen.

Example

{
  "type": "Footer",
  "label": "Continue",
  "on-click-action": {
    "name": "navigate",
    "next": { "type": "screen", "name": "NEXT_SCREEN" },
    "payload": {
      "name": "${form.first_name}",
      "lang": "${form.favourite_language}"
    }
  }
}

complete action

Terminates the flow and sends the response message to the chat thread. The business will receive the termination message bubble on the webhook, together with the flow_token and all of the other parameters from the payload. More information can be found here.

When to use

Use this action on terminal screen as a last interaction of the user. Once triggered, the flow will be terminated and entered data will be submitted via webhook.

Example

{
  "type": "Footer",
  "label": "Submit data",
  "on-click-action": {
    "name": "complete",
    "payload": {
      "discount_code": "${data.discount_code}",
      "items": "${form.selected_items}"
    }
  }
}

Example of flow using navigate and complete actions

data_exchange action

Sends data to WhatsApp Flows Data Endpoint.

When to use

Use can only use this action if your Flow is powered by a Data Endpoint. Use this action when you need to submit data to your server before transitioning to the next screen or terminating the flow. Your server could then decide on the next step and provide the input for it.

Example

{
  "type": "Footer",
  "label": "Submit data",
  "on-click-action": {
    "name": "data_exchange",
    "payload": {
      "discount_code": "${data.discount_code}",
      "items": "${form.selected_items}"
    }
  }
}

Components

A comprehensive list of components with code examples is available here.

Static Validation Errors

A comprehensive list of validation errors is available here.

Limitations

Flow JSON content string is limited and cannot exceed 10 MB.