Webhooks

Los webhooks te permiten suscribirte a los eventos que Shippify genera cada vez que se modifica una entrega o una ruta. Cuando se active uno de esos eventos, enviaremos una petición HTTP POST a la URL configurada del webhook.

Configuración de Webhooks

Declarar un Webhook

En tu cuenta de Shippify, ve al menú de la izquierda, elige la sección de Automatizaciones, busca Enviar Webhook en el menú lateral izquierdo y pulsa el botón CREAR AUTOMATIZACIÓN +.

Automatización de Webhook

Elige las reglas para la ejecución de tu automatización. Tienes que elegir el ámbito en el que funcionará la automatización, el evento que activará la automatización y condiciones adicionales si lo necesitas.

Creando una nueva automatización de webhook

Define los parámetros que necesitas para tu Automatización de Webhook.

Parámetro	Descripción	Obligatorio	Payload Key
Webhook	URL a la que se enviará el payload del evento.
Método HTTP	Método de solicitud HTTP para enviar el payload.
Prueba de entrega	En caso de que el evento tenga imágenes adjuntas, elige si deseas añadirlas en tu payload.		images (Array[])
HTTP Headers	Headers personalizados para la solicitud HTTP.
Firma del destinatario	Adjunte la firma del destinatario como imagen png con fondo transparente.		signature (String)
Formato Base64	Las imágenes de la prueba de entrega o firma se envían en formato base64. (Si no se marca, entonces es una url)		images/signature (base64 Array[]/String)
URL de seguimiento	Incluye URL privada de seguimiento de la entrega.		trackingUrl (String)

Parámetros de una automatización de webhook

En esta sección puedes gestionar las URL que declaras para cada uno de los eventos a los que quieres suscribirte. También puedes probar tus webhooks en esta sección y recibirás un payload de muestra.

Eventos de Webhook disponibles

Specification of events available for webhooks:

Nombre	Descripción
Delivery is created	Se activa cada vez que se crea una nueva entrega.
Delivery is in transit	Se activa cuando una entrega ha sido recogida y está en tránsito.
Delivery completed	Se activa cuando se ha completado una entrega.
Delivery returned	Se dispara cuando una entrega ha sido devuelta al almacén.
Delivery canceled	Se activa cuando un operador cancela una entrega.
Deliver Hold By Courier	Se dispara cuando una entrega está siendo resguardada por el conductor por razones como que el paquete no pudo ser entregado. En este caso, encontrarás el motivo en las notas del parámetro.

Eventos del Payload

Cuando se realiza uno de los eventos listados anteriormente, el webhook se ejecuta y envía el siguiente payload:

Entrega creada con éxito

Parámetro	Valor
Webhook	www.webhooktest.com
Método HTTP	POST

{
   "id":"t-xyz-123",
   "routeId": null,
   "networkId": 225,
   "networkName": "Default-company test",
   "jobId": null,
   "blocked": false,
   "cityId": 2,
   "cityName": "Guayaquil",
   "cityLang": "es",
   "companyId": 1,
   "companyName": "Shippify Inc.",
   "companyPlanType": "postpaid",
   "companyParentId": 1,
   "companyMode": 0,
   "shipperId": null,
   "type": "flex",
   "vehicleCapacity": 2,
   "price": 2.75,
   "scheduledStartPickingDate": "2021-06-23T18:00:00.000Z",
   "scheduledEndPickingDate": "2021-06-23T19:00:00.000Z",
   "arrivalPickupDate": null,
   "scheduledStartDeliveryDate": "2021-06-23T19:00:00.000Z",
   "scheduledEndDeliveryDate": "2021-06-24T00:00:00.000Z",
   "arrivalDeliveryDate": null,
   "creationDate": "2021-06-22T20:51:27.000Z",
   "pickupDueDate": null,
   "deliveryDueDate": null,
   "pickingPlace":{
      "lat": -2.1594806,
      "lng": -79.895742599,
      "originalAddress": "torres del norte, av. 9, guayaquil 090512, ecuador",
      "address": "torres del norte, av. 9, guayaquil 090512, ecuador"
   },
   "droppingPlace":{
      "lat": -2.1693477,
      "lng": -79.8985397,
      "originalAddress": "san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador",
      "address": "san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador"
   },
   "recipientInfo":{
      "name": "Test recipient",
      "email": "[e-mail]"
   },
   "senderInfo":{
      "name": "Test sender",
      "email": "[e-mail]"
   },
   "state": 1,
   "tags": null,
   "items":[
      {
         "name": "1",
         "qty": 1,
         "size": "S",
         "price": 0,
         "weight": 0,
         "fragile": false,
         "pickedUp": false,
         "delivered": false
      }
   ],
   "referenceId": "referenceId",
   "notes": null,
   "attempts": 0,
   "countryCode": "EC",
   "countryName": "ECUADOR",
   "currencyCode": "USD",
   "formulaId": "815",
   "cash": 0,
   "distance": 1.7999999523162842,
   "distanceRoute": 1.7999999523162842,
   "eventEntity": "delivery",
   "eventDate": "2021-06-22T20:51:27+00:00",
   "itemsNumber": 1,
   "itemsWeight": 0,
   "itemsPrice": 0,
   "dbId": 214280954,
   "eventType": "DELIVERY_CREATED_SUCCESSFULLY",
   "eventCreatedAt": "2021-06-22 20:51:27",
   "eventDescription": "Delivery was created successfully",
   "status": "processing",
   "eventId": 1624395087667
}

