Skip to main content

O que é

Este catálogo abrange todos os 47 tipos de evento de webhook na especificação OpenAPI e preserva cada exemplo de payload nomeado.

Como funciona

Escolha um evento pelo seu type exato, expanda um exemplo e use o payload para testar roteamento, desserialização, idempotência e processamento assíncrono no seu receptor de webhook.

Requisição

Cada exemplo é o corpo JSON de uma requisição HTTP POST enviada pela YCloud. A requisição também inclui um cabeçalho YCloud-Signature que você deve validar antes de confiar no payload.

Resposta

Retorne uma resposta 2xx depois que seu aplicativo tiver aceitado o evento de forma duradoura.
Para gatilhos de eventos, campos de payload e exemplos, consulte Exemplos de Webhook.

Catálogo de payloads

Use messengerInboundMessage.id para correlacionar mensagens repetidas de clientes; preserve os espaços em branco do texto.
A mesma mensagem salva agora contém o texto mais recente e o histórico cumulativo de edições.
Use o ID da mensagem para correlacionar snapshots; horários intermediários de entrega desconhecidos são omitidos.
A mensagem de destino da Meta não precisa ter um registro local de mensagem na YCloud.
As remoções podem omitir o nome da reação e o emoji.
Armazene o texto de whatsappMessage.text.body. id e wamid vinculam eventos de status subsequentes.
O conteúdo da mensagem varia conforme o tipo. Trate IDs de mídia como referências do provedor, não como URLs públicas de download.
Correlacione com o evento created por id ou wamid. Eventos updated omitem o conteúdo e o tipo da mensagem.
Correlacione com o evento created por id ou wamid. Eventos updated omitem o conteúdo e o tipo da mensagem.
Um status de origem de prioridade mais baixa pode chegar após a leitura. Registre o evento sem fazer downgrade do status atual da sua mensagem.
Esta é uma mensagem com falha separada, não uma transição a partir de lida. Atualizações com falha incluem detalhes de erro da origem quando disponíveis.
APP_CONTROL_TAKEN relata a transferência de controle, não uma atribuição de funcionário na Caixa de entrada nem a entrega de mensagem personalizada de transferência. actor é o ID do app proprietário anterior neste exemplo.
Leia whatsappBusinessAccount.id para identificar a conta. Quando presentes, removedReason, removedInitiatedBy e removedTime descrevem a remoção. Preserve valores desconhecidos de motivo e iniciador.
Leia qualityRating e qualityUpdateEvent de whatsappPhoneNumber. messagingLimit descreve o nível do número de telefone; whatsappBusinessManagerMessagingLimit descreve o limite do portfólio de negócios proprietário.
Exemplo de payload quando os atributos do contato são alterados
Exemplo de payload quando um novo contato é criado
Exemplo de payload quando um contato é excluído
Emitido apenas para a exclusão independente de uma nota, não para a exclusão em cascata de contatos.
Exemplo de payload quando um cliente cancela a assinatura
Exemplo de payload quando um cliente retoma a assinatura
Exemplo de payload quando um nome de usuário comercial de número de telefone do WhatsApp se torna ativo
Exemplo de payload quando um número de telefone do WhatsApp tem uma solicitação de Business Username reservado
A Meta detectou conteúdo de marketing em uma mensagem de Utility Direct Send. Assine este evento por meio da API de endpoint de webhook.
A Meta restringiu o Utility Direct Send por 7 dias após o uso indevido recorrente da categoria.
Exemplo de payload quando um modelo do WhatsApp é arquivado
Exemplo de payload quando um modelo do WhatsApp é desarquivado. O status do modelo é o status atual retornado pela Meta e não representa uma nova análise de aprovação.
Exemplo de payload quando uma chamada do WhatsApp é conectada
Exemplo de payload quando uma chamada do WhatsApp é encerrada
Exemplo de payload quando o status de uma chamada do WhatsApp é atualizado
Exemplo de payload quando uma gravação de chamada originada via API fica disponível
Exemplo de payload quando uma transcrição de chamada originada via API falha permanentemente
Exemplo de payload quando um grupo do WhatsApp é criado
Exemplo de payload quando participantes de grupo do WhatsApp são adicionados
Exemplo de payload quando as configurações de grupo do WhatsApp são atualizadas
Exemplo de payload quando o status de suspensão de um grupo do WhatsApp é alterado
Leia a mensagem de saída em whatsappMessage. O tipo da mensagem seleciona seu objeto de conteúdo; este exemplo contém texto.
Este evento sincroniza uma mensagem enviada a partir do aplicativo WhatsApp Business ou de um dispositivo complementar compatível. Leia seu conteúdo em whatsappMessage.
Uma mensagem de histórico de entrada usa whatsappInboundMessage. phase e progress informam a sincronização do bloco de histórico.
Uma mensagem de histórico de saída usa whatsappMessage. Não a encaminhe como uma mensagem de entrada.
Um bloco de histórico contendo apenas metadados informa phase e progress sem nenhum dos objetos de mensagem. Não trate essa estrutura como um payload de message-created ou message-echoes.