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

# Listar webhooks

> Retorna os webhooks cadastrados pelo parceiro. As credenciais de autenticação nunca são retornadas. Configurações de Cliente e Simulação podem aparecer na lista, embora esses fluxos ainda não realizem disparos.

Retorna de forma paginada os webhooks cadastrados pelo parceiro identificado automaticamente pelo token.

## Tipos de webhook

| Valor | Tipo          | Disponibilidade                                                              |
| ----- | ------------- | ---------------------------------------------------------------------------- |
| `1`   | **Cliente**   | 🟡 **Em roadmap** — pode ser cadastrado, mas ainda não envia notificações.   |
| `2`   | **Simulação** | 🟡 **Em roadmap** — pode ser cadastrado, mas ainda não envia notificações.   |
| `3`   | **Pedido**    | 🟢 **Disponível** — envia notificações para os eventos de pedido suportados. |

<Warning>
  Os tipos Cliente (`1`) e Simulação (`2`) podem aparecer na listagem, mas ainda não enviam notificações. Atualmente, apenas o tipo Pedido (`3`) está disponível para os eventos suportados.
</Warning>

## Tipos de autenticação

| Valor | Significado                                                              |
| ----- | ------------------------------------------------------------------------ |
| `1`   | **Nenhuma** — a requisição é enviada sem credencial de autenticação.     |
| `2`   | **Basic** — utiliza a credencial informada para autenticação HTTP Basic. |
| `3`   | **JWT** — utiliza a credencial informada como token Bearer JWT.          |

<Note>
  Por segurança, as credenciais de autenticação nunca são retornadas por este endpoint.
</Note>


## OpenAPI

````yaml GET /v1/webhooks/paged
openapi: 3.0.1
info:
  title: WebIntegration
  description: Este documento descreve os endpoints disponíveis da API.
  version: '1.0'
servers:
  - url: https://api.staging.parcelemais.com.br/integration
    description: Servidor para o ambiente de staging
security:
  - bearerAuth: []
paths:
  /v1/webhooks/paged:
    get:
      tags:
        - Webhook
      summary: Listar webhooks.
      description: >-
        Retorna os webhooks cadastrados pelo parceiro. As credenciais de
        autenticação nunca são retornadas. Configurações de Cliente e Simulação
        podem aparecer na lista, embora esses fluxos ainda não realizem
        disparos.
      operationId: pagedWebHooks
      parameters:
        - name: pagina
          in: query
          description: 'Número da página. Padrão: 1.'
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: tamanhoPagina
          in: query
          description: 'Quantidade de itens por página. Padrão: 10. Máximo: 100.'
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
      responses:
        '200':
          description: Webhooks retornados com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedWebHookIntegrationResponse'
              example:
                items:
                  - tipo: 3
                    url: https://parceiro.exemplo.com/webhooks/pedidos
                    tipoAutenticacao: 3
                pagina:
                  tem_proximo: false
                  tem_anterior: false
                  numero: 1
                  tamanho: 10
                  total: 1
        '400':
          description: Parâmetros de paginação inválidos.
        '404':
          description: Parceiro não encontrado.
        '500':
          description: Internal Server Error
components:
  schemas:
    PagedWebHookIntegrationResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WebHookIntegrationResponse'
        pagina:
          $ref: '#/components/schemas/PaginationIntegrationResponse'
      additionalProperties: false
    WebHookIntegrationResponse:
      type: object
      properties:
        tipo:
          type: integer
          format: int32
          enum:
            - 1
            - 2
            - 3
          description: >-
            1: Cliente (fluxo em roadmap); 2: Simulação (fluxo em roadmap); 3:
            Pedido (envio disponível).
        url:
          type: string
          format: uri
        tipoAutenticacao:
          type: integer
          format: int32
          enum:
            - 1
            - 2
            - 3
          description: '1: Nenhuma; 2: Basic; 3: JWT.'
      additionalProperties: false
    PaginationIntegrationResponse:
      type: object
      properties:
        tem_proximo:
          type: boolean
        tem_anterior:
          type: boolean
        numero:
          type: integer
          format: int32
        tamanho:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
      additionalProperties: false
  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

````