Skip to main content
WEBHOOK

Body

application/json

Event data delivered to your endpoint

Event payload delivered to your endpoint when a parcel is created.

event_type
enum<string>
required

The event type identifier.

Available options:
parcel.created
Example:

"parcel.created"

data
object
required

The parcel as it was created. All keys below are always present in the delivered payload; keys that are not applicable are delivered as null.

Decimal amounts (weights, dimensions and prices) are delivered as strings to avoid rounding differences.

Response

200

Return a 2xx status to acknowledge receipt of the event.