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

​
O que é

Processe resultados de criação e exclusão de grupos do WhatsApp.

​
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 evento 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 ao seu 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 do endpoint, validação de assinatura e comportamento de repetição, consulte Configurar webhooks.

​
Grupo criado

Quando um grupo do WhatsApp for criado com sucesso, você receberá um webhook com a seguinte estrutura de payload:

​
Requisição

​
Resposta

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

​
Explicação

Roteie o evento por type, remova duplicatas por id e transfira tarefas lentas ou propensas a falhas para um processador assíncrono.

​
Grupo excluído

Quando um grupo do WhatsApp for excluído, você receberá um webhook com a seguinte estrutura de payload:

​
Requisição

​
Resposta

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

​
Explicação

  • type: Sempre whatsapp.group.lifecycle_update para eventos de ciclo de vida de grupo
  • whatsappGroup: Contém os detalhes do resultado do ciclo de vida do grupo
    • field: Sempre group_lifecycle_update
    • type: A ação do ciclo de vida, como group_create ou group_delete
    • requestId: O ID da requisição retornado pela operação assíncrona da API de grupo
    • status: O status normalizado do resultado, como created, deleted ou failed
    • groupId: O ID do grupo do WhatsApp
    • inviteLink: O link de convite do grupo, incluído quando a criação do grupo for bem-sucedida
    • dedupeKey: Chave de idempotência para desduplicar eventos de webhook de ciclo de vida de grupo