Pular para o conteúdo principal

Webhooks — Garantia Veicular

Atenção!

Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

Notificações assíncronas enviadas via POST. A requisição deve ser respondida em até 10 segundos com HTTP 200.

Webhook de Status do Pedido

Notifica sobre mudanças de status nas etapas de contrato, gravame e imagem.

Payload
CampoTipoDescrição
transactionIdStringID da transação (36 chars)
statusStringStatus do pedido (ver Mapa de Status)
msgRetornoPlataformaStringMensagem de retorno da plataforma
codigoQiTechStringIdentificador único do pedido
etapaAtualStringEtapa atual (Inclusão de Gravame / Registro do Contrato / Aditivo do Contrato / Imagem de Contrato)
timestampDATETIMEMomento do envio
dataUltimaAtualizacaoDATETIMEData da atualização na plataforma
gravameStringNúmero do gravame ("0" quando não houver)
ufStringUF onde gravame foi criado (2 chars)
chassiStringChassi do veículo
Atenção

O status "Em Processamento" não é enviado via webhook para as etapas Registro do Contrato, Inclusão de Gravame e Aditivo de Contrato.

Configuração

O Webhook de Status requer URLs cadastradas + seleção de etapas/status desejados. Consulte o time de onboarding para configurar.