Webhooks

Los webhooks avisan a su sistema, en tiempo real, cuando algo pasa en la operación: una orden creada, una actividad concluida, un formulario respondido. En lugar de consultar la API de vez en cuando, usted recibe una solicitud POST en la URL que registre.

Eventos

Evento	Cuándo se envía
order-created	Orden de servicio creada
order-updated	Orden de servicio actualizada
order-form-created	Formulario creado en la orden
order-form-updated	Formulario de la orden actualizado
order-attachment-created	Adjunto creado
order-attachment-updated	Adjunto actualizado
order-attachment-deleted	Adjunto eliminado
task-created	Actividad creada
task-updated	Actividad actualizada
task-start-route	El colaborador inició el desplazamiento hacia la actividad
task-route-started	Ruta de la actividad iniciada
task-started	Actividad iniciada por el colaborador
task-completed	Actividad concluida
task-reported	Impedimento registrado en la actividad
task-rated	Actividad evaluada por el cliente
comment-created	Comentario creado
employee-created	Colaborador creado
ticket-created	Solicitud de servicio creada
ticket-accepted	Solicitud de servicio aceptada
ticket-canceled	Solicitud de servicio cancelada
ticket-closed	Solicitud de servicio cerrada
ticket-expired	Solicitud de servicio vencida
ticket-refused	Solicitud de servicio rechazada
quotation-created	Presupuesto creado
quotation-updated	Presupuesto actualizado
quotation-approved	Presupuesto aprobado
quotation-canceled	Presupuesto cancelado
quotation-refused	Presupuesto rechazado
vehicle-created	Vehículo creado
vehicle-updated	Vehículo actualizado

El cuerpo de la solicitud es el recurso del evento, en el mismo formato de la API: en task-created viene una actividad, en comment-created un comentario, y así sucesivamente.

Headers enviados

Header	Contenido
X-FieldControl-Event	Nombre del evento
X-FieldControl-Delivery	Identificador único del envío
X-FieldControl-Account	Identificador de la cuenta
User-Agent	FieldControl-Hookshot/<identificador del envío>
Content-Type	Siempre application/json

Si la URL se registró con autenticación, el envío usa autenticación HTTP Basic con el usuario y la contraseña informados.

Cómo tratar un evento

1. Verifique en X-FieldControl-Delivery si el envío ya fue procesado, para no procesar el mismo evento dos veces.
2. Lea el evento en X-FieldControl-Event.
3. Actualice su sistema con el cuerpo recibido.
4. Responda rápido: Field Control espera la respuesta hasta 15 segundos. Haga el procesamiento pesado después de responder.

Registrar la URL

1. En el Panel del Gestor, abra Configurações > API de integração (Configuración > API de integración) y, en la sección Webhooks da integração (webhooks de integración), haga clic en Novo Webhook (Nuevo webhook).

   

2. Informe la URL y la autenticación (sin autenticación o con usuario y contraseña) y elija si quiere recibir todos los eventos o solo algunos.

   

3. Si eligió los eventos, active los que quiere recibir. Después, haga clic en Criar (Crear).

   

Historial de eventos

El historial de eventos de integración del Panel del Gestor lista cada envío hecho a su URL, con el identificador, el evento y la fecha y hora.

En Ver detalhes (Ver detalles), la pestaña Requisição (Solicitud) muestra los headers y el cuerpo enviados, y la pestaña Resposta (Respuesta) muestra lo que respondió su aplicación.