> ## 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, como uma lista simples (sem paginação — um parceiro tem no máximo 3 webhooks, um por tipo: Cliente, Simulação, Pedido). 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 a lista de webhooks cadastrados pelo parceiro identificado automaticamente pelo token — sem paginação, já que um parceiro tem no máximo 3 webhooks (um por tipo).

## 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
openapi: 3.0.1
info:
  title: WebIntegration
  description: Este documento descreve os endpoints disponíveis da API.
  version: '1.0'
servers:
  - url: https://api.parcelemais.com.br/integration
    description: Servidor para o ambiente de produção
  - url: https://api.staging.parcelemais.com.br/integration
    description: Servidor para o ambiente de staging
security:
  - bearerAuth: []
paths:
  /v1/webhooks:
    get:
      tags:
        - Webhook
      summary: Listar webhooks.
      description: >
        Retorna os webhooks cadastrados pelo parceiro, como uma lista simples
        (sem paginação — um parceiro tem no máximo 3 webhooks, um por tipo:
        Cliente, Simulação, Pedido). 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: listWebHooks
      responses:
        '200':
          description: Webhooks retornados com sucesso.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebHookIntegrationResponse'
              example:
                - tipo: 3
                  url: https://parceiro.exemplo.com/webhooks/pedidos
                  tipoAutenticacao: 3
        '404':
          description: Parceiro não encontrado.
        '500':
          description: Internal Server Error
components:
  schemas:
    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
  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

````