whatsapp.business_account.reviewed

Use whatsapp.business_account.reviewed para manipular este evento em seu endpoint de webhook.

Gatilhos

Ocorre quando uma conta do WhatsApp Business foi analisada. Assine whatsapp.business_account.reviewed ao configurar seu endpoint de webhook.

Sintaxe

A YCloud envia uma solicitação HTTP POST para a URL de webhook configurada. O formato a seguir mostra uma variante do 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 são descritos abaixo.

{
  "id": "<ID>",
  "type": "whatsapp.business_account.reviewed",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappBusinessAccount": {
    "id": "<ID>",
    "decision": "<DECISION>",
    "accountReviewStatus": "<ACCOUNT_REVIEW_STATUS>"
  }
}

Parâmetros

Valide o cabeçalho HTTP YCloud-Signature antes de processar o corpo JSON. Consulte 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.business_account.reviewed`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (date-time)	Sim	A data e hora em que este evento foi criado, formatada em RFC 3339. Por exemplo, `2022-06-01T12:00:00.000Z`.

Payload do evento

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

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

whatsappBusinessAccount

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	ID da conta do WhatsApp Business.
`name`	string	Não	Nome amigável para diferenciar contas do WhatsApp Business.
`accountReviewStatus`	string	Não	Status de análise da conta do WhatsApp Business. Valores: `PENDING`, `APPROVED`, `REJECTED`.
`businessVerificationStatus`	string	Não	Status atual da verificação comercial da conta do Meta Business que possui esta conta do WhatsApp Business. Valores: `expired`, `failed`, `ineligible`, `not_verified`, `pending`, `pending_need_more_info`, `pending_submission`, `rejected`, `revoked`, `verified`.
`decision`	string	Não	Decisão de análise tomada nesta conta do WhatsApp Business. Um dos valores: `APPROVED` ou `REJECTED`.

Exemplo

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

{
  "id": "evt_example_whatsapp_business_account_reviewed",
  "type": "whatsapp.business_account.reviewed",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "whatsappBusinessAccount": {
    "id": "whatsapp-business-account-id",
    "decision": "APPROVED",
    "accountReviewStatus": "APPROVED"
  }
}

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

HTTP/1.1 200 OK

Para orientações de cenários, consulte exemplos anotados.

Primeiros passos

Guias

Endpoints

Webhook reference

whatsapp.business_account.reviewed

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

whatsappBusinessAccount

Exemplo

​Gatilhos

​Sintaxe

​Parâmetros

​Envelope do evento

​Payload do evento

​whatsappBusinessAccount

​Exemplo

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

whatsappBusinessAccount

Exemplo