Webhooks

Phero te enviara notificaciones automáticas cuando cambie el estado de tu carga.

Registra la URL del Webhook

Si ya registraste la URL de tu webhook, la aplicación te notificará los eventos a través de una solicitud POST y cada vez que reciba una petición, deberás responder con un HTTP STATUS 200. De esta forma sabemos que recibiste correctamente el evento.

Eventos disponibles

A continuación lista de notificaciones disponibles en los siguientes eventos:

Pendiente (PENDING)
Asignado (ASSIGNED)
Cancelado (CANCELLED)
En camino al ecommerce (ON_ROUTE_TO_ECOMMERCE)
Recogido en el remitente (PICKED_AT_SENDER)
En ruta al Centro de Distribución ( IN_TRANSIT_TO_WAREHOUSE )
Recibido en el Centro de Distribución ( RECEIVED_AT_WAREHOUSE )
Recogido en el Centro de Distribución ( PICKED_AT_WAREHOUSE )
En camino al destinatario ( ON_ROUTE_TO_ADDRESSEE )
Pedido actual ( CURRENT_DELIVERY )
Entregado ( DELIVERED )
Programado al día siguiente ( ADD_TO_QUEUE )
Devuelto al remitente ( RETURNED )
Paquete abandonado ( ABANDONED )
Entrega fallida ( FAILED )

Pendiente

`PENDING`

Evento disparado cuando un paquete es generado en nuestro sistema.

Payload del evento:

{
  "_id": "PH173092898CL",
  "packageId": "63d5bcd2dd2ff604b23b4f5f",
  "notificationId": "63d81657ae5b3f5c1fae0988",
  "event": "PENDING",
  "when": "2023-01-29T21:38:00.693Z",
  "trackingCode": "PH173092898CL",
  "trackingURL": "https://portal.phero.app/tracking/PH173092898CL",
  "externalId": "123321",
  "notifiedAt": "2023-01-30T19:11:19.966Z"
}

Asignado

`ASSIGNED`

Evento disparado cuando el paquete es asignado a un conductor para ser recogido.

Payload del evento:

{
  "_id": "PH173092898CL",
  "packageId": "63d5bcd2dd2ff604b23b4f5f",
  "notificationId": "63d81657ae5b3f5c1fae0988",
  "event": "ASSIGNED",
  "when": "2023-02-01T15:51:51.210Z",
  "trackingCode": "PH173092898CL",
  "trackingURL": "https://portal.phero.app/tracking/PH173092898CL",
  "externalId": "123321",
  "notifiedAt": "2023-02-01T15:51:53.183Z"
}

Cancelado

`CANCELLED`

Evento disparado cuando el paquete es cancelado antes de ser recogido.

Payload del evento:

{
  "_id": "PH173092898CL",
  "packageId": "63d5bcd2dd2ff604b23b4f5f",
  "notificationId": "63d81657ae5b3f5c1fae0988",
  "event": "CANCELLED",
  "when": "2023-02-01T15:51:51.210Z",
  "trackingCode": "PH173092898CL",
  "trackingURL": "https://portal.phero.app/tracking/PH173092898CL",
  "externalId": "123321",
  "notifiedAt": "2023-02-01T15:51:53.183Z"
}

En camino al ecommerce

`ON_ROUTE_TO_ECOMMERCE`

Evento disparado cuando el conductor va en camino a la bodega de origen (ecommerce).

Payload del evento:

{
  "_id": "PH173092898CL",
  "packageId": "63d5bcd2dd2ff604b23b4f5f",
  "notificationId": "63d81657ae5b3f5c1fae0988",
  "event": "ON_ROUTE_TO_ECOMMERCE",
  "when": "2023-02-01T15:51:51.210Z",
  "trackingCode": "PH173092898CL",
  "trackingURL": "https://portal.phero.app/tracking/PH173092898CL",
  "externalId": "123321",
  "notifiedAt": "2023-02-01T15:52:03.183Z"
}

Recogido en el ecommerce

`PICKED_AT_SENDER`

Evento disparado cuando el paquete es recogido en el remitente pero aún no sale a ruta.

Payload del evento:

{
  "_id": "PH173092898CL",
  "packageId": "63d5bcd2dd2ff604b23b4f5f",
  "notificationId": "63d81657ae5b3f5c1fae0988",
  "event": "PICKED_AT_SENDER",
  "when": "2023-02-01T15:52:39.073Z",
  "trackingCode": "PH173092898CL",
  "trackingURL": "https://portal.phero.app/tracking/PH173092898CL",
  "externalId": "123321",
  "notifiedAt": "2023-02-01T15:52:41.047Z"
}