Novas vistorias
Descrição
Esse webhook será disparado toda vez que uma vistoria for recebida pelo nosso sistema. Ele irá realizar uma operação GET
na URL que está preenchida no campo Webhook (Novas Vistorias).
Como configurar
Acesse a tela de Integração do painel administrativo e insira a URL do Webhook no campo Webhook (Novas Vistorias).
Headers
Você também pode configurar headers para serem enviados no disparo ao Webhook. Para isso:
- Acesse a página de configurações de integração:
- Ative a checkbox “Mostrar configurações avançadas” para exibir a configuração necessária:
- Configure as chaves e valores dos headers na configuração “Webhook (Novas Vistorias): Headers para enviar no disparo do Webhook”:
- Aperte o botão "Salvar" no final da página após configurar as opções desejadas.
Pronto! Agora os headers configurados serão enviados no disparo do webhook 😃
Parâmetros disponíveis para substituição na URL
É possível utilizar parâmetros na URL para receber dados do webhook. Cada parâmetro na URL será substituído com o dado correspondente da vistoria no disparo do webhook.
Os parâmetros disponíveis são:
| Variável | Tipo | Descrição |
|---|---|---|
{id} | int | ID numérico da vistoria |
{vistoriaId} | string | ID da vistoria |
{nomeCliente} | string | Nome do cliente |
Você pode, por exemplo, colocar esses parâmetros no lugar de valores na query string.
Exemplo de url
URL configurada no painel:
https://meu.webhook.com.br/integracao/webhook?nomeCliente={nomeCliente}&vistoriaId={vistoriaId}
URL disparada com os parâmetros substituídos (exemplo):
https://meu.webhook.com.br/integracao/webhook?nomeCliente=David&vistoriaId=ATL124_ABC1C34_25_11_2025_14_57_10_NOVO_VEX
Registro de log
Toda vez que o Webhook (Novas Vistorias) for acionado o sistema registrada um log na vistoria.
Testando Url de integração
O botão Testar conexão permite que seja realizado um teste na sua URL de integração, antes de ter que atualizar o valor no botão Salvar.
Exemplo de resposta
A API do VEX espera como resposta o código de status 200 OK, isso serve para saber se a url de integração
está funcionando adequadamente.
Erro na requisição
Sucesso na requisição
Não há necessidade de corpo na resposta.
Se um corpo for retornado na resposta, esse corpo deve ser um JSON válido e deve conter o header Content-Type: application/json !
Você pode testar se o seu corpo é um JSON válido clicando aqui.
Clique no botão Salvar no final da página para salvar as alterações.