Como funciona o webhook da API de Débitos Veiculares?

Ao realizar uma consulta de débito veicular, é necessário ter uma URL registrada para receber notificações do webhook sobre os débitos pendentes do veículo consultado e também os comprovantes de pagamento.

Por isso, o primeiro passo do fluxo de integração inicia-se com o registro dessa URL para o recebimento das notificações.

A request para configuração do webhook deve ser enviada dessa forma:

curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/vehicledebtsapi/v1/webhook/register' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer acess_token' \
--data-raw '{
"url": "https://gatilho.com.br",
"type": "settlement"
}'

Ao concluir a configuração do webhook, sempre que uma consulta for realizada a notificação do webhook será disparada de forma assíncrona um tempo depois.