O serviço Webhook de geração de documentos (DocGen) é responsável por enviar a um determinado endpoint todos os eventos que ocorreram na geração de um documento.
Segurança
O endpoint deve ser uma URL pública que responda às requisições HTTP/HTTPS.
Também é importante que a URL não esteja num contexto de VPN.
Esse endpoint pode ser autenticado por meio de headers customizados ou receber autorização do tipo basic (user e password).
Envios ao Endpoint
O envio ocorre no momento que os eventos são processados pela plataforma. Trata-se de uma requisição HTTP/HTTPS utilizando o método POST. O conteúdo pode ser um JSON ou XML contendo um ou mais eventos.
O Enums armazena o seguinte conjunto de valores:
- EventType: Representa o tipo do evento criado.
- Origin: Origem de geração do documento.
- Exporter: É a ferramenta responsável pela geração do documento.
Tipos de Eventos
Evento |
Descrição |
| Processed | Criado a partir do recebimento de uma requisição com payload válido. |
| Created | Criado com base no sucesso da geração de um documento. |
| Dropped | Criado com base na falha ocorrida durante a geração de um documento. |
Origem da geração de documento
Origem |
Descrição |
| Standalone | Criado por uma requisição direta na API geração de documentos. |
| Journey | Gerado no fluxo de processamento de uma comunicação (Jornada). |
Exporter
Ferramenta |
Descrição |
| DocGen | Motor de geração de PDFs. |
Descrição dos campos
Modelo de outbound Standalone
Nome do campo |
Descrição |
|
|
Identificador para rastreamento do evento |
|
|
Identificador do evento |
|
|
Tipo do evento |
|
|
Indica a origem de geração do evento |
|
|
Data da geração do evento |
|
|
Data da solicitação para geração de documentos |
|
|
Identificador da máscara do documento |
|
|
Identificador do gerador do documento |
|
|
Nome da máscara do documento |
|
|
Nome do documento gerado |
|
|
Indicador de senha para proteção do documento |
correlationId |
Identificador do documento |
properties |
Propriedades customizadas informadas na requisição da geração dos documentos |
tenantId |
Identificador do tenant |
link |
Link do documento gerado (apenas quando o tipo do evento for Created) |
detail |
Detalhe da falha ocorrida durante a geração do documento (apenas quando o tipo do evento for Dropped) |
Exemplo de retorno em JSON - outbound Standalone
{
“trackingId” : “a1b2c3d4e5”,
"eventId": "69D994D67AF608ECB10AC5F69C4BA79F",
"type": "Created",
"origin": "Journey",
"eventDate": "2023-07-05T21:29:04.4741997Z",
"requestDate": "2023-07-04T19:26:37.18Z",
"maskId": "tenant_report1",
"exporter": "DocGen",
"maskName": "REPORT_1.frx",
"fileName": "documento_pdf",
"isProtected": false,
"correlationId": "123456",
"properties": {},
"tenantId": "62e0467902c8fb3ba0d32af3",
"link": "https://link-download-documento/documento_pdf.pdf"
}
Modelo de outbound Journey
Nome do campo |
Descrição |
trackingId |
Identificador para rastreamento do evento |
journeyId |
Identificador da jornada |
journeyVersion |
Versão da jornada |
journeyName |
Nome da jornada |
nodeKey |
Identificador do nó de geração de documentos |
customerId |
Identificador do customer |
movementDate |
Data de movimento |
movementFileName |
Arquivo do movimento |
movementLot |
Lote do movimento |
dueDate |
Data de vencimento do documento |
documentNumber |
Número do documento |
digitableLine |
Linha digitável do documento |
description |
Descrição do documento |
total |
Total do documento |
isTest |
Indica se a comunicação enviada estava em modo teste |
eventId |
Identificador do evento |
type |
Tipo do evento |
origin |
Indica a origem de geração do evento |
eventDate |
Data da geração do evento |
requestDate |
Data da solicitação para geração de documentos |
maskId |
Identificador da máscara do documento |
exporter |
Identificador do gerador do documento |
maskName |
Nome da máscara do documento |
fileName |
Nome do documento gerado |
isProtected |
Indicador de senha para proteção do documento |
correlationId |
Identificador do documento |
properties |
Propriedades customizadas informadas na requisição da geração dos documentos |
tenantId |
Identificador do tenant |
link |
Link do documento gerado (apenas quando o tipo do evento for Created) |
detail |
Detalhe da falha ocorrida durante a geração do documento (apenas quando o tipo do evento for Dropped) |
Exemplo de retorno em JSON - outbound Journey
{
“trackingId” : “a1b2c3d4e5”,
"journeyId": "abcdef123456",
"journeyVersion": "123456abcdef",
"journeyName": "ondemand-journey",
"nodeKey": "abc-123-cde-456",
"customerId": "00000000001",
"movementDate": "2023-06-16T03:00:00Z",
"dueDate": "2023-06-16T03:00:00Z",
"movementFileName": "pdf-data.txt",
"movementLot": "00001",
"documentNumber": "100",
"digitableLine": "123456",
"description": "Fatura",
"total": "100",
"isTest": false,
"eventId": "69D994D67AF608ECB10AC5F69C4BA79F",
"type": "Created",
"origin": "Journey",
"eventDate": "2023-07-05T21:29:04.4741997Z",
"requestDate": "2023-07-04T19:26:37.18Z",
"maskId": "tenant_report1",
"exporter": "DocGen",
"maskName": "REPORT_1.frx",
"fileName": "documento_pdf",
"isProtected": false,
"correlationId": "123456",
"properties": {},
"tenantId": "62e0467902c8fb3ba0d32af3",
"link": "https://link-download-documento/documento_pdf.pdf"
}