Flow JSON

Flow JSON é o documento declarativo que define um WhatsApp Flow: as telas, os componentes de cada tela, as validações e as rotas de navegação entre elas. É o que se envia à Meta ao publicar um formulário — o editor visual apenas gera esse JSON no fim.

Atualizado em


Também chamado de: Flow JSON, estrutura do Flow.

Como funciona

Um Flow JSON tem uma versão de esquema (version) e uma lista de telas (screens). Cada tela tem um id, um title e um layout com os componentes que aparecem para o usuário.

Os componentes são tipados: TextInput, TextArea, RadioButtonsGroup, CheckboxGroup, Dropdown, DatePicker, CalendarPicker, OptIn, PhotoPicker, DocumentPicker, ImageCarousel, entre outros, além dos blocos de texto (TextHeading, TextBody, TextCaption).

A navegação entre telas é declarada no routing_model, que descreve quais telas podem levar a quais. Telas inalcançáveis fazem a publicação falhar.

O contrato tem regras de forma que não perdoam: números precisam ser número e não string, RichText só pode ocupar a tela sozinho, cada tela aceita no máximo um PhotoPicker ou DocumentPicker, e o carrossel aceita no máximo três imagens.

Na prática

  • Escrever Flow JSON à mão é possível, mas o erro mais comum não é de sintaxe e sim de contrato: o JSON é válido e a Meta recusa mesmo assim.

  • Um editor visual resolve isso ao gerar apenas combinações que a Meta aceita — o JSON deixa de ser algo que você escreve e passa a ser algo que você publica.

Perguntas frequentes

Preciso saber programar para criar um WhatsApp Flow?
Não necessariamente. O Flow JSON é o formato que a Meta recebe, mas editores visuais montam esse documento a partir de uma interface de arrastar e soltar, validando as regras de contrato antes da publicação.

Fontes

Leia também