---
title: "Listar Webhooks"
method: GET
path: "/webhook/"
tags: ["Webhook"]
---

# Listar Webhooks

`GET /webhook/`

Este endpoint permite que você recupere uma lista de todos os webhooks cadastrados em sua conta. Ele é útil para fins de auditoria e manutenção.

## Query parameters

- `page` integer — Page number
- `size` integer — Page size
- `resource` 'vehicle_debt' | 'vehicle_debt_batch' | 'checkout' | 'autoradar' | 'payment_recurrence' | 'documents' | 'monitoring'
- `is_active` boolean, nullable — Filtro por status do webhook

## Response `200`

Retorno dos webhooks

- PageWebhookResponseDTOInput
  - `items` WebhookResponseDTOInput[], required
    - `id` string, nullable, required — Id único do webhook
    - `url` string, required — Url do webhook para comunicação das mensagens
    - `resource` 'vehicle_debt' | 'vehicle_debt_batch' | 'checkout' | 'autoradar' | 'payment_recurrence' | 'documents' | 'monitoring'
    - `auth` AuthModel — Caso seja APIKey o campo no header será x-api-key: <value> Caso outros casos será Authorization: <prefix> <value>
      - `type` 'APIKey' | 'Token'
      - `value` string, required — Valor do token de autenticação ou APIKey
      - `prefix` 'Basic' | 'Bearer' | 'JWT'
    - `created_at` string — Data da criação do Webhook
    - `updated_at` string — Data da ultima atualização do Webhook
  - `total` integer, nullable, required
  - `page` integer, nullable, required
  - `size` integer, nullable, required
  - `pages` integer, nullable

## Other responses

- `400` — Formato da requisição inválida
- `422` — Validation Error
- `500` — Erro interno
- `503` — Serviço temporariamente indisponível

---

[API](https://skmtc.net/usezapay/apis/zapi.md) · [All operations](https://skmtc.net/usezapay/apis/zapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usezapay/zapi/versions/50c96157fff4/schema)
