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

# Editar webhook

> Atualiza o tipo, a URL e o status de um webhook do parceiro autenticado. A autenticação (tipo e credencial)
não pode ser alterada; para trocá-la, exclua o webhook e cadastre outro.


Altera o tipo, a URL e o status de um webhook. `tipo` e `url` são sempre obrigatórios. Para pausar sem excluir, reenvie o `tipo` e a `url` atuais com `status` = 2.

> [!WARNING]
>
> A autenticação (tipo e credencial) não pode ser alterada. Para trocá-la, exclua o webhook e cadastre outro.


## OpenAPI

````yaml PUT /v1/webhook/{webhookId}
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/{webhookId}:
    put:
      tags:
        - Webhook
      summary: Editar um webhook
      description: >
        Atualiza o tipo, a URL e o status de um webhook do parceiro autenticado.
        A autenticação (tipo e credencial)

        não pode ser alterada; para trocá-la, exclua o webhook e cadastre outro.
      parameters:
        - $ref: '#/components/parameters/WebhookId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - tipo
                - url
              additionalProperties: false
              properties:
                tipo:
                  type: integer
                  format: int32
                  description: |
                    Evento notificado pelo webhook.
                    Valores aceitos:
                      - 1 = Customer
                      - 2 = Simulation
                      - 3 = Proposal
                  example: 3
                url:
                  type: string
                  description: >-
                    URL HTTPS pública, com até 2048 caracteres, que receberá as
                    notificações (sem localhost, IP privado, usuário/senha ou
                    fragmento).
                  example: https://parceiro.com.br/webhooks/credicarro
                status:
                  type: integer
                  format: int32
                  description: |
                    Status do webhook. Quando omitido, mantém o status atual.
                    Valores aceitos:
                      - 1 = Active
                      - 2 = Inactive
                  example: 1
      responses:
        '204':
          description: Webhook atualizado com sucesso. A resposta não tem corpo.
          content:
            text/plain:
              schema:
                type: string
                description: Resposta sem corpo
              example: No Content
        '400':
          description: Erro na requisição
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          $ref: '#/components/responses/IntegrationInactive'
        '404':
          description: >-
            Webhook não encontrado para este parceiro
            (`Webhook.Registration.NotFound`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: >-
            O webhook foi alterado ao mesmo tempo por outra requisição
            (`Organization.Webhook.ConcurrencyConflict`). Tente de novo.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: >-
            URL não aceita (`Organization.Webhook.InvalidEndpoint`) ou ativação
            com a integração inativa
            (`Organization.Webhook.ActivationIntegrationInactive`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
        - bearerAuth: []
components:
  parameters:
    WebhookId:
      name: webhookId
      in: path
      required: true
      description: Identificador único do webhook (UUID) retornado no cadastro
      schema:
        type: string
        format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
  schemas:
    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.