Definição de etiquetas

Evento: labels · Transporte: POST para o seu receptor

Acompanhe criação, renomeação, cor e exclusão de etiquetas.

Etiqueta versus associação

labels descreve a definição da etiqueta. Para saber quais etiquetas estão associadas a um chat, use chat_labels. Sincronizações completas de etiquetas também podem chegar em lotes de history.

Use event.LabelID para correlacionar a etiqueta. Em event.Action, deleted indica exclusão quando fornecido; nome e cor podem variar conforme a ação recebida.

Habilitar este evento

Adicione labels à lista events do webhook da instância. Preserve os outros eventos de que sua integração precisa.

{
  "enabled": true,
  "url": "https://seu-sistema.example/hooks/whatsapp",
  "events": [
    "labels"
  ]
}

Envie essa configuração para POST /webhook, usando o header token. O JSON acima configura a assinatura; os exemplos de entrega abaixo são o que seu servidor recebe.

Campos do payload

O envelope comum vem na raiz. Campos condicionais podem estar ausentes ou nulos conforme o evento; não use a tabela como obrigação de presença de todos os campos.

Campo	Tipo	Significado
`EventType`	string	Obrigatório. Tipo de evento, por exemplo connection ou messages.
`owner`	string	Obrigatório. Consulte o objeto ou exemplo correspondente.
`token`	string	Obrigatório. Token da instância; dado sensível.
`BaseUrl`	string	Obrigatório. Consulte o objeto ou exemplo correspondente.
`instanceName`	string	Consulte o objeto ou exemplo correspondente.
`type`	string	O evento de edição usa LabelEdit.
`event`	object	Atualização da etiqueta.
`event.LabelID`	string	ID da etiqueta.
`event.Timestamp`	string	Data/hora da atualização.
`event.FromFullSync`	boolean	Origem de full sync quando presente.
`event.Action`	object	Alterações recebidas.
`event.Action.name`	string	Nome da etiqueta.
`event.Action.color`	integer	Código de cor.
`event.Action.deleted`	boolean	Indica exclusão da etiqueta.

Exemplos de entrega

Exemplos ilustrativos com identificadores fictícios. O conteúdo específico e os campos opcionais variam.

Etiqueta criada ou renomeada

{
  "EventType": "labels",
  "owner": "5511999999999",
  "token": "INSTANCE_TOKEN",
  "BaseUrl": "https://seu-servidor.example",
  "instanceName": "Atendimento",
  "type": "LabelEdit",
  "event": {
    "LabelID": "31",
    "Timestamp": "2026-09-08T12:00:00Z",
    "FromFullSync": false,
    "Action": {
      "name": "Suporte",
      "color": 1,
      "deleted": false
    }
  }
}

Responder ao webhook

Seu receptor deve aceitar o POST JSON e devolver uma resposta 2xx rapidamente, após validar e registrar o recebimento. O corpo da resposta não é um comando para a API. Processe trabalho demorado separadamente.

O worker não repete automaticamente uma entrega HTTP malsucedida. Consulte diagnóstico de webhooks e implemente a reconciliação necessária. Eventos repetidos ou fora de ordem ainda precisam ser tolerados pelo receptor.