Um webhook é uma chamada HTTP automática que o SimpliRoute 🚀 envia para o seu sistema quando ocorre um evento específico na plataforma. Eles permitem receber informações em tempo real sem a necessidade de consultar a API constantemente. Para ativá-los, entre em contato com seu agente de conta ou com a equipe de Customer Success.

Eventos disponíveis 📋

O SimpliRoute conta com 9 webhooks configuráveis. Para cada um você pode definir uma URL de destino e headers opcionais para autenticação:

Rota criada: dispara quando uma nova rota é criada em um plano.
Início de rota: dispara quando o condutor pressiona o botão Iniciar rota no app móvel.
Fim de rota: dispara quando o condutor pressiona Finalizar rota no app móvel.
Rota editada: dispara quando são realizadas modificações em uma rota existente.
Criação de plano: dispara quando um novo plano é salvo.
Edição de plano: dispara quando um plano salvo é editado.
A caminho: dispara quando o condutor pressiona o botão Notificar no app móvel para indicar que está a caminho de uma visita.
Check-out: dispara quando o condutor marca uma visita como concluída ou falhada.
Check-out detalhado: igual ao webhook de Check-out, mas inclui informações adicionais de campos personalizados (extrafields).

Funcionamento 🔛

Cada vez que ocorre um dos eventos configurados, o SimpliRoute envia automaticamente uma chamada do tipo POST para o webservice que você definiu, com as informações do evento em formato JSON.

Para ativar um webhook, você deve fornecer à equipe de Suporte ou ao seu Customer Success os seguintes dados:

URL: endpoint do seu webservice que receberá a chamada. Seu sistema deve estar preparado para processar chamadas POST em formato JSON.
Headers (opcional): parâmetros adicionais exigidos pelo seu sistema, como tokens de autenticação. Devem estar em formato JSON. Exemplo: {"Content-Type": "application/json", "Api-Key": "Token <seu_token>"}

Payload

Webhook de Check-out

Quando ocorre um check-out, o SimpliRoute envia as seguintes informações da visita.

Exemplo de payload:

JSON

{
   "id": 18843965,
   "load": 0.0,
   "load_2": 0.0,
   "load_3": 0.0,
   "window_start": "09:00:00",
   "window_end": "19:00:00",
   "window_start_2": "23:59:00",
   "window_end_2": "23:59:00",
   "reference": "",
   "planned_date": "2019-09-09",
   "order": 4,
   "checkout_comment": "Test",
   "duration": "0:20:00",
   "calculated_service_time": "0:00:00",
   "title": "INDUSTRIAS RICÓN",
   "contact_name": "Victor Gonzalez",
   "contact_email": "",
   "contact_phone": "978567812",
   "notes": "",
   "latitude": "-33.439046",
   "longitude": "-70.648752",
   "status": "completed",
   "address": "HUERFANOS 835 OF. 202, SANTIAGO, Santiago",
   "account": "[email protected]",
   "route": "2019-09-09 - Test",
   "status_changed": "2019-09-09 21:23:01.251595+00:00",
   "priority_level": 0,
   "created": "2019-08-29 22:33:44.015108+00:00",
   "modified": "2019-09-09 21:23:01.251582+00:00",
   "estimated_time_arrival": "10:12:00",
   "estimated_time_departure": "10:32:00",
   "tracking_id": "SR67118024023080",
   "signature": "visit-signatures/2019/09/09/ac6bf49a-35b.png",
   "checkin_time": null,
   "checkin_latitude": null,
   "checkin_longitude": null,
   "checkout_observation": null,
   "checkout_latitude": "-33.420471",
   "checkout_longitude": "-70.603384",
   "checkout_time": "2019-09-09 21:22:56.068000+00:00",
   "on_its_way": null,
   "geocode_alert": null,
   "has_alert": false,
   "priority": false
}

Webhook de Edição de plano

Quando um plano é editado, o SimpliRoute envia as informações completas do plano com suas rotas e visitas.