---
title: "GET All Webhooks"
method: GET
path: "/api/webhooks"
---

# GET All Webhooks

`GET /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\_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.

* * *

## 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'
- `status` integer

## Response `200`

200

- object
  - `data` object[] — Lista de webhooks cadastrados.
    - `id` integer — Identificador único do webhook.
    - `url` string — URL de destino para onde as notificações do webhook serão enviadas.
    - `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 evento que dispara o webhook.
    - `status` integer — Status de atividade do webhook. 1 = ativo, 0 = inativo.

---

[API](https://skmtc.net/plugsign/apis/endpoints-manuais.md) · [All operations](https://skmtc.net/plugsign/apis/endpoints-manuais/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plugsign/endpoints-manuais/revisions/41e10c7c691b/schema)