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

# Buscar um webhook

> Retorna os dados de um webhook específico pelo seu identificador.

<Card horizontal>
  Requer a permissão `WEBHOOK:READ`.
</Card>


## OpenAPI

````yaml GET /webhooks/get
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v2
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /webhooks/get:
    get:
      summary: Buscar um webhook
      description: Retorna os dados de um webhook específico pelo seu identificador.
      parameters:
        - name: id
          in: query
          description: Identificador único do webhook
          required: true
          schema:
            type: string
            example: webh_abc123xyz
      responses:
        '200':
          description: Webhook encontrado com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WebhookResponse'
                  error:
                    type: string
                    nullable: true
                    example: null
                  success:
                    $ref: '#/components/schemas/Success'
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: >-
                      Mensagem de erro descrevendo o motivo da falha na
                      autenticação.
                    example: Token de autenticação inválido ou ausente.
        '404':
          description: Webhook não encontrado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: >-
                      Mensagem de erro indicando que o webhook não foi
                      encontrado.
                    example: Webhook não encontrado.
      security:
        - bearerAuth: []
components:
  schemas:
    WebhookResponse:
      type: object
      description: Os dados do webhook.
      required:
        - id
        - name
        - endpoint
        - events
        - devMode
        - v2
        - createdAt
        - updatedAt
      additionalProperties: false
      properties:
        id:
          type: string
          description: Identificador único do webhook
          example: webh_abc123xyz
        name:
          type: string
          description: Nome identificador do webhook
          example: Webhook de Pagamentos
        endpoint:
          type: string
          description: URL HTTPS que recebe as notificações de eventos
          example: https://meusite.com/webhooks/abacatepay
        events:
          type: array
          description: Lista de eventos subscritos
          items:
            type: string
          example:
            - checkout.completed
            - subscription.renewed
        devMode:
          type: boolean
          description: Indica se o webhook foi criado em ambiente de testes
          example: false
        v2:
          type: boolean
          description: Indica se o webhook usa o formato de payload v2
          example: true
        createdAt:
          type: string
          format: date-time
          description: Data de criação do webhook
          example: '2025-01-01T00:00:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização do webhook
          example: '2025-01-01T00:00:00.000Z'
    Success:
      type: boolean
      description: Se a requisição obteve sucesso ou não.
      example: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Todas as requisições devem incluir sua chave de API no header
        Authorization usando o formato `Bearer <abacatepay-api-key>`. Sem esse
        header a requisição será rejeitada.


        Saiba mais sobre como criar e usar chaves de API na [documentação de
        autenticação](/pages/authentication).

````