> ## Documentation Index
> Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Buscar webhook por ID

> Retorna a configuração de um webhook — URL, eventos assinados, situação e se ele assina as entregas.

`GET /webhooks/:id`

Faz parte do recurso [Webhooks](/pt-BR/webhooks) — o cadastro e o catálogo de eventos estão lá.

Retorna a configuração atual de um webhook. É a leitura que responde "este endereço ainda está
recebendo, e o quê".

<Note>
  **`autoDisabledAt` diz por que ele parou.** Preenchido, o webhook foi desativado **pela Z2Pay**
  depois de uma sequência de falhas — e nenhum evento novo é enviado desde então. `null` com
  `isActive: false` significa que alguém o desativou de propósito. O critério da desativação
  automática está em [Entrega e retentativas](/pt-BR/webhooks/entregas#desativa-o-autom-tica).
</Note>

<Note>
  **`secretHint` não serve para verificar assinatura** — é um fragmento, só para você reconhecer
  qual segredo está configurado. O valor completo aparece uma única vez, na
  [criação](/pt-BR/webhooks/create).
</Note>

## Exemplo

```bash theme={null}
curl https://api.sandbox.z2pay.com/v1/webhooks/whk_k9clfafnldd96dbbxruh34233 \
  -H "x-api-key: SUA_CHAVE_DE_SANDBOX"
```

```json Resposta 200 theme={null}
{
  "id": "whk_k9clfafnldd96dbbxruh34233",
  "name": "Notificações de pagamento",
  "url": "https://meusite.com/webhooks/z2pay",
  "events": ["transaction.paid", "transaction.refunded"],
  "isActive": true,
  "hasSecret": true,
  "secretHint": "whsec_kQ8v…rS8t",
  "autoDisabledAt": null,
  "createdAt": "2026-06-24T13:45:00.000Z",
  "updatedAt": "2026-06-24T13:45:00.000Z"
}
```


## OpenAPI

````yaml openapi/psp.json GET /webhooks/{id}
openapi: 3.0.3
info:
  title: Z2Pay PSP API
  version: 1.0.0
  description: API pública do PSP — autenticação via API Key (Credential)
servers:
  - url: https://api.sandbox.z2pay.com/v1
    description: Sandbox
  - url: https://api.z2pay.com/v1
    description: Produção
security: []
tags:
  - name: Cards
    description: Cartões salvos de um cliente
  - name: Chargebacks
    description: Gerenciamento de chargebacks
  - name: Customers
    description: Gerenciamento de clientes (compradores)
  - name: Fees
    description: Tabela de taxas da conta (pix, boleto, cartão, saque, refund, chargeback)
  - name: Recipients
    description: Gerenciamento de recebedores (sellers/merchants que recebem repasses)
  - name: Refunds
    description: Gerenciamento de reembolsos e estornos
  - name: Splits
    description: Regras de divisão do valor de uma venda entre recebedores
  - name: Transactions
    description: Gerenciamento de transações e payments
  - name: Wallets
    description: Saldo, extrato e resumo da carteira de um recebedor, agrupados por moeda
  - name: Webhooks
    description: Configuração, gerenciamento e histórico de entregas de webhooks
  - name: Withdrawals
    description: Solicitação e acompanhamento de saques (payouts) por recipient
paths:
  /webhooks/{id}:
    get:
      tags:
        - Webhooks
      summary: Buscar webhook por ID
      description: Retorna os dados de um webhook específico
      operationId: WebhookController_getById
      parameters:
        - name: id
          in: path
          required: true
          description: ID do webhook
          schema:
            type: string
      responses:
        '200':
          description: Dados do webhook
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Identificador único do registro.
                  name:
                    type: string
                    description: Nome do registro.
                  url:
                    type: string
                    format: uri
                    description: URL de destino do webhook ou link de download do arquivo.
                  events:
                    type: array
                    items:
                      type: string
                    description: Tipos de evento assinados pelo webhook.
                  isActive:
                    type: boolean
                    description: Indica se o registro está ativo.
                  hasSecret:
                    type: boolean
                  secretHint:
                    type: string
                    nullable: true
                  autoDisabledAt:
                    type: string
                    format: date-time
                    nullable: true
                  createdAt:
                    type: string
                    format: date-time
                    description: Data e hora de criação do registro (ISO 8601).
                  updatedAt:
                    type: string
                    format: date-time
                    description: Data e hora da última atualização do registro (ISO 8601).
                required:
                  - id
                  - name
                  - url
                  - events
                  - isActive
                  - hasSecret
                  - secretHint
                  - autoDisabledAt
                  - createdAt
                  - updatedAt
        '401':
          description: Chave de API ausente, malformada ou inválida
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Identificador estável do erro. É por ele que você deve
                          ramificar, não pela mensagem.
                      message:
                        type: string
                        description: >-
                          Descrição legível. Pode mudar sem aviso e não deve ser
                          usada em condicional.
              example:
                error:
                  code: UNAUTHORIZED
                  message: Invalid API key
        '404':
          description: Webhook não encontrado
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Identificador estável do erro. É por ele que você deve
                          ramificar, não pela mensagem.
                      message:
                        type: string
                        description: >-
                          Descrição legível. Pode mudar sem aviso e não deve ser
                          usada em condicional.
              example:
                error:
                  code: NOT_FOUND
                  message: Webhook not found
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key da Credential (gerada no Backoffice)

````