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

# Atualizar um Registro de Webhook

> Use este endpoint para atualizar um ou mais campos de um registro de webhook. Apenas os campos presentes no corpo da requisição são alterados. Enviar `eventTypes` como `null` limpa o filtro para que o registro receba todos os tipos de evento. Apenas registros pertencentes ao tenant do chamador podem ser atualizados.

Use o cabeçalho `X-Idempotency` para deduplicação garantida.



## OpenAPI

````yaml pt/openapi/v3-current/ted.yaml patch /v1/webhooks/{webhookId}
openapi: 3.0.3
info:
  title: API do Plugin de Transferência Bancária (TED)
  description: >-
    API completa para transferências bancárias brasileiras (TED OUT, TED IN,
    P2P) através da plataforma Lerian, incluindo iniciação de transferências,
    processamento, acompanhamento de status e cancelamento.
  version: 1.1.9
servers:
  - url: https://ted.sandbox.lerian.net
    description: Sandbox (placeholder — ainda não disponível para acesso público)
security:
  - BearerAuth: []
  - OAuth2ClientCredentials:
      - api
  - OAuth2Password:
      - api
tags:
  - name: Transfers API
    description: Endpoints para iniciar, processar, acompanhar e cancelar transferências.
  - name: Webhooks
    description: >-
      Endpoints para registrar e gerenciar assinaturas de webhook com escopo de
      tenant para eventos de transferência.
  - name: Webhook DLQ
    description: >-
      Endpoints para inspecionar e reprocessar mensagens da dead-letter queue de
      webhooks.
