Configurar Webhooks
Last updated
Last updated
Gran parte de los recursos son accedidos por medio de webhooks. Por lo que en esta sección te mostraremos como configurar los endpoints para recibir eventos configurables y obtener así los datos correspondiente.
Para poder configurar los webhooks, debes primero estar loggeado en Persat, luego dirigirte a la esquina superior derecha de la pantalla principal, y presionar la opción "Integraciones y Partners" en la configuración de usuario.
Una vez dentro de la sección, presioná dentro del recuadro de la izquierda "Integra con nuestra API".
Seleccioná la opción Webhooks, y luego Administrar webhooks
Arriba a la derecha, podemos crear un nuevo endpoint con el boton "+ Add Endpoint"
Completá los datos de tus endpoints, recordá seleccionar cuales eventos van a ser escuchados por el mismo. Podés seleccionar uno, o varios. En caso de no seleccionar ninguno, se toma por defecto que se quiere escuchar a todos los eventos disponibles.
Hay 15 eventos disponibles
client.created Se genera, tanto cuando se crea un cliente de forma manual, como así también cuando se importa un listado de clientes desde un archivo .csv
client.updated Se genera, tanto cuando se modifica un cliente particular, como así también cuando se realiza una modificación masiva desde un archivo .csv
client.deleted Se genera cuando se elimina un cliente
delivery.created Se genera, tanto cuando se crea una nueva entrega de forma manual, como así también cuando se importa un listado de entregas desde un archivo excel
delivery.deleted Se genera tanto cuando se elimina una entrega particular, como cuando se eliminan varias entregas al mismo tiempo (operaciones masivas), asi como también si se elimina una entrega desde el endpoint correspondiente de la API
deliveryRoute.assigned: Se genera cuando se asigna una ruta a un dispositivo. IMPORTANTE: Solo funciona en el módulo de entregas.
deliveryRoute.updated: Se genera cuando se modifique la ruta asignada, existen varios casos que pueden disparar este evento. Están definidos acá.
deliveryRoute.canceled: Se genera cuando el usuario administrador o quien tenga permisos suficientes cancela una Ruta ya asignada.
delivery.finished Se genera tanto cuando se finaliza una entrega desde el celular, como cuando se finaliza desde la web por el administrador o quien tenga el permiso correspondiente.
digitalform.created Se genera cuando se inserta un nuevo formulario. Esto puede realizarse tanto desde la web como desde la app de Android.
digitalform.updated Se genera cuando se modifica un formulario existente. Esto puede realizarse tanto desde la web como desde la app de Android.
digitalform.state_updated Se genera cuando el administrador o el usuario que posea permisos necesarios, modifique el estado de un formulario. Esta operación se realiza siempre desde la web.
digitalform.state_updated_massively Se genera cuando el administrador o el usuario que posea permisos necesarios, modifique el estado de formulario de forma masiva(el estado al que cambian es el mismo para todos). Esta operación se realiza siempre desde la web.
workorder.created Se genera cuando crea una OT en Persat. Esta operación se realiza siempre desde la web.
workorder.updated Se genera cuando la OT es modificada. Por ejemplo cuando se modifica el formulario de instrucciones, o se modifica la fecha y el horario de asignación. IMPORTANTE: No se dispara cuando la OT es finalizada o cerrada,
workorder.finished Se genera cuando el técnico da por finalizada la Orden de trabajo desde la app de Android.
workorder.closed Se genera cuando el administrador o el usuario que posea permisos necesarios, de por cerrada una orden de trabajo. Esta operación se realiza siempre desde la web.
Listo, ya tenemos creados el/los webhooks necesarios para escuchar los eventos.
