Webhook Event Types
There are 8 event types in Locate2u :
Event Types | Details |
---|---|
stop.assigned | Webhook will be triggered if there is stop assigned |
stop.status-changed | Webhook will be triggered if there is stop status changed |
shipment.assigned | Webhook will be triggered if there is shipment assigned |
shipment.status-changed | Webhook will be triggered if there is shipment status assigned |
trip.status-changed | Webhook will be triggered if there is trip status assigned |
trip.created | Webhook will be triggered if there is trip created |
trip.assigned | Webhook will be triggered if there is trip assigned |
note.created | Webhook will be triggered if there is note created |
Webhook Responses
Here are webhook responses for each event types :
Event Types | Responses |
---|---|
stop.assigned |
{ "stopId": 987786, "stopRef": "L20222704I1H4ZE", "tripDate": "2022-04-27", "shipmentId": null, "actionDate": "2022-04-27T04:35:56.1148299+00:00", "assignedTo": { "name": "John Doe", "id": "a2e3014b-f5a2-418b-9bed-38eb5c9b5217" }, "source": null, "sourceReference": null } |
stop.status-changed |
{ "stopId": 987786, "stopRef": "L20222704I1H4ZE", "tripDate": "2022-04-27", "shipmentId": null, "actionDate": "2022-04-27T14:16:40.9450989+10:00", "oldStatus": "Enroute", "newStatus": "Arrived", "notes": null, "location": null, "assignedTo": { "name": "Filbert Nicholas", "id": "a823361e-9d40-4438-bb28-b2b58cdb957e" }, "changedByUser": { "name": "Filbert Nicholas", "id": "a823361e-9d40-4438-bb28-b2b58cdb957e" }, "source": null, "sourceReference": null } |
shipment.assigned |
{ "stopId": 987938, "stopRef": "LSS202227045MN8J8-P", "tripDate": "2022-04-27", "shipmentId": 28710, "actionDate": "2022-04-27T04:38:35.3001748+00:00", "assignedTo": { "name": "Filbert Nicholas", "id": "a823361e-9d40-4438-bb28-b2b58cdb957e" }, "source": null, "sourceReference": null } |
shipment.status-changed |
{ "shipmentId": 28710, "shipmentRef": "LSS202227045MN8J8", "tripDate": "2022-04-27", "actionDate": "2022-04-27T14:42:12.6568123+10:00", "oldStatus": "On Hold", "newStatus": "Enroute to Pickup", "notes": null, "location": null, "changedByUser": { "name": "Filbert Nicholas", "id": "a823361e-9d40-4438-bb28-b2b58cdb957e" }, "source": null, "sourceReference": null } |
trip.status-changed |
{ "tripId": 46643, "tripDate": "2022-04-27", "actionDate": "2022-04-27T14:49:43.7847927+10:00", "oldStatus": "Pending", "newStatus": "Started", "notes": null, "location": null, "changedByUser": { "name": "Filbert Nicholas", "id": "a823361e-9d40-4438-bb28-b2b58cdb957e" } } |
trip.created |
{ "tripId": 46659, "tripDate": "2022-04-27", "actionDate": "2022-04-27T04:46:36.9058258+00:00", "assignedTo": { "name": "Mark Dean", "id": "a6dd0d67-60d2-41e3-8507-36200ddbe975" } } |
trip.assigned |
{ "tripId": 46659, "tripDate": "2022-04-27", "actionDate": "2022-04-27T04:46:36.907+00:00", "assignedTo": { "name": "Mark Dean", "id": "a6dd0d67-60d2-41e3-8507-36200ddbe975" }, "assignedFrom": { "name": "Mark Dean", "id": "a6dd0d67-60d2-41e3-8507-36200ddbe975" } } |
note.created |
{ "noteId": 310277, "stopId": 987786, "shipmentId": null, "type": "Stop Note", "noteText": "Customer request to refund the item", "createdDate": "2022-04-27T04:51:36.1566409+00:00", "createdByUser": { "name": "Filbert Nicholas", "id": "a823361e-9d40-4438-bb28-b2b58cdb957e" }, "photoUrls": [], "documentUrls": [], "metadata": null } |