Skip to main content
PUT
Editar um webhook
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.
A autenticação (tipo e credencial) não pode ser alterada. Para trocá-la, exclua o webhook e cadastre outro.

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Path Parameters

webhookId
string<uuid>
required

Identificador único do webhook (UUID) retornado no cadastro

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Body

application/json
tipo
integer<int32>
required

Evento notificado pelo webhook. Valores aceitos:

  • 1 = Customer
  • 2 = Simulation
  • 3 = Proposal
Example:

3

url
string
required

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
integer<int32>

Status do webhook. Quando omitido, mantém o status atual. Valores aceitos:

  • 1 = Active
  • 2 = Inactive
Example:

1

Response

Webhook atualizado com sucesso. A resposta não tem corpo.

Resposta sem corpo