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

# Listar webhooks

> Traz, de forma paginada, os webhooks cadastrados para o parceiro autenticado. A credencial e o segredo de assinatura não são retornados.

Lista os webhooks do parceiro, de forma paginada. A credencial e o segredo de assinatura não são retornados.


## OpenAPI

````yaml GET /v1/webhook
openapi: 3.1.0
info:
  title: API Credicarro
  description: API para gerenciamento de cobranças e pagamentos usando o Credicarro.
  version: 1.0.0
servers:
  - url: https://api.staging.credicarro.com.br/integration
    description: Servidor para o ambiente de staging
  - url: https://api.credicarro.com.br/integration
    description: Servidor para o ambiente de produção
security: []
paths:
  /v1/webhook:
    get:
      tags:
        - Webhook
      summary: Consultar webhooks do parceiro
      description: >-
        Traz, de forma paginada, os webhooks cadastrados para o parceiro
        autenticado. A credencial e o segredo de assinatura não são retornados.
      parameters:
        - name: pagina_inicial
          in: query
          description: Página inicial (mínimo 1)
          schema:
            type: integer
            format: int32
            example: 1
        - name: limite
          in: query
          description: Quantidade de itens por página (1 a 100)
          schema:
            type: integer
            format: int32
            example: 10
      responses:
        '200':
          description: Lista de webhooks retornada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  itens:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookResponse'
                  pagina:
                    $ref: '#/components/schemas/Page'
        '400':
          description: Erro na requisição
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          $ref: '#/components/responses/IntegrationInactive'
      security:
        - bearerAuth: []
components:
  schemas:
    WebhookResponse:
      type: object
      properties:
        id_webhook:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        tipo:
          type: string
          example: Proposal
        url:
          type: string
          example: https://parceiro.com.br/webhooks/credicarro
        tipo_autenticacao:
          type: string
          example: Basic
        status:
          type: string
          example: Active
    Page:
      type: object
      properties:
        tem_proximo:
          type: boolean
          description: Identificador se existe uma próxima página
          example: true
        tem_anterior:
          type: boolean
          description: Identificador se existe uma página anterior
          example: false
        numero:
          type: integer
          format: int32
          description: Página atual.
          example: 2
        tamanho:
          type: integer
          format: int32
          description: Quantidade de dados por página
          example: 15
        total:
          type: integer
          format: int64
          description: Total de dados encontrados
          example: 45
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        tipo:
          type: string
          description: Tipo de problema encontrado
          example: Validation.Cpf.Invalid
        titulo:
          type: string
          description: Título do erro
          example: Requisição inválida
        status:
          type: integer
          format: int32
          description: Status Code do erro
          example: 400
        detalhe:
          type: string
          description: Descrição do erro
          example: O CPF informado em 'cpf' é inválido.
        campo:
          type: string
          nullable: true
          description: Campo da requisição relacionado ao erro, quando houver
          example: cpf
        erros:
          type: array
          description: >-
            Lista de erros. Presente só quando o JSON enviado está malformado ou
            tem um valor de tipo errado.
          items:
            type: object
            properties:
              codigo:
                type: string
                description: Código estável do erro
                example: Validation.InvalidFormat
              mensagem:
                type: string
                description: Mensagem em português
                example: O valor informado para 'valorVeiculo' não é um número válido.
              campo:
                type: string
                nullable: true
                description: Campo inválido, quando houver
                example: cpf
      additionalProperties: false
  responses:
    IntegrationInactive:
      description: >-
        Integração do parceiro inativa ou não encontrada
        (`Integration.Access.Inactive`,
        `Integration.Access.OrganizationNotFound`)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer <token>` onde
        `<token>` é seu TOKEN de autenticação

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.