Cadastro de webhooks

Um webhook é uma URL do seu sistema que recebe notificações da Credicarro. Os webhooks são vinculados ao parceiro do token e ao ambiente (staging ou produção) em que foram cadastrados.

Endpoints

Endpoint	Para quê
`POST /v1/webhook`	Cadastrar. Retorna o `segredo_assinatura` — só nesta resposta.
`GET /v1/webhook`	Listar, paginado. Não retorna a credencial nem o segredo.
`PUT /v1/webhook/{webhookId}`	Alterar tipo, URL e status.
`DELETE /v1/webhook/{webhookId}`	Excluir. O webhook deixa de receber notificações.

Tipo (`tipo`)

Código	Tipo	Notificações
1	Customer	⚪ Sem envio no momento
2	Simulation	⚪ Sem envio no momento
3	Proposal	🟢 A cada atualização da proposta

Autenticação (`tipo_autenticacao`)

Código	Tipo	Header enviado
1	None	Nenhum (não recomendado)
2	Basic	`Authorization: Basic {credencial}` — `credencial` em Base64 de `usuario:senha`
3	Jwt	`Authorization: Bearer {credencial}`

O tipo de autenticação e a credencial não podem ser alterados. Para trocá-los, exclua o webhook e cadastre outro.

Status (`status`)

Código	Status	Efeito
1	Active	Recebe notificações.
2	Inactive	Não recebe notificações.

Para pausar um webhook sem perder o cadastro, use PUT /v1/webhook/{webhookId} reenviando o tipo e a url atuais com status = 2.

Objeto webhook

GET /v1/webhook

{
  "itens": [
    {
      "id_webhook": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tipo": "Proposal",
      "url": "https://parceiro.com.br/webhooks/credicarro",
      "tipo_autenticacao": "Basic",
      "status": "Active"
    }
  ],
  "pagina": { "numero": 1, "tamanho": 10, "total": 1, "tem_proximo": false, "tem_anterior": false }
}

Na listagem, tipo, tipo_autenticacao e status vêm como texto. No cadastro e na edição, são enviados como código numérico.

Boas práticas

Um webhook por ambiente

Cadastre um webhook no staging e outro na produção, cada um com o seu segredo.

Mais de um por tipo

É permitido. Cada notificação é enviada para todos os webhooks ativos do tipo.

Valide a assinatura

Toda notificação traz X-CrediCarro-Signature (HMAC-SHA256).

Payload da proposta

Veja o retrato enviado a cada atualização da proposta.

Visão geral

Segurança

Eventos

Webhooks

Cadastro de webhooks

Endpoints

Tipo (`tipo`)

Autenticação (`tipo_autenticacao`)

Status (`status`)

Objeto webhook

Boas práticas

Um webhook por ambiente

Mais de um por tipo

Valide a assinatura

Payload da proposta

​Endpoints

​Tipo (tipo)

​Autenticação (tipo_autenticacao)

​Status (status)

​Objeto webhook

​Boas práticas

Um webhook por ambiente

Mais de um por tipo

Valide a assinatura

Payload da proposta

Endpoints

Tipo (`tipo`)

Autenticação (`tipo_autenticacao`)

Status (`status`)

Objeto webhook

Boas práticas