get https://app.plugsign.com.br/api/webhooks
Com este endpoint, você pode listar todos os webhooks que foram previamente cadastrados por sua empresa no sistema.
É possível filtrar os resultados utilizando os query params disponíveis listados abaixo.
Webhooks - Tipos e Status
1. Tipos de Webhooks
Aqui estão os diferentes tipos de webhooks utilizados:
- REQUESTS_EMAIL_OPENED: Indica que o e-mail foi aberto pelo destinatário.
- REQUESTS_UPDATED: Indica que houve alguma ação no documento como assinado, recusado ou cancelado.
- REQUESTS_CHAIN_UPDATED: Indica que o documento em cadeia de solicitações foi concluído.
2. Status dos Documentos
Os status dos documentos indicam a etapa em que o processo se encontra:
- Open: O documento ou e-mail foi aberto.
- Signed: O documento foi assinado com sucesso.
- Declined: O documento foi recusado pelo destinatário, possivelmente com uma justificativa.
3. Exemplos de Webhooks
Quando o e-mail é aberto
Webhook enviado ao cliente:
{ "document_key": "66VChbX9ft6G8lmtCus4CxRhcmyrIYRM826j", "signing_key": "FgKfECkLhzXuiz8MgTXQ70Ykkk9Z2BeEjaDW", "status": "Open", "data": { "file_name": "nome-do-arquivo", "reciever": "[email protected]", "date": "2024-10-24 15:33:02", "user": "[email protected]" }, "webhook_type": "REQUESTS_EMAIL_OPENED", "company_id": 99999999999 }Quando o documento é aberto
Webhook enviado ao cliente:
{ "document_key": "66VChbX9ft6G8lmtCus4CxRhcmyrIYRM826j", "signing_key": "FgKfECkLhzXuiz8MgTXQ70Ykkk9Z2BeEjaDW", "status": "Open", "data": { "file_name": "SamplePdf (171)", "date": "2024-10-24 15:33:02" }, "webhook_type": "REQUESTS_UPDATED", "company_id": 99999999999 } Quando o documento é assinado
Webhook enviado ao cliente:
{ "document_key": "66VChbX9ft6G8lmtCus4CxRhcmyrIYRM826j", "signing_key": "FgKfECkLhzXuiz8MgTXQ70Ykkk9Z2BeEjaDW", "status": "Signed", "data": { "file_name": "SamplePdf (171)", "reciever": "[email protected]", "date": "2024-10-24 15:33:02" }, "location": { "localizacao": "0", "latitude": "0", "longitude": "0" }, "webhook_type": "REQUESTS_UPDATED", "company_id": 99999999999 }Quando a cadeia de solicitações é finalizada
Webhook enviado ao cliente:
{ "document_key": "66VChbX9ft6G8lmtCus4CxRhcmyrIYRM826j", "signing_key": "FgKfECkLhzXuiz8MgTXQ70Ykkk9Z2BeEjaDW", "status": "Signed", "data": { "file_name": "SamplePdf (171)", "reciever": "[email protected]", "date": "2024-10-24 15:33:02" }, "location": { "localizacao": "0", "latitude": "0", "longitude": "0" }, "webhook_type": "REQUESTS_CHAIN_UPDATED", "company_id": 99999999999 }Quando o documento é recusado
Webhook enviado ao cliente:
{ "document_key": "66VChbX9ft6G8lmtCus4CxRhcmyrIYRM826j", "signing_key": "FgKfECkLhzXuiz8MgTXQ70Ykkk9Z2BeEjaDW", "status": "Declined", "data": { "file_name": "tes1sa", "reciever": "[email protected]", "date": "2024-10-24 15:33:02", "reason": "com a justificativa: 'Nome errado'" }, "webhook_type": "REQUESTS_UPDATED", "company_id": 99999999999 }