> ## 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.

# Editar webhook

> Atualiza o webhook do tipo informado. Se a credencial for omitida, a credencial atual será preservada. Cliente e Simulação podem ser configurados, mas seus fluxos de envio ainda estão em roadmap.

Atualiza a URL e a autenticação de um webhook já cadastrado.

## 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 ser configurados, 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>
  Quando a credencial é omitida, a credencial atual é preservada. Ao selecionar autenticação `1` (Nenhuma), a credencial armazenada é removida.
</Note>


## OpenAPI

````yaml PUT /v1/webhooks/{tipo}
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/{tipo}:
    put:
      tags:
        - Webhook
      summary: Editar webhook.
      description: >-
        Atualiza o webhook do tipo informado. Se a credencial for omitida, a
        credencial atual será preservada. Cliente e Simulação podem ser
        configurados, mas seus fluxos de envio ainda estão em roadmap.
      operationId: updateWebHook
      parameters:
        - $ref: '#/components/parameters/WebHookType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebHookRequest'
            example:
              url: https://parceiro.exemplo.com/webhooks/pedidos
              tipoAutenticacao: 2
              credencial: usuario:senha
      responses:
        '200':
          description: Webhook atualizado com sucesso.
        '400':
          description: Dados inválidos.
        '404':
          description: Parceiro ou webhook não encontrado.
        '500':
          description: Internal Server Error
components:
  parameters:
    WebHookType:
      name: tipo
      in: path
      required: true
      description: |
        Tipo do webhook:
        - `1` — Cliente: configuração disponível; fluxo de envio em roadmap.
        - `2` — Simulação: configuração disponível; fluxo de envio em roadmap.
        - `3` — Pedido: envio disponível para os eventos suportados.
      schema:
        type: integer
        format: int32
        enum:
          - 1
          - 2
          - 3
  schemas:
    UpdateWebHookRequest:
      required:
        - url
        - tipoAutenticacao
      type: object
      properties:
        url:
          type: string
          format: uri
          description: URL HTTP ou HTTPS que receberá as notificações.
        tipoAutenticacao:
          type: integer
          format: int32
          enum:
            - 1
            - 2
            - 3
          description: '1: Nenhuma; 2: Basic; 3: JWT.'
        credencial:
          type: string
          nullable: true
          description: >-
            Quando omitida, mantém a credencial atual. É removida quando o tipo
            de autenticação é Nenhuma.
      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

````