GET All 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_OPENED: Indica que o documento foi aberto pelo destinatário.
• REQUESTS_UPDATED: Indica que houve alguma ação no documento como aberto, assinado, recusado ou cancelado.
• REQUESTS_CHAIN_UPDATED: Indica que o documento em cadeia de solicitações foi concluído.
• LOTE_REQUEST_EMAIL_OPENED: Indica que o e-mail de um lote foi aberto pelo destinatário.
• LOTE_REQUEST_OPENED: Indica que o documento de um lote foi aberto pelo destinatário.
• LOTE_REQUEST_UPDATED: Indica que houve alguma ação em um documento de lote como aberto, assinado, recusado ou cancelado.
• LOTE_REQUEST_CHAIN_UPDATED: Indica que o documento em cadeia de um lote foi concluído.
• FILE_UPLOADED: Indica que um upload de 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.

---

{
  "data": [
    {
      "id": 7,
      "url": "https://webhook.site/4b782c19-e867-4b93-9a2d-7cade71d95a7",
      "type": "REQUESTS_UPDATED",
      "status": 1
    }
  ]
}