GET All 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.
get/api/webhooks
Request
- Base URLhttps://app.plugsign.com.br
- URLhttps://app.plugsign.com.br/api/webhooks
- AuthAPI key in header Authorization
Query parameters
type'REQUESTS_EMAIL_OPENED' | 'REQUESTS_UPDATED' | 'REQUESTS_CHAIN_UPDATED' | 'REQUESTS_OPENED' | 'FILE_UPLOADED' | 'FILE_DUPLICATED' | 'FILE_GENERATED_WITH_AI' | 'LOTE_REQUEST_UPDATED' | 'LOTE_REQUEST_CHAIN_UPDATED' | 'LOTE_REQUEST_OPENED' | 'LOTE_REQUEST_EMAIL_OPENED'
Tipo do webhook. Valores fora da lista apenas retornam uma lista vazia.
statusinteger
Status de atividade do webhook: 1 para ativo e 0 para inativo. Valores fora de 1/0 retornam uma lista vazia.
Response
200
Example response
{
"data": [
{
"id": 7,
"url": "https://webhook.site/4b782c19-e867-4b93-9a2d-7cade71d95a7",
"type": "REQUESTS_UPDATED",
"status": 1
}
]
}Changes
No recorded changes to this operation across all 2 revisions of this API.