paths:
  /v1/webhooks/{webhookId}:
    patch:
      tags:
        - Webhooks
      summary: Atualizar um Registro de Webhook
      description: >-
        Use este endpoint para atualizar um ou mais campos de um registro de
        webhook. Apenas os campos presentes no corpo da requisição são
        alterados. Enviar `eventTypes` como `null` limpa o filtro para que o
        registro receba todos os tipos de evento. Apenas registros pertencentes
        ao tenant do chamador podem ser atualizados.


        Use o cabeçalho `X-Idempotency` para deduplicação garantida.
      operationId: patchWebhook
      parameters:
        - $ref: '#/components/parameters/XIdempotencyKey'
        - name: webhookId
          in: path
          required: true
          description: O identificador único do registro de webhook a ser atualizado.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchWebhookRequest'
            examples:
              disable:
                summary: Desabilitar um registro
                value:
                  enabled: false
              changeEvents:
                summary: Restringir o filtro de eventos
                value:
                  eventTypes:
                    - transfer.completed
      responses:
        '200':
          description: >-
            Indica que o registro de webhook foi atualizado.


            Chamadas repetidas com a mesma chave `X-Idempotency` reproduzem a
            resposta em cache.


            Consulte [Tentativas e
            idempotência](/pt/reference/retries-idempotency) para mais detalhes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookRegistrationResponse'
              examples:
                patched:
                  summary: Registro atualizado
                  value:
                    id: 550e8400-e29b-41d4-a716-446655440000
                    name: Operations webhook
                    endpointUrl: https://hooks.example.com/transfer-events
                    enabled: false
                    eventTypes:
                      - transfer.completed
                    createdAt: '2026-02-01T15:30:00Z'
                    updatedAt: '2026-02-01T16:00:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/WebhookNotFound'
        '409':
          $ref: '#/components/responses/WebhookConflict'
        '422':
          $ref: '#/components/responses/WebhookValidationError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  parameters:
    XIdempotencyKey:
      name: X-Idempotency
      in: header
      required: true
      description: >-
        Chave de idempotência obrigatória para tentativas seguras. Use um UUID
        v4 ou identificador de negócio único. Se a mesma chave for enviada
        novamente e a solicitação original já tiver sido processada, a resposta
        em cache será retornada.


        Consulte [Tentativas e idempotência](/pt/reference/retries-idempotency)
        para detalhes.
      schema:
        type: string
        maxLength: 255
      example: 019c96a0-aa10-7abc-d1e2-8c9d0e1f2a3b
  schemas:
    PatchWebhookRequest:
      type: object
      description: >-
        Apenas os campos presentes na requisição são atualizados. Enviar
        `eventTypes` como `null` limpa o filtro para que o registro receba todos
        os tipos de evento.
      properties:
        name:
          type: string
          description: Um nome legível por humanos para o registro.
          example: Operations webhook
        endpointUrl:
          type: string
          format: uri
          pattern: ^https://
          description: >-
            O endpoint que recebe as entregas de eventos. Deve ser uma URL
            HTTPS.
          example: https://hooks.example.com/transfer-events
        enabled:
          type: boolean
          description: Se o registro está ativo.
          example: true
        eventTypes:
          type: array
          maxItems: 64
          nullable: true
          description: >-
            Os tipos de evento que este endpoint assina. Envie `null` para
            limpar o filtro e receber todos os tipos de evento.
          items:
            type: string
          example:
            - transfer.completed
    WebhookRegistrationResponse:
      type: object
      required:
        - id
        - name
        - endpointUrl
        - enabled
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
          description: O identificador único do registro de webhook.
          example: 550e8400-e29b-41d4-a716-446655440000
        name:
          type: string
          description: O nome legível por humanos do registro.
          example: Operations webhook
        endpointUrl:
          type: string
          format: uri
          description: O endpoint HTTPS que recebe as entregas de eventos.
          example: https://hooks.example.com/transfer-events
        enabled:
          type: boolean
          description: Se o registro está ativo.
          example: true
        eventTypes:
          type: array
          description: >-
            Os tipos de evento que este endpoint assina. Ausente quando o
            registro recebe todos os tipos de evento.
          items:
            type: string
          example:
            - transfer.completed
        createdAt:
          type: string
          format: date-time
          description: O timestamp de quando o registro foi criado.
          example: '2026-02-01T15:30:00Z'
        updatedAt:
          type: string
          format: date-time
          description: O timestamp da última atualização.
          example: '2026-02-01T15:30:00Z'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - service
            - category
            - message
            - requestId
          properties:
            code:
              type: string
              description: >-
                O código de erro estável. Erros do plugin usam o formato
                `BTF-XXXX`; rejeições de negócio/autenticação do JD SPB repassam
                o código bruto do fornecedor literalmente (por exemplo, `AAC90`,
                `ACE95`, `DVE01`), e falhas de transporte no nível do JD expõem
                os marcadores sintéticos `TRANSPORT` ou `JD_MISSING_CODE`. Faça
                a correspondência com base neste valor, e não no status HTTP.
              example: BTF-0010
            service:
              type: string
              description: O serviço ou domínio que produziu o erro.
              example: plugin
            category:
              type: string
              description: >-
                Categoria de erro legível por máquina usada para decisões de
                reprocessamento.
              enum:
                - deterministic
                - transient
                - rate_limit
                - plugin
              example: deterministic
            message:
              type: string
              description: Um resumo do erro legível por humanos.
              example: >-
                Transferências só podem ser iniciadas de segunda a sexta entre
                06:30 e 17:00 horário de Brasília
            requestId:
              type: string
              description: O ID de correlação da requisição. Presente mesmo quando vazio.
              example: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            fields:
              type: object
              additionalProperties: true
              description: >-
                Metadados estruturados de validação ou reprocessamento quando
                disponíveis. Detalhes de validação em nível de campo, cabeçalho,
                caminho e consulta são todos retornados aqui.
              example:
                currentTime: '2026-02-01T18:30:00-03:00'
                operatingHours: Mon-Fri 06:30-17:00 UTC-3
  responses:
    BadRequest:
      description: >-
        Indica que a requisição contém entrada inválida. Verifique os detalhes
        do campo para erros de validação específicos.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidInput:
              summary: Validation error
              value:
                error:
                  code: BTF-0001
                  service: plugin
                  category: deterministic
                  message: >-
                    The request contains invalid fields. Check the field details
                    below.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
                  fields:
                    recipientIspb: must be 8 digits
                    amount: must be positive
    Unauthorized:
      description: Indica que a requisição não possui um token de autenticação válido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              summary: Missing authorization
              value:
                error:
                  code: BTF-0401
                  service: plugin
                  category: deterministic
                  message: Missing or invalid authentication token
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    Forbidden:
      description: >-
        Indica que o chamador está autenticado mas não tem permissão para esta
        operação, ou o tenant não está licenciado para este endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            notLicensed:
              summary: Tenant not licensed
              value:
                error:
                  code: BTF-0403
                  service: plugin
                  category: deterministic
                  message: Tenant is not licensed to use this endpoint
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            permissionDenied:
              summary: Caller lacks permission
              value:
                error:
                  code: BTF-0405
                  service: plugin
                  category: deterministic
                  message: Caller lacks permission for this resource
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    WebhookNotFound:
      description: >-
        Indica que o registro de webhook não foi encontrado ou pertence a um
        tenant diferente.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            notFound:
              summary: Unknown webhook id
              value:
                error:
                  code: BTF-0306
                  service: plugin
                  category: deterministic
                  message: webhook registration not found
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    WebhookConflict:
      description: >-
        Indica que já existe um registro de webhook com o mesmo endpoint para
        este tenant.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            duplicate:
              summary: Endpoint already registered
              value:
                error:
                  code: BTF-0012
                  service: plugin
                  category: deterministic
                  message: webhook registration already exists
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    WebhookValidationError:
      description: >-
        Indica que o payload do webhook violou uma restrição de domínio, como
        uma URL de endpoint inválida ou um tipo de evento não suportado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidEventType:
              summary: Unsupported event type
              value:
                error:
                  code: BTF-0002
                  service: plugin
                  category: deterministic
                  message: eventTypes contains an unsupported value
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            invalidUrl:
              summary: Endpoint URL not allowed
              value:
                error:
                  code: BTF-0002
                  service: plugin
                  category: deterministic
                  message: endpointUrl must be a valid HTTPS URL
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    ServiceUnavailable:
      description: >-
        Indica que um serviço externo (CRM, JD SPB, Midaz ou Fees) está
        temporariamente indisponível.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            crmUnavailable:
              summary: CRM service down
              value:
                error:
                  code: BTF-0502
                  service: crm
                  category: transient
                  message: >-
                    Unable to validate account. The CRM service is temporarily
                    unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            jdUnavailable:
              summary: JD SPB unavailable
              value:
                error:
                  code: TRANSPORT
                  service: jd_spb
                  category: transient
                  message: >-
                    Unable to submit transfer. The JD SPB service is temporarily
                    unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            midazUnavailable:
              summary: Midaz ledger unavailable
              value:
                error:
                  code: BTF-2000
                  service: midaz
                  category: transient
                  message: >-
                    Unable to process transfer. The Midaz ledger service is
                    temporarily unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            feeServiceUnavailable:
              summary: Fee service unavailable (fail-closed mode)
              value:
                error:
                  code: BTF-3000
                  service: fees
                  category: transient
                  message: >-
                    Unable to calculate fee. The fee service is temporarily
                    unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            dlqInspectorUnavailable:
              summary: DLQ inspector not configured
              value:
                error:
                  code: BTF-9005
                  service: plugin
                  category: deterministic
                  message: DLQ inspector is not configured
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Autenticação por token JWT Bearer. O tenantId é derivado do token bearer
        ou do contexto de requisição autenticado e não é fornecido por meio do
        X-Organization-Id.
    OAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /v1/login/oauth/access_token
          scopes:
            api: Acesso à API de transferências TED
    OAuth2Password:
      type: oauth2
      flows:
        password:
          tokenUrl: /v1/login/oauth/access_token
          scopes:
            api: Acesso à API de transferências TED

````