Webhooks

O Routal utiliza webhooks para notificar a sua aplicação sempre que ocorre um evento na sua conta. Configure webhooks para eventos sobre os quais o Routal já o notifica, como quando o estado de um plano muda, quando é criado um novo percurso ou quando os seus veículos fazem uma paragem.

Um ponto de extremidade de webhook é como um número de telefone para o qual o Routal liga quando ocorrem determinados eventos na sua conta. O Routal cria um objeto de evento para cada incidente na sua conta que mereça ser notificado, como a criação de um novo cliente na sua conta Routal ou um pagamento na sua conta bancária. Cada evento contém dados que explicam o que aconteceu.

Quando cria um manipulador de webhook, este fica à escuta de eventos específicos e, em seguida, actua sempre que esses eventos são enviados para o ponto final. Tecnicamente, um manipulador de webhook é apenas um script em uma linguagem do lado do servidor, como Ruby ou PHP, que manipula qualquer evento que você especificar no Painel. Veja todos os tipos de eventos.

Dica: Os pontos de extremidade do webhook devem ser configurados para receber apenas os tipos de eventos exigidos pela sua integração. A escuta de eventos adicionais (ou de todos os eventos) sobrecarregará o seu servidor e não é recomendada.

Os webhooks também podem ser usados para fornecer status e respostas de API a serviços ou sistemas que usam dados do Planner para coisas como replicação, análise ou alerta.

Os Webhooks são necessários para acções activas do utilizador executadas na aplicação Web ou para eventos provenientes de fontes externas, como o seguimento da posição do veículo.

Alguns pedidos rotineiros (por exemplo, a alteração do estado de um plano) geram resultados que a Planner comunica de forma síncrona ao seu código. Estas integrações não requerem a sua verificação, mas os eventos permitem-lhe partilhar informações com outros sistemas. Também pode utilizar webhooks nestas integrações síncronas para automatizar tarefas comerciais: