Pular para o conteúdo principal

Acompanhar documentos

Depois de criar um documento, você acompanha o andamento dele de duas formas: consultando o status ativamente (polling) ou recebendo notificações por webhook quando algo acontece. Também é possível enviar lembretes aos participantes que ainda não agiram.

Verificar o status de um documento​

Para verificar o status de um documento é preciso conhecer o seu ID. Em seguida, faça uma chamada à API de Detalhes do Documento:

GET /api/documents/b12cb1b2-5d6e-40b2-a050-097d068c4c11

{
"id": "b12cb1b2-5d6e-40b2-a050-097d068c4c11",
"name": "Contrato Integração",
"status": "Concluded",
"creationDate": "2019-08-18T16:26:03.372Z",
"updateDate": "2019-08-18T16:26:03.372Z",
...
"flowActions": [
{
"id": "4bf61c68-eaf1-455f-b4a1-6141554f1dae",
"type": "Signer",
"status": "Completed",
"step": 1,
...
"user":
{
"id": "4d961566-9b03-450c-b144-930e0294bac2",
"name": "John Wick",
"identifier": "81976153069",
"email": "john.wick@mailinator.com"
},
"title": "Parte",
"allowElectronicSignature": true
}
]
}
  • Para saber se o documento está concluído, verifique se a propriedade status corresponde a Concluded.
  • Para saber se um participante assinou/aprovou, verifique se a propriedade status corresponde a Completed no elemento correspondente da lista flowActions.

Status do documento​

A propriedade status do documento pode assumir os seguintes valores:

StatusSignificado
PendingAguardando ações dos participantes
PausedFluxo pausado: ninguém consegue assinar, aprovar nem recusar até o documento ser retomado. Não é um status final. Trate-o como Pending. Veja Pausar e retomar um documento. Disponível a partir da versão 3.0.0.
FlowConcludedTodas as ações do fluxo foram concluídas (processamento final em andamento)
ConcludedDocumento concluído
RefusedDocumento recusado por um participante
CanceledDocumento cancelado
ExpiredDocumento expirado

O enum DocumentStatus das bibliotecas cliente não tem Paused, e o GetDocumentDetailsAsync do .NET falha em um documento pausado. Se você pausa documentos, leia-os como mostra Recursos mais novos que as bibliotecas cliente.

Status da ação do participante​

Cada item de flowActions tem seu próprio status:

StatusSignificado
CreatedAção criada, ainda não liberada para o participante (aguardando etapa anterior)
PendingAguardando a ação do participante
CompletedParticipante concluiu a ação (assinou/aprovou)
RefusedParticipante recusou

Exemplos no GitHub: C# · Java · PHP · Node.js

Enviar lembretes de assinatura​

Uma vez verificado o status de um participante, você pode enviar lembretes periódicos aos participantes que ainda não completaram uma ação, usando a API de Envio de Lembretes. Informe o ID do documento e o ID da ação do participante (flowActionId):

POST /api/notifications/flow-action-reminder

{
"documentId": "b12cb1b2-5d6e-40b2-a050-097d068c4c11",
"flowActionId": "4bf61c68-eaf1-455f-b4a1-6141554f1dae"
}

Exemplos no GitHub: C# · Java · PHP · Node.js

Webhooks​

Em vez de consultar o status repetidamente, você pode configurar um Webhook que será disparado toda vez que um documento da sua organização for concluído, aprovado, recusado ou assinado. Para isso, acesse a tela da Organização e registre a URL desejada na opção Integração:

Seção Integração da tela de Organizações, com um novo webhook sendo cadastrado

Veja Webhooks para a lista completa de eventos, o formato do payload de cada um e o comportamento de entrega (autenticação, retentativas e ordem).

Próximos passos​

Quando o documento estiver concluído, veja como baixar e listar documentos.

Ver em Markdown