Skip to main content
Webhooks permitem que sua aplicação receba notificações em tempo real sobre eventos importantes da Credicarro.

Atenção — Webhook disponível

Atualmente, o único webhook disponível é o de atualização de status da Proposta.

Segmentação de webhooks

Ambientes e Webhooks

Os webhooks são específicos para cada ambiente:
  • Webhooks criados em desenvolvimento recebem notificações apenas do ambiente de desenvolvimento
  • Webhooks criados em produção recebem notificações apenas de dados reais
Saiba mais sobre o ambiente de desenvolvimento aqui.

Configurar webhooks

Fale com o atendimento

Para configurar os seus webhooks, entre em contato com o nosso atendimento pelo e-mail [email protected]

Tipos de Autenticação

Aceitamos três tipos de autenticação para os webhooks:

Sem Autenticação (Não recomendado)

Se o seu endpoint não requer autenticação, você pode optar por não usar nenhum método de autenticação. Nesse caso, as notificações serão enviadas para o seu endpoint sem nenhum cabeçalho de autenticação.

Basic

A autenticação Basic é um método de autenticação HTTP simples que envolve o envio de um nome de usuário e senha com cada requisição. Para usar a autenticação Basic, você precisará fornecer um nome de usuário e uma senha ao configurar o webhook.

Bearer JWT

A autenticação Bearer JWT é um método de autenticação que usa um token JSON Web Token (JWT) para autenticar as requisições. Para usar a autenticação Bearer JWT, você precisará fornecer um token JWT válido ao configurar o webhook.

Payload do Webhook

O payload enviado para o endpoint do webhook é um JSON com a seguinte estrutura:
{
  "id_proposta": "00000000-0000-0000-0000-000000000000",
  "enum_status": 0,
  "status": "Analysing",
}

Legenda do EnumStatus

0 - Analysing

A proposta está sendo analisada automaticamente.

1 - Approved

A proposta foi aprovada.

2 - Refused

A proposta foi recusada.

3 - Canceled

A proposta foi cancelada.

4 - ManualAnalysis

A proposta está aguardando análise manual.

5 - Completed

A proposta foi concluída com sucesso.

6 - InNegotiation

A proposta está em negociação.

7 - Expired

A proposta expirou.