Entrega resguardad por el conductor

Parémetro	Valor
Webhook	www.webhooktest.com
Método HTTP	POST
URL de seguimiento	✅

{
  "id": "t-xyz-123",
  "routeId": null,
  "networkId": 25,
  "networkName": "Default-company test",
  "jobId": null,
  "blocked": false,
  "cityId": 2,
  "cityName": "Guayaquil",
  "cityLang": "es",
  "companyId": 1,
  "companyName": "company test",
  "companyPlanType": "postpaid",
  "companyParentId": 1,
  "companyMode": 1,
  "shipperId": null,
  "shipperMobile": null,
  "type": "slot",
  "vehicleCapacity": 3,
  "vehicleId": null,
  "price": 0,
  "insurance": 0,
  "scheduledStartPickingDate": "2024-01-08T17:27:20.000Z",
  "scheduledEndPickingDate": "2024-01-08T17:57:20.000Z",
  "effectivePickupDate": "2024-01-08T16:33:44.000Z",
  "arrivalPickupDate": null,
  "scheduledStartDeliveryDate": "2024-01-08T18:12:20.000Z",
  "scheduledEndDeliveryDate": "2024-01-08T18:42:20.000Z",
  "effectiveDeliveryDate": "2024-01-08T17:27:07.000Z",
  "arrivalDeliveryDate": null,
  "creationDate": "2024-01-08T16:27:21.000Z",
  "pickupDueDate": null,
  "deliveryDueDate": null,
  "pickingPlace":{
      "lat": -2.1594806,
      "lng": -79.895742599,
      "originalAddress": "torres del norte, av. 9, guayaquil 090512, ecuador",
      "address": "torres del norte, av. 9, guayaquil 090512, ecuador"
   },
   "droppingPlace":{
      "lat": -2.1693477,
      "lng": -79.8985397,
      "originalAddress": "san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador",
      "address": "san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador"
   },
   "recipientInfo":{
      "name": "Test recipient",
      "email": "[e-mail]"
   },
   "senderInfo":{
      "name": "Test sender",
      "email": "[e-mail]"
   },
  "senderInfoDecoded": {
    "name": "Test",
    "email": "[e-mail]",
    "phonenumber": "11111111"
  },
  "receiverInfoDecoded": {
    "name": "Siham",
    "email": "",
    "phonenumber": ""
  },
  "state": 6,
  "tags": null,
  "items": [
    {
      "id": "",
      "uuid": "bb3ef06e-647d-412b-92d1-293de6f5ce76",
      "name": "caixa",
      "size": "S",
      "price": 0,
      "weight": 0,
      "pickedUp": true,
      "delivered": true,
      "sid": "t-shippify2-40254_3",
      "scanned": false,
      "qty": 62
    }
  ],
  "referenceId": "test1234",
  "notes": "{\"reason\":\"ADDRESS NOT FOUND, NEED CHANGE\",\"reasonId\":11,\"comment\":\"test\"}",
  "notesJson": {
    "reason": "ADDRESS NOT FOUND, NEED CHANGE",
    "reasonId": 11,
    "comment": "test"
  },
  "attempts": 1,
  "countryCode": "EC",
  "countryName": "ECUADOR",
  "currencyCode": "USD",
  "formulaId": "1234",
  "cash": 0,
  "distance": 305.6000061035156,
  "distanceRoute": 0,
  "distanceCharged": 0,
  "totalPackagePrice": 0,
  "eventEntity": "delivery",
  "eventDate": "2024-01-08T20:38:55+00:00",
  "lastEventParams": {
    "author": {
      "type": "client",
      "id": 1234,
      "name": "Client Name",
      "email": "[e-mail]"
    },
    "method": "UPDATE_ROUTE_STATUS",
    "timestamp": 1704746335
  },
  "colleted": 0,
  "paid": 0,
  "statusUpdateDate": null,
  "partial": 0,
  "itemsNumber": 62,
  "itemsWeight": 0,
  "itemsPrice": 0,
  "references": [],
  "incidences": [],
  "cityDepartment": null,
  "metadata": {
    "previousStatus": "processing"
  },
  "previousStatus": "processing",
  "dbId": 948182101,
  "eventType": "DELIVERY_HOLD_BY_COURIER",
  "eventAuthor": {
    "type": "client",
    "id": 1234,
    "name": "Client Name",
    "email": "[e-mail]"
  },
  "eventCreatedAt": "2024-01-08 20:38:55",
  "eventDescription": "Delivery is hold by courier (previous status was completed)",
  "eventParams": "{\"method\":\"UPDATE_ROUTE_STATUS\"}",
  "status": "hold_by_courier",
  "eventId": 1704746335377,
  "trackingUrl": "https://api.shippify.co/track/t-xyz-123?token={token}"
}

