Exemplos de Webhook de atualização de configurações de grupo do WhatsApp

Para o catálogo completo derivado do schema, consulte todos os exemplos.

O que é

Trate atualizações de assunto e descrição de grupos do WhatsApp.

Antes de começar

Crie um endpoint público HTTPS em sua aplicação.
Configure um endpoint de webhook da YCloud para os tipos de evento necessários.
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 duradoura, retorne uma resposta 2xx e processe tarefas lentas de forma assíncrona.

Requisição

Os cenários abaixo mostram requisições entregues à 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.

HTTP/1.1 200 OK

Para configuração de endpoint, validação de assinatura e comportamento de novas tentativas, consulte Configurar webhooks.

Configurações atualizadas

Quando as configurações de grupo do WhatsApp forem atualizadas com sucesso, você receberá um webhook com a seguinte estrutura de payload:

Requisição

{
  "id": "evt_group_settings_123",
  "type": "whatsapp.group.settings_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "wabaId": "123456789012345",
    "field": "group_settings_update",
    "type": "group_settings_update",
    "requestId": "REQ_2",
    "status": "updated",
    "groupId": "Y2FwaV9ncm91cDpFWEFNUExFX0dST1VQX0lE",
    "subject": "Updated Purchase Inquiry",
    "description": "Updated group description.",
    "settings": [
      {
        "name": "group_subject",
        "text": "Updated Purchase Inquiry",
        "updateSuccessful": true
      },
      {
        "name": "group_description",
        "text": "Updated group description.",
        "updateSuccessful": true
      }
    ],
    "webhookTime": "2026-05-13T00:00:00.000Z"
  }
}

Resposta

Confirme o recebimento da entrega após aceitar o evento de forma duradoura.

HTTP/1.1 200 OK

Explicação

Roteie o evento por type, remova duplicatas por id e transfira tarefas lentas ou propensas a falhas para um processador assíncrono.

Falha na atualização de configurações

Quando uma atualização de configurações de grupo do WhatsApp falhar ou falhar parcialmente, você receberá um webhook com a seguinte estrutura de payload:

Requisição

{
  "id": "evt_group_settings_124",
  "type": "whatsapp.group.settings_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "wabaId": "123456789012345",
    "field": "group_settings_update",
    "type": "group_settings_update",
    "requestId": "REQ_SETTINGS",
    "status": "failed",
    "groupId": "Y2FwaV9ncm91cDpFWEFNUExFX0dST1VQX0lE",
    "subject": "New subject",
    "settings": [
      {
        "name": "group_subject",
        "text": "New subject",
        "updateSuccessful": false,
        "errors": [
          {
            "code": 131201,
            "title": "Invalid group subject"
          }
        ]
      }
    ],
    "webhookTime": "2026-05-13T00:00:00.000Z"
  }
}

Resposta

Confirme o recebimento da entrega após aceitar o evento de forma duradoura.

HTTP/1.1 200 OK

Explicação

type: Sempre whatsapp.group.settings_update para eventos de configurações de grupo
whatsappGroup: Contém os detalhes do resultado da atualização das configurações do grupo
- field: Sempre group_settings_update
- type: Sempre group_settings_update
- requestId: O ID da requisição retornado pela operação assíncrona da API de configurações de grupo
- status: O status normalizado da atualização das configurações, seja updated ou failed
- groupId: O ID do grupo do WhatsApp
- subject e description: As configurações de texto do grupo, quando presentes
- settings: Resultados da atualização por configuração. name pode ser profile_picture, group_subject ou group_description
- settings[].updateSuccessful: Indica se a atualização da configuração individual foi bem-sucedida
- settings[].errors: Erros retornados pelo WhatsApp para a configuração individual

Primeiros passos

Guias

Endpoints

Webhooks

Exemplos de Webhook de atualização de configurações de grupo do WhatsApp

O que é

Antes de começar

Como funciona

Requisição

Resposta

Configurações atualizadas

Requisição

Resposta

Explicação

Falha na atualização de configurações

Requisição

Resposta

Explicação

​O que é

​Antes de começar

​Como funciona

​Requisição

​Resposta

​Configurações atualizadas

​Requisição

​Resposta

​Explicação

​Falha na atualização de configurações

​Requisição

​Resposta

​Explicação

O que é

Antes de começar

Como funciona

Requisição

Resposta

Configurações atualizadas

Requisição

Resposta

Explicação

Falha na atualização de configurações

Requisição

Resposta

Explicação