Configuração: POST /whatsapp/config/ com o campo url_report_webhook
Webhook automático enviado quando relatórios são processados. O webhook inclui a URL direta para download do arquivo com token temporário (válido por 24h).
Evento Descrição report.readyRelatório processado com sucesso e pronto para download. report.errorErro no processamento do relatório.
Tipo Descrição licensesRelatório de licenças numbersRelatório de números templatesRelatório de templates official-messagesRelatório de mensagens oficiais attendance-historyHistórico de atendimento attendance-statisticsEstatísticas de atendimento tickets-summaryResumo de tickets ticket-detailDetalhe de ticket
Campo Tipo Descrição event_idstring (uuid) Identificador único do evento (UUID v4). eventstring "report.ready"report_idinteger ID único do relatório. report_typestring Tipo do relatório gerado. report_namestring Nome do arquivo do relatório. statusstring "ready"file_urlstring URL para download do arquivo. company_idinteger ID da empresa que solicitou. created_atstring (date-time) Data e hora de criação.
JSON
{
"event_id": "g20eff00-pd9m-d2o5-l827-ff7766ff1111",
"event": "report.ready",
"report_id": 123,
"report_type": "official-messages",
"report_name": "mensagens_01072025-31072025_17_09_2025_14_30_45_abc",
"status": "ready",
"file_url": "/reports/123/download/",
"company_id": 26,
"created_at": "2025-09-17T16:10:11.138957Z"
}Campo Tipo Descrição event_idstring (uuid) Identificador único do evento (UUID v4). eventstring "report.error"report_idinteger ID único do relatório. report_typestring Tipo do relatório que falhou. report_namestring Nome do arquivo do relatório. statusstring "error"error_messagestring Mensagem descritiva do erro. company_idinteger ID da empresa que solicitou. created_atstring (date-time) Data e hora de criação.
JSON
{
"event_id": "h30f0g10-qe0n-e3p6-m938-gg8877gg2222",
"event": "report.error",
"report_id": 123,
"report_type": "official-messages",
"report_name": "mensagens_01072025-31072025_17_09_2025_14_30_45_abc",
"status": "error",
"error_message": "Connection timeout to database",
"company_id": 26,
"created_at": "2025-09-17T16:10:11.138957Z"
}Webhook automático enviado quando relatórios são processados. É enviado para a URL configurada em url_report_webhook através do endpoint POST /whatsapp/config/.
Configure a URL do webhook via POST /whatsapp/config/ com o campo url_report_webhook
Quando um relatório for criado via qualquer endpoint de /reports/, você receberá uma notificação
O webhook inclui a URL direta para download do arquivo com token temporário (válido por 24h)
Evento Descrição report.readyRelatório processado com sucesso e pronto para download. report.errorErro no processamento do relatório.
Tipo Descrição licensesRelatório de licenças numbersRelatório de números templatesRelatório de templates official-messagesRelatório de mensagens oficiais attendance-historyHistórico de atendimento attendance-statisticsEstatísticas de atendimento tickets-summaryResumo de tickets ticket-detailDetalhe de ticket
Campo Tipo Descrição event_idstring (uuid) Identificador único do evento (UUID v4). eventstring "report.ready"report_idinteger ID único do relatório. report_typestring Tipo do relatório gerado. report_namestring Nome do arquivo do relatório. statusstring "ready"file_urlstring URL para download do arquivo. company_idinteger ID da empresa que solicitou. created_atstring (date-time) Data e hora de criação.
JSON
{
"event_id": "g20eff00-pd9m-d2o5-l827-ff7766ff1111",
"event": "report.ready",
"report_id": 123,
"report_type": "official-messages",
"report_name": "mensagens_01072025-31072025_17_09_2025_14_30_45_abc",
"status": "ready",
"file_url": "/reports/123/download/",
"company_id": 26,
"created_at": "2025-09-17T16:10:11.138957Z"
}Campo Tipo Descrição event_idstring (uuid) Identificador único do evento (UUID v4). eventstring "report.error"report_idinteger ID único do relatório. report_typestring Tipo do relatório que falhou. report_namestring Nome do arquivo do relatório. statusstring "error"error_messagestring Mensagem descritiva do erro. company_idinteger ID da empresa que solicitou. created_atstring (date-time) Data e hora de criação.
JSON
{
"event_id": "h30f0g10-qe0n-e3p6-m938-gg8877gg2222",
"event": "report.error",
"report_id": 123,
"report_type": "official-messages",
"report_name": "mensagens_01072025-31072025_17_09_2025_14_30_45_abc",
"status": "error",
"error_message": "Connection timeout to database",
"company_id": 26,
"created_at": "2025-09-17T16:10:11.138957Z"
} 