[Webhooks] Cómo usar los webhooks de la API de Optiroute

Webhooks


Los webhooks de Optiroute permiten notificar a tu plataforma cada evento que se realice en tu cuenta. Cada vez que ocurra el evento se enviará un evento POST a la URL que hayas configurado en tu cuenta de Optiroute.


Si un determinado webhook no está disponible cuando el sistema intente enviar la llamada, el pedido será marcado como pendiente y se volverá a llamar cada 5 minutos hasta hacerlo de forma exitosa.


Los webhooks disponibles en Optiroute son los siguientes.


Entidad

Descripción

Pedidos

Cada vez que el estado de un pedido sea actualizado

Conductores

Cada vez que la información de un pedido es actualizada en el sistema

Rutas

Cada vez que se efectúa un cambio en en las rutas realizadas


Los webhook configurados en el sistema no requieren seguridad para su acceso ya que solo informan y el id la propiedad reference del item que fue modificado, sin entregar información relevante sobre él. La información completa del item debe ser obtenida a través de la API REST.

Los webhooks harán una llamada de tipo POST con la siguiente información en forma de parámetros de la llamada:


Parámetro

Descripción

Requerido

id

Identificador del item en Optiroute

Obligatorio

reference

Identificador del item en la plataforma a integrar

Opcional. Sólo si el item tiene definido la referencia externa



Configuración


Para configurar el webhook de pedido debes ingresar a la plataforma de Optiroute e ir a la sección configuración de tu cuenta, en la sección Integración, ahí puedes definir cada una de las URL a los endpoints definidos en la plataforma que deseas integrar.