Webhooks

La API de La Gruva permite recibir eventos en tiempo real mediante webhooks.

Al momento de crear la aplicación de integración se deberá configurar una webhookUrl. Sobre esta URL La Gruva enviará notificaciones HTTP POST con los distintos eventos del servicio.

Todos los webhooks se envían en formato JSON.

Estructura

Todos los eventos enviarán un payload con un atributo action indicando el tipo de evento.

Ejemplo:

{
  "action": "estimate_payment_created"
}

Pago Acreditado

Este evento se envía cuando el pago del servicio fue acreditado correctamente en una estimacion.

Payload

{
  "action": "estimate_payment_created"
  "data": {
    "orderId": 1
    "estimateId": 1
  }
}

Socio Asignado

Este evento se envía cuando un socio/gruero fue asignado al servicio.

Payload

{
  "action": "order_partner_assigned",
  "data": {
    "orderId": 1
  }
}

Servicio Finalizado

Este evento se envía cuando el servicio fue completado exitosamente.

Payload

{
  "action": "order_finished",
  "data": {
    "orderId": 1
  }
}

Servicio Cancelado

Este evento se envía cuando el servicio fue cancelado.

Payload

{
  "action": "order_cancelled",
  "data": {
    "orderId": 1
  }
}