Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can download examples of the JSON Post for the various events below.

View file
nameWebhooksSamples.zip

Anchor
CustomerStatusEvents
CustomerStatusEvents
Event Descriptions

Below is a list of all the various events available and what the action is that is tied to the event.

Customer Level Status Event

Description

Delivered

On Demand order has been delivered to the destination location

PickedUp

On Demand order has been picked up from the origin location

AtDelivery

Driver has arrived at the destination location

AtPickup

Driver has arrived at the origin location

Placed

On Demand order has been created

Confirmed

On Demand order has been marked as confirmed by the driver assigned to the order

DeliverySignature

A signature has been collected by the driver at the destination location

ReceivedAtDock

On Demand order has been marked as received at dock

StatusUpdate

A status update has been requested/triggered for an On Demand order by a user to provide the latest status details of the order

Canceled

On Demand order has been canceled

Consolidated

On Demand order being placed has been consolidated/merged onto an already existing order

Invoiced

On Demand order has been invoiced

DriverAssigned

On Demand order has been assigned to a driver

DriverUnassigned

The driver assigned to the On Demand order has been removed from the order

RateChanged

The rate on the On Demand order has been changed

StatusCodeAdded

A status code has been added to the On Demand Order

StatusCodeUpdated

An existing status code has been updated on the On Demand order

ParcelExceptionAdded

An exception has been added to a parcel that is assigned to the On Demand Order

NextDelivery

The On Demand order has been marked as the next delivery to take place

NextPickup

The On Demand order has been marked as the next pickup to take place

VerifiedForBilling

The On Demand order have been marked as verified for billing

RejectedByDriver

The On Demand order has been rejected by the assigned driver

AddressChange

The On Demand order had an address changed for either the origin or the destination

Completed

The route stop has been marked as completed

Arrived

The driver has arrived at the route stop location

Signature

A signature has been collected for the route stop

POD

A POD has been collected for the route stop

Activated

The route stop has been activated

AssignedToDriver

The route stop has been assigned to a driver

Consolidated

The route stop being created has been consolidated/merged onto an already existing stop

Created

Route Stop has been created

Deactivated

Route stop has been deactivated

ParcelExceptionAdded

An exception has been added to a parcel linked to the route stop

StatusCodeAdded

A status code has been added to the route stop

StatusCodeUpdated

An existing status code has been updated on the route stop

UnassignedFromDriver

The driver assigned to the route stop has been removed

...