Eventos · Jobs e exportações
export.ready
Exportação pronta
Um arquivo de exportação está pronto para download: uma exportação de cartão, uma exportação da organização ou um arquivo gerado de novo.
- Tipo de objeto
- file
- Entregue a
- Webhooks com a função admin
Payload
idstringobrigatórioID do evento (
evt_…), também enviado como cabeçalhowebhook-id. Use-o para descartar entregas duplicadas.typestringobrigatórioValores permitidos:
export.readycreated_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
kindstringobrigatórioO que foi exportado:
cards,answer,card,report,org…job_idinteger | nullO job de indexação ou de exportação.
actor_idinteger | nullobrigatórioO usuário que realizou a ação;
nullpara uma chave de API da organização ou a própria plataforma.regeneratedbooleanO arquivo foi gerado de novo (
POST /v1/files/{file_id}/regenerate).
testbooleanobrigatórioUm evento de teste enviado por
POST /v1/webhooks/{webhook_id}/test.
Exemplo de entrega
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "export.ready",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "file",
"id": "f2b1c0de-0000-4000-8000-000000000001"
},
"payload": "full",
"data": {
"file": {
"id": "f2b1c0de-0000-4000-8000-000000000001",
"filename": "cards.xlsx",
"format": "xlsx",
"size": 18234,
"expires_at": "2026-10-31T10:00:00Z"
},
"kind": "cards",
"job_id": null,
"actor_id": 7
},
"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.