whatsapp.flow.status_change

Use whatsapp.flow.status_change para manipular este evento em seu endpoint de webhook.

Gatilhos

Ocorre quando o status de um fluxo do WhatsApp é atualizado. Inscreva-se em whatsapp.flow.status_change ao configurar seu endpoint de webhook.

Sintaxe

A YCloud envia uma solicitação HTTP POST para a URL de webhook configurada. A estrutura a seguir mostra uma variante de payload. Os valores entre colchetes angulares são marcadores de posição; seus tipos estão listados em Parâmetros. Os campos opcionais e outras variantes estão descritos abaixo.

{
  "type": "whatsapp.flow.status_change",
  "id": "<ID>",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "flowChanges": {
    "flowId": "<FLOW_ID>",
    "wabaId": "<WABA_ID>",
    "message": "<MESSAGE>",
    "oldStatus": "<OLD_STATUS>",
    "newStatus": "<NEW_STATUS>"
  }
}

Parâmetros

Valide o cabeçalho HTTP YCloud-Signature antes de processar o corpo JSON. Consulte a validação de assinatura.

Envelope do evento

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID exclusivo do evento. Tamanho mínimo: `6`. Tamanho máximo: `128`.
`type`	string	Sim	Sempre `whatsapp.flow.status_change`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (date-time)	Sim	O momento em que este evento foi criado, formatado em RFC 3339. Ex.: `2022-06-01T12:00:00.000Z`.

Payload do evento

Parâmetro	Tipo	Obrigatório	Descrição
`flowChanges`	object	Não	Payload específico do evento `flowChanges`.

Os quatro campos comuns do envelope são obrigatórios. Os campos do payload dependem da variante do evento. Em cada tabela de objetos, Obrigatório se aplica quando o objeto pai está presente. Campos opcionais podem ser omitidos; um exemplo não torna um campo obrigatório.

flowChanges

Parâmetro	Tipo	Obrigatório	Descrição
`flowId`	string	Sim	O ID exclusivo do fluxo.
`wabaId`	string	Sim	ID da conta do WhatsApp Business.
`message`	string	Não	O ID da mensagem da alteração de status do fluxo.
`oldStatus`	string	Não	O status anterior do fluxo.
`newStatus`	string	Sim	O novo status do fluxo.

Exemplo

O seguinte JSON é o corpo entregue ao seu receptor. IDs, números de telefone e outros valores de conta são ilustrativos.

{
  "type": "whatsapp.flow.status_change",
  "id": "evt_1234567890abcdef",
  "apiVersion": "v2",
  "createTime": "2025-09-11T07:24:52.000Z",
  "flowChanges": {
    "flowId": "1097420589034000",
    "wabaId": "123456789012345",
    "message": "Flow Webhook 3 changed status from DRAFT to PUBLISHED",
    "oldStatus": "DRAFT",
    "newStatus": "PUBLISHED"
  }
}

Após verificar a assinatura e aceitar o evento de forma duradoura, retorne uma resposta 2xx. Processe tarefas demoradas de forma assíncrona.

HTTP/1.1 200 OK

Para orientações passo a passo de cenários, consulte os exemplos comentados.

Primeiros passos

Guias

Endpoints

Webhook reference

whatsapp.flow.status_change

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

flowChanges

Exemplo

​Gatilhos

​Sintaxe

​Parâmetros

​Envelope do evento

​Payload do evento

​flowChanges

​Exemplo

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

flowChanges

Exemplo