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"
}

En ruta al Centro de Distribución

IN_TRANSIT_TO_WAREHOUSE

Evento disparado cuando el paquete va en camino al Centro de Distribución.

Recuerda que la petición realizada en tu webhook, debe responder con un Http status 200. Así evitas que otros que no seamos nosotros inyecten maliciosamente información en tu sistema.

Payload del evento:

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

Recibido en el Centro de Distribución

RECEIVED_AT_WAREHOUSE

Evento disparado cuando el paquete es recibido en el Centro de Distribución.

Recuerda que la petición realizada en tu webhook, debe responder con un Http status 200. Así evitas que otros que no seamos nosotros inyecten maliciosamente información en tu sistema.

Payload del evento:

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

Recogido en el Centro de Distribución

PICKED_AT_WAREHOUSE

Evento disparado cuando el paquete es recogido en el Centro de Distribución.

Recuerda que la petición realizada en tu webhook, debe responder con un Http status 200. Así evitas que otros que no seamos nosotros inyecten maliciosamente información en tu sistema.

Payload del evento:

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

En camino al destinatario

ON_ROUTE_TO_ADDRESSEE

Evento disparado cuando el paquete esta en camino al destinatario.

Recuerda que la petición realizada en tu webhook, debe responder con un Http status 200. Así evitas que otros que no seamos nosotros inyecten maliciosamente información en tu sistema.

Payload del evento:

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

Pedido actual

CURRENT_DELIVERY

Evento disparado cuando el paquete esta en el tramo final de entrega.

Recuerda que la petición realizada en tu webhook, debe responder con un Http status 200. Así evitas que otros que no seamos nosotros inyecten maliciosamente información en tu sistema.

Payload del evento:

{
  "_id": "PH173092898CL",
  "packageId": "63d5bcd2dd2ff604b23b4f5f",
  "notificationId": "63d81657ae5b3f5c1fae0988",
  "event": "CURRENT_DELIVERY",
  "when": "2023-02-01T16:14:58.403Z",
  "trackingCode": "PH173092898CL",
  "trackingURL": "https://portal.phero.app/tracking/PH173092898CL",
  "externalId": "123321",
  "notifiedAt": "2023-02-01T16:15:00.361Z"
}

Entregado

DELIVERED

Evento disparado cuando el paquete ha sido entregado de manera exitosa al destinatario.

Recuerda que la petición realizada en tu webhook, debe responder con un Http status 200. Así evitas que otros que no seamos nosotros inyecten maliciosamente información en tu sistema.

Payload del evento:

{
  "_id": "PH173092898CL",
  "packageId": "63d5bcd2dd2ff604b23b4f5f",
  "notificationId": "63d81657ae5b3f5c1fae0988",
  "event": "DELIVERED",
  "when": "2023-02-01T16:14:58.403Z",
  "trackingCode": "PH173092898CL",
  "trackingURL": "https://portal.phero.app/tracking/PH173092898CL",
  "externalId": "123321",
  "notifiedAt": "2023-02-01T16:15:00.361Z",
  "extra": {
    "imageURL": "https://phero-core-bucket.s3.amazonaws.com/21b1bf13-bbb9-4fb5-b898-b8ea17eb3596_imagePOD.jpg",
    "signatureURL": "https://phero-core-bucket.s3.amazonaws.com/661b0adb-f26b-4db4-abe7-ed669588108f_imagePOD.jpg",
    "files": [
        {
           "type": "RUT",
           "name": "Documento de quien recibe",
           "evidence": "92711347-3"
        }
    ]    
  }
}

Programado al día siguiente

ADDED_TO_QUEUE

Evento disparado cuando el paquete no ha sido entregado durante el turno actual, quedando de esta manera programado para el siguiente día hábil.

Recuerda que la petición realizada en tu webhook, debe responder con un Http status 200. Así evitas que otros que no seamos nosotros inyecten maliciosamente información en tu sistema.

Payload del evento:

{
  "_id": "PH173092898CL",
  "packageId": "63d5bcd2dd2ff604b23b4f5f",
  "notificationId": "63d81657ae5b3f5c1fae0988",
  "event": "ADDED_TO_QUEUE",
  "when": "2023-02-01T16:14:58.403Z",
  "trackingCode": "PH173092898CL",
  "trackingURL": "https://portal.phero.app/tracking/PH173092898CL",
  "externalId": "123321",
  "notifiedAt": "2023-02-01T16:15:00.361Z"
}

Devuelto al remitente

RETURNED

Evento disparado cuando el paquete no pudo ser entregado por algún motivo (ej: Dirección incompleta o incorrecta, Destinatario ausente, entre otros.), retornando al remitente.

Payload del evento:

{
  "_id": "PH173092898CL",
  "packageId": "63d5bcd2dd2ff604b23b4f5f",
  "notificationId": "63d81657ae5b3f5c1fae0988",
  "event": "RETURNED",
  "when": "2023-02-01T16:14:58.403Z",
  "trackingCode": "PH173092898CL",
  "trackingURL": "https://portal.phero.app/tracking/PH173092898CL",
  "externalId": "123321",
  "notifiedAt": "2023-02-01T16:15:00.361Z"
}

Abandonado

ABANDONED

Evento disparado cuando el paquete no fue recogido en la ruta que tenía asignado por un cambio sobre la marcha (el cliente canceló la compra durante el viaje o el conductor no se llevó el paquete).

Payload del evento:

{
  "_id": "PH173092898CL",
  "packageId": "63d5bcd2dd2ff604b23b4f5f",
  "notificationId": "63d81657ae5b3f5c1fae0988",
  "event": "ABANDONED",
  "when": "2023-02-01T16:14:58.403Z",
  "trackingCode": "PH173092898CL",
  "trackingURL": "https://portal.phero.app/tracking/PH173092898CL",
  "externalId": "123321",
  "notifiedAt": "2023-02-01T16:18:34.361Z"
}

Fallido

FAILED

Evento disparado cuando no se pudo concretar la entrega.

Payload del evento:

{
  "_id": "PH173092898CL",
  "packageId": "63d5bcd2dd2ff604b23b4f5f",
  "notificationId": "63d81657ae5b3f5c1fae0988",
  "event": "FAILED",
  "when": "2023-02-01T16:14:58.403Z",
  "trackingCode": "PH173092898CL",
  "trackingURL": "https://portal.phero.app/tracking/PH173092898CL",
  "externalId": "123321",
  "notifiedAt": "2023-02-01T16:18:34.361Z"
  "extra": {
    "reason": "Destinatario Ausente"
  }
}