Para o catálogo completo derivado do schema, consulte todos os exemplos.
O que é
Explore orientações passo a passo de webhooks específicos por evento, pré-requisitos e exemplos de payload.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 de forma segura.
- Torne o processamento de eventos idempotente.
Como funciona
A YCloud envia uma requisição HTTPPOST 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 na URL do seu webhook. Trate oid do evento como o identificador de entrega e use type para rotear o payload.
Resposta
Retorne um status2xx após aceitar o evento.
Para configuração de endpoint, validação de assinatura e comportamento de novas tentativas, consulte Configurar webhooks.
Eventos de mensagem e modelo
Análise de modelo
Processe estados de modelo aprovado, rejeitado, pausado, desativado e arquivado.
Status da mensagem
Processe mensagens de saída enviadas, entregues, lidas e com falha.
Mensagens recebidas
Faça o parse de mensagens de texto, mídia, localização, contato, interativas, comerciais e do sistema.
Atualizações de pagamento
Processe alterações em transações de pagamento do WhatsApp.
Eventos de eco e transferência de agente
Para agentes integrados por meio da API REST pública, use estes passos a passo específicos por evento. Agentes criados pelo Console usam um fluxo separado de sincronização de caixa de entrada.Mensagem de eco criada
Armazene ecos de texto e mídia enviados.
Mensagem de eco atualizada
Processe atualizações de status de entregue, lido, envio tardio e com falha.
Transferência de agente atualizada
Monitore a transferência de controle e compreenda seus limites de correlação.
Eventos de conta, aplicativo e Flow
Atualizações da conta comercial
Processe alterações de elegibilidade, localização, violação, restrição e estado da conta.
Histórico do aplicativo comercial
Sincronize mensagens históricas recebidas e enviadas.
Ecos de mensagens do aplicativo comercial
Sincronize mensagens enviadas pelo WhatsApp Business App.
Status do Flow
Processe alterações no status do ciclo de vida do Flow.
Eventos de chamadas e grupos
Conexão de chamada
Processe ofertas e respostas SDP para chamadas do WhatsApp.
Status da chamada
Processe estados de chamada chamando, aceita e rejeitada.
Encerramento de chamada
Processe encerramentos de chamada concluídos e com falha.
Ciclo de vida do grupo
Processe a criação e exclusão de grupos.
Participantes do grupo
Processe alterações de participantes e solicitações de entrada.
Configurações do grupo
Processe alterações de assunto e descrição do grupo.
Status do grupo
Processe a suspensão e o restabelecimento do grupo.
Eventos de contato
Contato criado
Processe contatos recém-criados.
Contato excluído
Remova ou reconcilie contatos excluídos.
Atributos do contato alterados
Processe alterações de perfil, atributos personalizados e tags.
Contato cancelou a inscrição
Processe registros de opt-out recém-criados.
Contato reinscreveu-se
Processe registros de opt-out excluídos.
Abra o catálogo completo de payloads
Explore todos os tipos de evento e todos os exemplos de payload nomeados da especificação OpenAPI.