Gerenciamento pela API
Os webhooks podem ser cadastrados, consultados, editados e excluídos diretamente pela API de integração.
Disponibilidade dos webhooks
Legenda: 🟢 Disponível · ⚪ Sem envio no momentoCliente (1)
⚪ Sem envio no momentoA configuração pode ser cadastrada, mas nenhum evento de cliente é enviado atualmente.
Simulação (2)
⚪ Sem envio no momentoA configuração pode ser cadastrada, mas nenhum evento de simulação é enviado atualmente.
Proposta (3)
🟢 DisponívelEnvia uma notificação a cada atualização da proposta.
Segmentação de webhooks
Ambientes e webhooks
Os webhooks são específicos para cada ambiente:
- Webhooks criados em staging recebem notificações apenas do staging
- Webhooks criados em produção recebem notificações apenas de dados reais
Configurar webhooks
Cadastre, liste, edite e exclua webhooks pelos endpoints do grupo Webhooks, nesta aba. Veja o cadastro de webhooks. É permitido mais de um webhook por tipo; cada notificação é enviada para todos os webhooks ativos do tipo. Se preferir, o nosso atendimento também pode configurar os webhooks pelo e-mail atendimento@credicarro.com.br.Tipos de autenticação
Aceitamos três tipos de autenticação para os webhooks (tipo_autenticacao). O tipo e a credencial não podem ser alterados depois do cadastro; para trocá-los, exclua o webhook e cadastre outro.
1 - Sem autenticação (não recomendado)
As notificações são enviadas para o seu endpoint sem nenhum cabeçalho de autenticação.
2 - Basic
Informe em
credencial o valor em Base64 de usuario:senha. Cada notificação é enviada com o header Authorization: Basic {credencial}.3 - Bearer JWT
Informe em
credencial o token. Cada notificação é enviada com o header Authorization: Bearer {credencial}.Assinatura e retentativas
Além da autenticação, toda notificação é assinada com HMAC-SHA256. Veja como validar a assinatura e como funcionam as retentativas.
Payload
Webhook de proposta
Retrato completo da proposta: status, etapas, biometria e documentos do comprador e da loja.