Carrier webhook endpoints
Carrier webhook endpoints
Webhooks provide real-time updates on locker and parcel statuses by pushing notifications to specified URLs. This ensures Carriers stay informed about relevant events as they happen.
Webhook endpoints are designed to push updates about lockers, parcels, and other events to URLs provided by the Carrier. These endpoints include:
- Locker Updates: Enables carriers to receive real-time updates about locker status and details.
- Parcel Updates: Allows carriers to receive notifications about changes in parcel status.
- Pickup Notifications: Daily notifications about parcels that need to be picked up from lockers.
Key Features:
- Real-time Updates: Push notifications for immediate awareness of changes.
- Customizable URLs: Configure URLs to receive specific event updates.
Tags
Locker Events
This webhook endpoint is designed to push events about locker updates.
- New Locker: An event will be pushed when a new Locker is created.
- Locker status: An event is pushed when the locker status changes (enabled/disabled).
Parcel Events
This webhook endpoint is designed to push updates about parcels handling events.
- Parcel Updates: Get notifications about changes in parcel status.
Collection Events
This webhook endpoint is designed to push events about lockers that require parcel collections.
- Sporadic Collection: Events are pushed to notify the Carrier that lockers have parcels to be collected.