get
https://app.plugsign.com.br/api/webhooks
Com este endpoint, você pode listar todos os webhooks previamente cadastrados por sua empresa no sistema.
É possível filtrar os resultados utilizando os query params 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_OPENED: Indica que a solicitação foi aberta pelo destinatário.
- REQUESTS_UPDATED: Indica uma atualização na solicitação, como assinatura, recusa ou cancelamento. Em solicitações de lote, o payload inclui
lote_id. - REQUESTS_CHAIN_UPDATED: Indica uma atualização na cadeia de solicitações, incluindo o avanço para o próximo signatário ou sua conclusão.
- FILE_UPLOADED: Indica que o upload de um documento foi realizado com sucesso na plataforma.
- FILE_DUPLICATED: Indica que um documento foi duplicado na plataforma.
- FILE_GENERATED_WITH_AI: Indica que um documento foi gerado via IA na plataforma.
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.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
- Exemplos de Webhooks
- Exemplos de Webhooks
Exemplos de Webhooks de Documentos
Quando um documento é duplicado
Webhook enviado ao cliente:
{
"data": {
"document_key": "66VChbX9ft6G8lmtCus4CxRhcmyrIYRM826j",
"file_name": "SamplePdf",
"folder": "12",
"extension": "pdf",
"user_email": "[email protected]"
},
"webhook_type": "FILE_DUPLICATED",
"company_id": 99999999999
}Quando um documento é gerado via IA
Webhook enviado ao cliente:
{
"data": {
"document_key": "34V5hdX9ftvG8lmtsds4dx3hcmyrIYRvd235",
"file_name": "SamplePdf",
"folder": "12",
"extension": "pdf",
"user_email": "[email protected]"
},
"webhook_type": "FILE_GENERATED_WITH_AI",
"company_id": 99999999999
}Quando o upload de um documento é concluído
Webhook enviado ao cliente:
{
"document_key": "7Wcy2rqJa1es2W9BCRkuvh5vdk64",
"file_name": "SamplePdf",
"folder": "323245576764",
"extension": "pdf",
"user_email": "[email protected]",
"webhook_type": "FILE_UPLOADED",
"company_id": 43432333321
}Exemplos de Webhooks de Solicitações (Requests)
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 a abertura do documento atualiza a solicitação
Webhook enviado ao cliente:
{
"document_key": "66VChbX9ft6G8lmtCus4CxRhcmyrIYRM826j",
"signing_key": "FgKfECkLhzXuiz8MgTXQ70Ykkk9Z2BeEjaDW",
"status": "Open",
"data": {
"file_name": "SamplePdf",
"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",
"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
}Quando o documento é aberto
Webhook enviado ao cliente:
{
"document_key": "66VChbX9ft6G8lmtCus4CxRhcmyrIYRM826j",
"signing_key": "FgKfECkLhzXuiz8MgTXQ70Ykkk9Z2BeEjaDW",
"status": "Open",
"data": {
"file_name": "SamplePdf",
"date": "2024-10-24 15:33:02"
},
"webhook_type": "REQUESTS_OPENED",
"company_id": 99999999999
}Exemplos de Webhooks de Solicitações em Lote
As solicitações em lote utilizam os tipos de webhook de solicitações. O identificador do lote é enviado no campo lote_id.
Quando uma solicitação do lote é assinada
Webhook enviado ao cliente:
{
"lote_id": 99999999999,
"signing_key": "FgKfECkLhzXuiz8MgTXQ70Ykkk9Z2BeEjaDW",
"status": "Signed",
"data": {
"lote_name": "Lote de contratos",
"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 uma solicitação do lote é cancelada
Webhook enviado ao cliente:
{
"lote_id": 99999999999,
"signing_key": "FgKfECkLhzXuiz8MgTXQ70Ykkk9Z2BeEjaDW",
"status": "Cancelled",
"data": {
"lote_name": "Lote de contratos",
"reciever": "[email protected]",
"date": "2024-10-24 15:33:02",
"user": "[email protected]"
},
"webhook_type": "REQUESTS_UPDATED",
"company_id": 99999999999
}Quando a cadeia do lote avança para o próximo destinatário
Webhook enviado ao cliente:
{
"lote_id": 99999999999,
"signing_key": "AbCdECkLhzXuiz8MgTXQ70Ykkk9Z2BeEjaXY",
"status": "Next",
"data": {
"file_name": "Lote de contratos",
"reciever": "[email protected]",
"date": "2024-10-24 15:33:12"
},
"webhook_type": "REQUESTS_CHAIN_UPDATED",
"company_id": 99999999999
}