> ## 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

> Explore orientações passo a passo de webhooks específicos por evento, pré-requisitos e exemplos de payload.

<Note>Para o catálogo completo derivado do schema, consulte [todos os exemplos](/pt/api-reference/guides/examples/webhook-examples/webhook-payload-examples).</Note>

## 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 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 na URL do seu 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.

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```

<Note>Para configuração de endpoint, validação de assinatura e comportamento de novas tentativas, consulte [Configurar webhooks](/pt/api-reference/guides/api-fundamentals/configure-webhooks).</Note>

## Eventos de mensagem e modelo

<CardGroup cols={2}>
  <Card title="Análise de modelo" icon="rectangle-list" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-template-reviewed-webhook-examples">
    Processe estados de modelo aprovado, rejeitado, pausado, desativado e arquivado.
  </Card>

  <Card title="Status da mensagem" icon="message-check" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples">
    Processe mensagens de saída enviadas, entregues, lidas e com falha.
  </Card>

  <Card title="Mensagens recebidas" icon="inbox" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-inbound-message-webhook-examples">
    Faça o parse de mensagens de texto, mídia, localização, contato, interativas, comerciais e do sistema.
  </Card>

  <Card title="Atualizações de pagamento" icon="credit-card" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-payment-updated-webhook-examples">
    Processe alterações em transações de pagamento do WhatsApp.
  </Card>
</CardGroup>

## 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.

<CardGroup cols={2}>
  <Card title="Mensagem de eco criada" icon="clone" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created">
    Armazene ecos de texto e mídia enviados.
  </Card>

  <Card title="Mensagem de eco atualizada" icon="message-check" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-updated">
    Processe atualizações de status de entregue, lido, envio tardio e com falha.
  </Card>

  <Card title="Transferência de agente atualizada" icon="arrow-right-arrow-left" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-meta-business-agent-handover-updated">
    Monitore a transferência de controle e compreenda seus limites de correlação.
  </Card>
</CardGroup>

## Eventos de conta, aplicativo e Flow

<CardGroup cols={2}>
  <Card title="Atualizações da conta comercial" icon="building" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples">
    Processe alterações de elegibilidade, localização, violação, restrição e estado da conta.
  </Card>

  <Card title="Histórico do aplicativo comercial" icon="clock-rotate-left" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-business-app-history-message-webhook-examples">
    Sincronize mensagens históricas recebidas e enviadas.
  </Card>

  <Card title="Ecos de mensagens do aplicativo comercial" icon="clone" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-business-app-sent-message-sync-webhook-examples">
    Sincronize mensagens enviadas pelo WhatsApp Business App.
  </Card>

  <Card title="Status do Flow" icon="diagram-project" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-flow-webhook-examples">
    Processe alterações no status do ciclo de vida do Flow.
  </Card>
</CardGroup>

## Eventos de chamadas e grupos

<CardGroup cols={2}>
  <Card title="Conexão de chamada" icon="phone" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-calling-connect-webhook-examples">
    Processe ofertas e respostas SDP para chamadas do WhatsApp.
  </Card>

  <Card title="Status da chamada" icon="phone-volume" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-calling-status-update-webhook-examples">
    Processe estados de chamada chamando, aceita e rejeitada.
  </Card>

  <Card title="Encerramento de chamada" icon="phone-slash" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-calling-terminate-webhook-examples">
    Processe encerramentos de chamada concluídos e com falha.
  </Card>

  <Card title="Ciclo de vida do grupo" icon="users" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-group-lifecycle-update-webhook-examples">
    Processe a criação e exclusão de grupos.
  </Card>

  <Card title="Participantes do grupo" icon="user-plus" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-group-participants-update-webhook-examples">
    Processe alterações de participantes e solicitações de entrada.
  </Card>

  <Card title="Configurações do grupo" icon="users-gear" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-group-settings-update-webhook-examples">
    Processe alterações de assunto e descrição do grupo.
  </Card>

  <Card title="Status do grupo" icon="circle-exclamation" href="/pt/api-reference/guides/examples/webhook-examples/whatsapp-group-status-update-webhook-examples">
    Processe a suspensão e o restabelecimento do grupo.
  </Card>
</CardGroup>

## Eventos de contato

<CardGroup cols={2}>
  <Card title="Contato criado" icon="user-plus" href="/pt/api-reference/guides/examples/webhook-examples/contact-created-webhook-examples">
    Processe contatos recém-criados.
  </Card>

  <Card title="Contato excluído" icon="user-minus" href="/pt/api-reference/guides/examples/webhook-examples/contact-deleted-webhook-examples">
    Remova ou reconcilie contatos excluídos.
  </Card>

  <Card title="Atributos do contato alterados" icon="pen-to-square" href="/pt/api-reference/guides/examples/webhook-examples/contact-attributes-changed-webhook-examples">
    Processe alterações de perfil, atributos personalizados e tags.
  </Card>

  <Card title="Contato cancelou a inscrição" icon="user-slash" href="/pt/api-reference/guides/examples/webhook-examples/contact-unsubscribe-created-webhook-examples">
    Processe registros de opt-out recém-criados.
  </Card>

  <Card title="Contato reinscreveu-se" icon="user-check" href="/pt/api-reference/guides/examples/webhook-examples/contact-unsubscribe-deleted-webhook-examples">
    Processe registros de opt-out excluídos.
  </Card>
</CardGroup>

<Card title="Abra o catálogo completo de payloads" icon="brackets-curly" href="/pt/api-reference/guides/examples/webhook-examples/webhook-payload-examples">
  Explore todos os tipos de evento e todos os exemplos de payload nomeados da especificação OpenAPI.
</Card>


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