Skip to main content
Para o catálogo completo derivado do schema, consulte todos os exemplos.

O que é

Manipule eventos de alteração de status do WhatsApp Flow.

Antes de começar

  • Crie um endpoint HTTPS público na sua aplicação.
  • Configure um endpoint de webhook da YCloud para os tipos de eventos necessários.
  • Armazene o segredo de assinatura do endpoint com segurança.
  • Torne o processamento de eventos idempotente.

Como funciona

A YCloud envia uma requisição HTTP POST quando o evento ocorre. Verifique a assinatura, registre o evento de forma durável, retorne uma resposta 2xx e processe tarefas lentas de forma assíncrona.

Requisição

Os cenários abaixo mostram requisições entregues à sua URL de webhook. Trate o id do evento como o identificador de entrega e use type para rotear o payload.

Resposta

Retorne um status 2xx após aceitar o evento.
Para configuração de endpoint, validação de assinatura e comportamento de repetição, consulte Configurar webhooks.

Alteração de Status do Flow

Quando um WhatsApp Flow altera seu status (por exemplo, de DRAFT para PUBLISHED), você receberá um webhook com a seguinte estrutura de payload:

Requisição

Resposta

Confirme a entrega após aceitar o evento de forma durável.

Explicação

  • type: Sempre whatsapp.flow.status_change para eventos de alteração de status de flow
  • flowChanges: Contém os detalhes da alteração de status do flow
    • flowId: O ID exclusivo do Flow cujo status foi alterado
    • wabaId: ID da conta do WhatsApp Business associada ao flow
    • message: Descrição legível por humanos da alteração de status
    • oldStatus: O status anterior do flow
    • newStatus: O status atual do flow

Valores Comuns de Status do Flow

  • DRAFT
  • PUBLISHED
  • DEPRECATED
  • BLOCKED
  • THROTTLED