Eventos · Colaboração
announcement.read
Comunicado lido
Um destinatário confirmou a leitura de um comunicado de leitura obrigatória.
- Tipo de objeto
- announcement
- Entregue a
- Webhooks que podem ver o objeto: pela função, pelo perfil de dados e pelas coleções
Payload
idstringobrigatórioID do evento (
evt_…), também enviado como cabeçalhowebhook-id. Use-o para descartar entregas duplicadas.typestringobrigatórioValores permitidos:
announcement.readcreated_atstring (date-time)obrigatórioQuando a alteração aconteceu (UTC).
org_idintegerobrigatórioapi_versionstringobrigatórioVersão do contrato do esquema
data.sequenceintegerNúmero de sequência da entrega dentro do webhook (ausente em um evento de teste).
payloadstringobrigatóriothinsignifica semdata: leia o objeto pela API.Valores permitidos:
fullthindataobjectCampos
user_idintegerobrigatórioQuem confirmou a leitura.
testbooleanobrigatórioUm evento de teste enviado por
POST /v1/webhooks/{webhook_id}/test.
Exemplo de entrega
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "announcement.read",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "announcement",
"id": "12"
},
"payload": "full",
"data": {
"announcement": {
"id": 12,
"card_id": "c_9f2e41"
},
"user_id": 11
},
"test": false
}Recebimento de eventos
Cada entrega é uma requisição POST com este corpo JSON para a URL do seu webhook. Verifique o cabeçalho webhook-signature (Standard Webhooks) antes de confiar no corpo, responda com um status 2xx em poucos segundos e faça o processamento depois. As entregas a um mesmo webhook mantêm a ordem dos eventos; uma entrega com falha é tentada de novo, com pausas cada vez maiores.
Novos tipos de evento e novos campos podem aparecer a qualquer momento: ignore os tipos e campos que você não conhece.