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

O que é

Gerencie eventos de criação de cancelamento de inscrição de contatos.

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 que você precisa.
  • 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 demoradas de forma assíncrona.

Requisição

Os cenários abaixo mostram requisições entregues na 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 endpoints, validação de assinatura e comportamento de novas tentativas, consulte Configurar webhooks.


ocorre quando o usuário cancela a inscrição da mensagem de WhatsApp que você enviou. O payload do webhook contém informações do número de telefone celular do usuário e o horário do cancelamento de inscrição.

Exemplo de Cancelamento de Inscrição de Contato Criado

Requisição

Resposta

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

Explicação

  • O objeto unsubscriberChanged contém as informações do número de telefone celular do usuário e o horário do cancelamento da inscrição.