whatsapp.template.category_updated

Use whatsapp.template.category_updated para manipular este evento no seu endpoint de webhook.

Gatilhos

Ocorre quando a categoria de um modelo do WhatsApp é atualizada. Inscreva-se em whatsapp.template.category_updated ao configurar seu endpoint de webhook. Compare previousCategory com category para determinar a alteração de categoria.

Sintaxe

A YCloud envia uma solicitação HTTP POST para a URL de webhook configurada. A estrutura a seguir mostra uma variante de payload. Os valores entre colchetes angulares são marcadores de posição; seus tipos estão listados em Parâmetros. Campos opcionais e outras variantes são descritos abaixo.

{
  "id": "<ID>",
  "type": "whatsapp.template.category_updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappTemplate": {
    "officialTemplateId": "<OFFICIAL_TEMPLATE_ID>",
    "wabaId": "<WABA_ID>",
    "name": "<NAME>",
    "language": "<LANGUAGE>",
    "previousCategory": "<PREVIOUS_CATEGORY>",
    "category": "<CATEGORY>"
  }
}

Parâmetros

Valide o cabeçalho HTTP YCloud-Signature antes de processar o corpo JSON. Consulte a validação de assinatura.

Envelope do evento

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID exclusivo do evento. Tamanho mínimo: `6`. Tamanho máximo: `128`.
`type`	string	Sim	Sempre `whatsapp.template.category_updated`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (date-time)	Sim	O momento em que este evento foi criado, formatado em RFC 3339. Ex.: `2022-06-01T12:00:00.000Z`.

Payload do evento

Parâmetro	Tipo	Obrigatório	Descrição
`whatsappTemplate`	object	Não	Payload `whatsappTemplate` específico do evento.

Os quatro campos comuns do envelope são obrigatórios. Os campos do payload dependem da variante do evento. Em cada tabela de objetos, Obrigatório se aplica quando o objeto pai estiver presente. Campos opcionais podem ser omitidos; um exemplo demonstrativo não torna um campo obrigatório.

whatsappTemplate

Parâmetro	Tipo	Obrigatório	Descrição
`officialTemplateId`	string	Não	ID oficial do modelo atribuído pelo WhatsApp. Esse ID é usado para identificar o modelo no sistema do WhatsApp.
`wabaId`	string	Sim	ID da conta do WhatsApp Business.
`name`	string	Sim	Nome do modelo. Tamanho máximo: `512`. Padrão: `[a-z0-9]{1,512}`.
`language`	string	Sim	Código de idioma do modelo. Consulte Supported Languages para ver todos os códigos.
`category`	string	Não	Categoria dos modelos do WhatsApp. `AUTHENTICATION`: Permite que as empresas autentiquem usuários com códigos de uso único, potencialmente em várias etapas do processo de login (por exemplo, verificação de conta, recuperação de conta, desafios de integridade). `MARKETING`: Inclui promoções ou ofertas, atualizações informativas ou convites para que os clientes respondam/tomem uma ação. Qualquer conversa que não se qualifique como utilidade ou autenticação é uma conversa de marketing. `UTILITY`: Facilita uma solicitação ou transação específica acordada ou fornece atualizações a um cliente sobre uma transação em andamento, incluindo notificações pós-compra e faturas recorrentes.
`previousCategory`	string	Não	Este campo indica a categoria anterior do modelo (ou `null`, para modelos recém-criados após 1º de abril de 2023). Compare este valor com o valor do campo `category` do modelo, que indica a categoria atual do modelo.

Exemplo

O seguinte JSON é o corpo entregue ao seu receptor. IDs, números de telefone e outros valores de conta são ilustrativos.

{
  "id": "evt_example_whatsapp_template_category_updated",
  "type": "whatsapp.template.category_updated",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "whatsappTemplate": {
    "officialTemplateId": "official-template-id",
    "wabaId": "whatsapp-business-account-id",
    "name": "order_update",
    "language": "en_US",
    "previousCategory": "UTILITY",
    "category": "MARKETING"
  }
}

Depois de verificar a assinatura e aceitar o evento de forma duradoura, retorne uma resposta 2xx. Processe tarefas lentas de forma assíncrona.

HTTP/1.1 200 OK

Para conferir explicações passo a passo de cenários, consulte os exemplos anotados.

Primeiros passos

Guias

Endpoints

Webhook reference

whatsapp.template.category_updated

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

whatsappTemplate

Exemplo

​Gatilhos

​Sintaxe

​Parâmetros

​Envelope do evento

​Payload do evento

​whatsappTemplate

​Exemplo

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

whatsappTemplate

Exemplo