---
title: "Consultar webhooks cadastrados."
method: GET
path: "/webhook"
tags: ["Webhook"]
---

# Consultar webhooks cadastrados.

`GET /webhook`

Endpoint para consultar Webhooks cadastrados

## Query parameters

- `inicio` string, date-time — Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.
- `fim` string, date-time — Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.
- `paginacao.paginaAtual` integer — Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.
- `paginacao.itensPorPagina` integer — Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

## Response `200`

lista dos locations cadastrados de acordo com o critério de busca.

- WebhooksConsultados
  - `parametros` ParametrosConsultaWebhooks — Parâmetros utilizados para a realização de uma consulta de Webhooks.
    - `inicio` string, date-time — Data inicial utilizada na consulta. Respeita RFC 3339.
    - `fim` string, date-time — Data de fim utilizada na consulta. Respeita RFC 3339.
    - `paginacao` Paginacao
      - `paginaAtual` integer, required — Número da página recuperada.
      - `itensPorPagina` integer, required — Quantidade de registros retornado na página.
      - `quantidadeDePaginas` integer, required — Quantidade de páginas disponíveis para consulta.
      - `quantidadeTotalDeItens` integer, required — Quantidade total de itens disponíveis de acordo com os parâmetros informados.
  - `webhooks` WebhookCompleto[], required
    - `webhookUrl` string, uri, required
    - `cnpj` string, required — Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF.
    - `criacao` string, date-time, required — Data e hora em que o webhook foi cadastrado. Respeita RFC 3339.

## Other responses

- `403` — Requisição de participante autenticado que viola alguma regra de autorização.
- `503` — Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.

## Changes

- **2024-08-30** `e60160879b89` — 1 breaking, 1 info
  - removed the required property `webhooks/items/allOf[subschema #1: Webhook]/chave` from the response with the `200` status
  - added the required property `webhooks/items/allOf[subschema #1: Webhook]/cnpj` to the response with the `200` status
- **2021-02-10** `3872a6881bfb` — 4 breaking, 2 info
  - the response property `parametros` became optional for the status `200`
  - the response property `parametros/fim` became optional for the status `200`
  - the response property `parametros/inicio` became optional for the status `200`
  - the response property `parametros/paginacao` became optional for the status `200`
  - …2 more
- **2020-12-03** `1ab8ae73a0ae` — 2 info
  - added the non-success response with the status `403`
  - added the non-success response with the status `503`
- **2020-11-06** `06f7084857b9` — 2 info
  - the security scope `webhook.read` was added to the endpoint's security scheme `OAuth2`
  - the security scope `payloadlocation.read` was removed from the endpoint's security scheme `OAuth2`
- **2020-11-06** `f4a2162d6068` — 3 breaking, 6 info
  - added the new required `query` request parameter `fim`
  - added the new required `query` request parameter `inicio`
  - removed the required property `webhookUrl` from the response with the `200` status
  - the security scope `payloadlocation.read` was added to the endpoint's security scheme `OAuth2`
  - …5 more

[Full history](https://skmtc.dev/bacen/apis/api-pix/changes/webhook/get.md)

---

[API](https://skmtc.dev/bacen/apis/api-pix.md) · [All operations](https://skmtc.dev/bacen/apis/api-pix/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bacen/api-pix/revisions/1a3df62a7286/schema)