---
title: "Listar Webhooks Cadastrados"
method: GET
path: "/api/service/sign/v1/webhook"
tags: ["Webhook"]
---

# Listar Webhooks Cadastrados

`GET /api/service/sign/v1/webhook`

Verifica quais os vínculos de mensagem de atualização (serviço de webhook) o usuário tem cadastrados e retorna suas informações.

## Response `200`

Retorno de Sucesso para detalhes dos vínculos Webhook do cliente cadastrado

- WebhookGetResponse[]
  - `data` object[] — Lista de webhooks cadastrados.
    - `webhookId` string — UUID do link Webhook gerado.
    - `methodId` string — UUID do método Webhook gerado.
    - `description` string — Descrição do link Webhook.
    - `url` string — Endpoint configurado para disparar a mensagem de atualização do Webhook.
    - `authenticationType` string — Tipo de autenticação escolhida para o endpoint configurado. Atualmente suporta apenas `NONE`.
    - `AuthenticationKey` string — Chave de autenticação quando authType for diferente de `NONE`.
    - `webhookType` string — Tipo de link Webhook. Para atualizações no estado do envelope (easy.collection) ou para atualizações no estado de qualquer assinatura de uma coleção (easy.signature) para o usuário autenticado. Valores disponíveis: [`easy.collection`, `easy.signature`]

## Other responses

- `4XX` — Retorno de erro da aplicação
- `5XX` — Retorno de erro da aplicação

---

[API](https://skmtc.net/bry/apis/bry-easy-sign-api-rest.md) · [All operations](https://skmtc.net/bry/apis/bry-easy-sign-api-rest/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bry/bry-easy-sign-api-rest/revisions/c87e026e87ac/schema)