Entrega completada

Parámetro	Valor
Webhook	www.webhooktest.com
Método HTTP	POST
Prueba de entrega	✅
Firma del destinatario	✅

{
    "id": "t-xyz-123",
    "routeId": null,
    "networkId": 25,
    "networkName": "Default-company test",
    "jobId": null,
    "blocked": false,
    "cityId": 2,
    "cityName": "Guayaquil",
    "cityLang": "es",
    "companyId": 1,
    "companyName": "company test",
    "companyPlanType": "postpaid",
    "companyParentId": 1,
    "companyMode": 1,
    "shipperId": null,
    "shipperMobile": null,
    "type": "slot",
    "vehicleCapacity": 3,
    "vehicleId": null,
    "price": 0,
    "insurance": 0,
    "scheduledStartPickingDate": "2024-01-08T17:27:20.000Z",
    "scheduledEndPickingDate": "2024-01-08T17:57:20.000Z",
    "effectivePickupDate": "2024-01-08T16:33:44.000Z",
    "arrivalPickupDate": null,
    "scheduledStartDeliveryDate": "2024-01-08T18:12:20.000Z",
    "scheduledEndDeliveryDate": "2024-01-08T18:42:20.000Z",
    "effectiveDeliveryDate": "2024-01-08T17:27:07.000Z",
    "arrivalDeliveryDate": null,
    "creationDate": "2024-01-08T16:27:21.000Z",
    "pickupDueDate": null,
    "deliveryDueDate": null,
    "pickingPlace":{
      "lat": -2.1594806,
      "lng": -79.895742599,
      "originalAddress": "torres del norte, av. 9, guayaquil 090512, ecuador",
      "address": "torres del norte, av. 9, guayaquil 090512, ecuador"
    },
    "droppingPlace":{
      "lat": -2.1693477,
      "lng": -79.8985397,
      "originalAddress": "san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador",
      "address": "san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador"
    },
    "recipientInfo":{
      "name": "Test recipient",
      "email": "[e-mail]"
    },
    "senderInfo":{
      "name": "Test sender",
      "email": "[e-mail]"
    },
    "senderInfoDecoded": {
        "name": "Test sender",
        "email": "[e-mail]"
    },
    "receiverInfoDecoded": {
        "name": "Test recipient",
        "email": "[e-mail]"
    },
    "state": 7,
    "tags": null,
    "items": [
        {
            "id": "",
            "uuid": "bb3ef06e-647d-412b-92d1-293de6f5ce76",
            "name": "caixa",
            "size": "S",
            "price": 0,
            "weight": 0,
            "pickedUp": true,
            "delivered": true,
            "sid": "t-shippify2-40254_3",
            "scanned": false,
            "qty": 62
        }
    ],
    "referenceId": "test1234",
    "notes": "{\"comment\":\"test\"}",
    "attempts": 0,
    "countryCode": "EC",
    "countryName": "ECUADOR",
    "currencyCode": "USD",
    "formulaId": "1234",
    "cash": 0,
    "distance": 305.6000061035156,
    "distanceRoute": 0,
    "distanceCharged": 0,
    "totalPackagePrice": 0,
    "eventEntity": "delivery",
    "eventDate": "2024-01-08T17:27:08+00:00",
    "lastEventParams": {
        "author": {
            "type": "client",
            "id": 2534,
            "name": "Denny K. Saas",
            "email": "[e-mail]"
        },
        "method": "UPDATE_ROUTE_STATUS",
        "timestamp": 1704734827
    },
    "colleted": 0,
    "paid": 0,
    "statusUpdateDate": null,
    "partial": 0,
    "notesJson": {
        "comment": "test"
    },
    "itemsNumber": 62,
    "itemsWeight": 0,
    "itemsPrice": 0,
    "references": [],
    "incidences": [],
    "cityDepartment": null,
    "metadata": {
        "previousStatus": "processing"
    },
    "previousStatus": "processing",
    "dbId": 948182094,
    "eventType": "DELIVERY_COMPLETED",
    "eventAuthor": {
        "type": "client",
        "id": 2534,
        "name": "Denny K. Saas",
        "email": "[e-mail]"
    },
    "eventCreatedAt": "2024-01-08 17:27:07",
    "eventDescription": "Delivery was completed (previous status was processing)",
    "eventParams": "{\"method\":\"UPDATE_ROUTE_STATUS\"}",
    "status": "completed",
    "eventId": 1704734828038,
    "images": ["https://cdn.dev.shippify.co/delivery-files/77030821377477563003dde3ce5.jpg"],
    "signature": "https://cdn.dev.shippify.co/delivery-files/16839098636794LPh1Zd7S5Goc9BvmQyG7BpT6asb.png"
}