Skip to main content
POST
Cadastrar um webhook
Cadastra uma configuração de webhook para o parceiro identificado automaticamente pelo token de acesso.
A url precisa ser HTTPS e pública, com até 2048 caracteres: sem localhost, IP privado, usuário/senha ou #fragmento. Caso contrário, a API retorna 422 com Organization.Webhook.InvalidEndpoint. Uma URL malformada (não absoluta) retorna 400 com Validation.Url.Invalid.

Tipos de webhook

Os tipos Cliente (1) e Simulação (2) podem ser configurados, mas não enviam notificações. Atualmente, apenas o tipo Proposta (3) está disponível.

Tipos de autenticação

A credencial é obrigatória para Basic e JWT, com até 2048 caracteres. Com tipo_autenticacao = 1, ela é ignorada. O tipo de autenticação e a credencial não podem ser alterados depois do cadastro. É permitido mais de um webhook por tipo.

Segredo de assinatura

A resposta traz segredo_assinatura, usado para verificar a autenticidade das notificações recebidas. Ele é exibido apenas nesta resposta — guarde-o com segurança, pois não é possível consultá-lo novamente. Consulte Verificação e segurança.

Authorizations

Authorization
string
header
required

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

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"

tipo_autenticacao
integer<int32>
required

Autenticação enviada pela Credicarro ao chamar a URL. Não pode ser alterada depois da criação. Valores aceitos:

  • 1 = None (sem autenticação)
  • 2 = Basic
  • 3 = Jwt
Example:

2

credencial
string

Credencial enviada no header Authorization. Obrigatória para Basic (valor em Base64 de usuario:senha, enviado como Basic {credencial}) e Jwt (token enviado como Bearer {credencial}).

Example:

"dXN1YXJpbzpzZW5oYQ=="

Response

Webhook cadastrado com sucesso

id_webhook
string<uuid>

Identificador único do webhook

Example:

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

segredo_assinatura
string

Segredo usado para validar a assinatura X-CrediCarro-Signature. Retornado somente nesta resposta.

Example:

"<segredo-de-assinatura>"