Eventos
info
Os eventos são enviados via Webhooks. Clique aqui para saber mais sobre como receber eventos.
Evento: validation.status.pending
Evento emitido quando uma validação foi criada mas não concluída.
Corpo do Evento
{
"eventId": "dca749e9-e60e-490e-936a-64fbc6eb67f9",
"eventName": "validation.status.signed",
"attributes": {
"businessId": "732-946-773",
"name": "Cliente_2023_841_943",
"type": "document",
"flowType": "web",
"status": "pending",
"webValidationUrl": "https://...."
}
}
Descrição dos Campos
| Campo | Descrição |
|---|---|
| eventId | Identificador único do evento, no formato UUID. |
| eventName | Nome do evento, indicando a ação realizada, por exemplo, "document.status.signed". |
| attributes.businessId | Identificador de negócios da validação, como um código ou número de referência |
| attributes.name | Nome da validação. |
| attributes.type | Tipo da validação |
| attributes.flowType | Tipo de fluxo para a validação |
| attributes.status | Status da validação. |
| attributes.webValidationUrl | URL do serviço externo de validação |
Evento: validation.status.succeeded
Evento emitido quando uma validação foi criada e concluída.
Corpo do Evento
{
"eventId": "dca749e9-e60e-490e-936a-64fbc6eb67f9",
"eventName": "validation.status.succeeded",
"attributes": {
"businessId": "732-946-773",
"name": "Cliente_2023_841_943",
"type": "document",
"flowType": "web",
"status": "succeeded",
"webValidationUrl": "https://...."
}
}
Descrição dos Campos
| Campo | Descrição |
|---|---|
| eventId | Identificador único do evento, no formato UUID. |
| eventName | Nome do evento, indicando a ação realizada, por exemplo, "document.status.signed". |
| attributes.businessId | Identificador de negócios da validação, como um código ou número de referência |
| attributes.name | Nome da validação. |
| attributes.type | Tipo da validação |
| attributes.flowType | Tipo de fluxo para a validação |
| attributes.status | Status da validação. |
| attributes.webValidationUrl | URL do serviço externo de validação |
Evento: validation.status.failed
Evento emitido quando uma validação não foi bem sucedida.
Corpo do Evento
{
"eventId": "dca749e9-e60e-490e-936a-64fbc6eb67f9",
"eventName": "validation.status.failed",
"attributes": {
"businessId": "732-946-773",
"name": "Cliente_2023_841_943",
"type": "document",
"flowType": "web",
"status": "failed",
"webValidationUrl": "https://...."
}
}
Descrição dos Campos
| Campo | Descrição |
|---|---|
| eventId | Identificador único do evento, no formato UUID. |
| eventName | Nome do evento, indicando a ação realizada, por exemplo, "document.status.signed". |
| attributes.businessId | Identificador de negócios da validação, como um código ou número de referência |
| attributes.name | Nome da validação. |
| attributes.type | Tipo da validação |
| attributes.flowType | Tipo de fluxo para a validação |
| attributes.status | Status da validação. |
| attributes.webValidationUrl | URL do serviço externo de validação |