> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Exemplos de Webhook

> Encontre acionadores, sintaxe do payload, parâmetros e exemplos para cada evento de webhook da YCloud.

Consulte um evento pelo seu `type` exato. Cada referência inclui **Acionadores**, **Sintaxe**, **Parâmetros** e **Exemplo**. Esta referência cobre todos os 47 tipos de evento no contrato de webhook da YCloud.

A YCloud entrega seu próprio envelope de evento. Use os nomes de eventos e campos nestas páginas ao integrar com a YCloud.

Antes de receber eventos, [configure um endpoint de webhook](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md), assine os tipos de evento necessários e valide o cabeçalho `YCloud-Signature`.

Use os payloads de exemplo em cada página de evento para testar o seu receptor.

## Envelope comum

Cada evento inclui `id`, `type`, `apiVersion` e `createTime`. Faça o roteamento por `type` e deduplique pelo `id` do evento. Os campos de payload específicos do evento variam de acordo com o evento e o cenário.

Verifique a assinatura e aceite o evento de forma duradoura antes de retornar uma resposta `2xx`. Para novas tentativas e configuração do receptor, consulte [Configurar webhooks](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Messenger

| Tipo de evento | Acionador |
| - | - |
| [`messenger.inbound_message.received`](https://docs.ycloud.com/pt/api-reference/webhook-reference/messenger-inbound-message-received) | Ocorre quando uma mensagem de texto comum do Messenger é recebida de um cliente. |
| [`messenger.inbound_message.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/messenger-inbound-message-updated) | Ocorre quando um cliente edita uma mensagem de texto recebida salva do Messenger. |
| [`messenger.message.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/messenger-message-updated) | Ocorre quando um snapshot de mensagem de saída comum salvo do Messenger fica disponível, incluindo resultados de envio e confirmações correspondentes. |
| [`messenger.message_reaction.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/messenger-message-reaction-updated) | Ocorre quando um cliente reage ou remove uma reação de uma mensagem do Messenger. |

## Mensagens do WhatsApp

| Tipo de evento | Acionador |
| - | - |
| [`whatsapp.inbound_message.received`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-inbound-message-received) | Ocorre quando uma mensagem recebida do WhatsApp é recebida. |
| [`whatsapp.message.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-message-updated) | Ocorre quando o status de uma mensagem de saída do WhatsApp é atualizado e muda para `sent`, `failed`, `delivered` ou `read`. |
| [`whatsapp.user.preferences`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-user-preferences) | Ocorre quando um usuário do WhatsApp bloqueia mensagens de marketing ou quando retoma mensagens de marketing. |

## Modelos do WhatsApp

| Tipo de evento | Acionador |
| - | - |
| [`whatsapp.template.category_updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-template-category-updated) | Ocorre quando a categoria de um modelo do WhatsApp é atualizada. |
| [`whatsapp.template.correct_category_detection`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-template-correct-category-detection) | Ocorre quando a Meta detecta conteúdo não utilitário no Utility Direct Send. Assine por meio da API de endpoint de webhook. |
| [`whatsapp.template.quality_updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-template-quality-updated) | Ocorre quando a avaliação de qualidade de um modelo do WhatsApp é atualizada. |
| [`whatsapp.template.reviewed`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-template-reviewed) | Ocorre quando um modelo do WhatsApp recebe uma atualização de análise ou ciclo de vida, incluindo aprovação, rejeição, pausa, desativação, arquivamento e desarquivamento. |

## Contas do WhatsApp

| Tipo de evento | Acionador |
| - | - |
| [`whatsapp.business_account.deleted`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-business-account-deleted) | Ocorre quando uma conta do WhatsApp Business é excluída. |
| [`whatsapp.business_account.reviewed`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-business-account-reviewed) | Ocorre quando uma conta do WhatsApp Business foi analisada. |
| [`whatsapp.business_account.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-business-account-updated) | Ocorre quando ocorreu uma violação de política, uma conta do WhatsApp Business foi banida e muito mais. |

## Números de telefone do WhatsApp

| Tipo de evento | Acionador |
| - | - |
| [`whatsapp.phone_number.deleted`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-phone-number-deleted) | Ocorre quando um número de telefone comercial do WhatsApp é excluído. |
| [`whatsapp.phone_number.name_updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-phone-number-name-updated) | Ocorre quando o nome de um número de telefone comercial do WhatsApp foi aprovado ou rejeitado. |
| [`whatsapp.phone_number.quality_updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-phone-number-quality-updated) | Ocorre quando a qualidade, o limite de mensagens ou o status de conexão da conta de um número de telefone comercial do WhatsApp são atualizados. |
| [`whatsapp.phone_number.business_username_updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-phone-number-business-username-updated) | Ocorre quando o nome de usuário comercial de um número de telefone comercial do WhatsApp é atualizado. |

## WhatsApp Business App

| Tipo de evento | Acionador |
| - | - |
| [`whatsapp.smb.history`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-smb-history) | Ocorre quando o histórico de mensagens do WhatsApp Business App é sincronizado. |
| [`whatsapp.smb.message.created`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-smb-message-created) | Ocorre quando uma mensagem é enviada a partir do WhatsApp Business App. |
| [`whatsapp.smb.message.echoes`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-smb-message-echoes) | Ocorre quando uma mensagem enviada a partir do WhatsApp Business App é sincronizada como um eco. |

## WhatsApp Agents

| Tipo de evento | Disparador |
| - | - |
| [`whatsapp.echo_message.created`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-echo-message-created) | Ocorre quando uma mensagem de eco de saída é registrada para um Public REST API Agent. |
| [`whatsapp.echo_message.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-echo-message-updated) | Ocorre quando um status de eco de saída é recebido para um Public REST API Agent; status tardios de classificação inferior também podem ser entregues. |
| [`whatsapp.meta_business_agent.handover.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-meta-business-agent-handover-updated) | Ocorre quando um callback de handover com suporte transfere o controle para fora de um Public REST API Agent. Não confirma a atribuição na Inbox. |

## Chamadas do WhatsApp

| Tipo de evento | Disparador |
| - | - |
| [`whatsapp.call.connect`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-call-connect) | Ocorre quando uma chamada recebida fornece uma oferta SDP ou uma chamada iniciada pela empresa fornece uma resposta SDP. |
| [`whatsapp.call.terminate`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-call-terminate) | Ocorre quando uma chamada do WhatsApp é encerrada. |
| [`whatsapp.call.status.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-call-status-updated) | Ocorre quando o status de uma chamada do WhatsApp é atualizado. |
| [`whatsapp.call.recording.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-call-recording-updated) | Ocorre quando uma gravação de chamada do WhatsApp originada por API se torna disponível ou falha permanentemente. |
| [`whatsapp.call.transcription.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-call-transcription-updated) | Ocorre quando uma transcrição de chamada do WhatsApp originada por API se torna disponível ou falha permanentemente. |

## Grupos do WhatsApp

| Tipo de evento | Disparador |
| - | - |
| [`whatsapp.group.lifecycle_update`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-group-lifecycle-update) | Ocorre quando um grupo do WhatsApp é criado ou excluído, incluindo resultados bem-sucedidos e com falha. |
| [`whatsapp.group.participants_update`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-group-participants-update) | Ocorre quando os participantes de um grupo do WhatsApp ou solicitações de entrada são atualizados. |
| [`whatsapp.group.settings_update`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-group-settings-update) | Ocorre quando as configurações de um grupo do WhatsApp são atualizadas, incluindo resultados bem-sucedidos e com falha. |
| [`whatsapp.group.status_update`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-group-status-update) | Ocorre quando o status de suspensão de um grupo do WhatsApp é atualizado. |

## WhatsApp Flows e pagamentos

| Tipo de evento | Disparador |
| - | - |
| [`whatsapp.flow.status_change`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-flow-status-change) | Ocorre quando o status de um WhatsApp Flow é atualizado. |
| [`whatsapp.payment.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/whatsapp-payment-updated) | Ocorre quando uma transação de pagamento do WhatsApp é alterada. |

## Contatos

| Tipo de evento | Disparador |
| - | - |
| [`contact.attributes_changed`](https://docs.ycloud.com/pt/api-reference/webhook-reference/contact-attributes-changed) | Ocorre quando os atributos de um contato são alterados. |
| [`contact.created`](https://docs.ycloud.com/pt/api-reference/webhook-reference/contact-created) | Ocorre quando um contato é criado. |
| [`contact.deleted`](https://docs.ycloud.com/pt/api-reference/webhook-reference/contact-deleted) | Ocorre quando um contato é excluído. |
| [`contact.unsubscribe.created`](https://docs.ycloud.com/pt/api-reference/webhook-reference/contact-unsubscribe-created) | Ocorre quando um contato cancela a inscrição para receber mensagens. |
| [`contact.unsubscribe.deleted`](https://docs.ycloud.com/pt/api-reference/webhook-reference/contact-unsubscribe-deleted) | Ocorre quando um contato retoma a inscrição para receber mensagens. |
| [`contact.note.created`](https://docs.ycloud.com/pt/api-reference/webhook-reference/contact-note-created) | Ocorre quando uma nota de contato é criada. |
| [`contact.note.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/contact-note-updated) | Ocorre quando uma nota de contato é atualizada. |
| [`contact.note.deleted`](https://docs.ycloud.com/pt/api-reference/webhook-reference/contact-note-deleted) | Ocorre quando uma nota de contato é excluída de forma independente. A exclusão de um contato não emite este evento para notas em cascata. |

## E-mail, SMS e Voz

| Tipo de evento | Disparador |
| - | - |
| [`email.delivery.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/email-delivery-updated) | Ocorre quando o status de entrega de um e-mail é atualizado e o status muda para `delivered` ou `failed`. |
| [`sms.message.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/sms-message-updated) | Ocorre quando o status de uma mensagem SMS é atualizado e o status muda para `delivered` ou `undelivered`. |
| [`sms.inbound.received`](https://docs.ycloud.com/pt/api-reference/webhook-reference/sms-inbound-received) | Ocorre quando uma mensagem SMS de entrada é recebida, o que significa que um usuário respondeu à sua mensagem. |
| [`voice.message.updated`](https://docs.ycloud.com/pt/api-reference/webhook-reference/voice-message-updated) | Ocorre quando o status de uma mensagem de voz é atualizado e o status muda para `delivered` ou `undelivered`. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.