Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

Topics

Introduction
Servers
Concepts
Main Features
Flow Diagrams
Webhooks
Authentication

Endpoints

Locker API
Parcel API
Carrier API
Courier App
Enduser App

Webhooks

Locker Events
- Webhook for locker updates POST
Parcel Events
- Webhook for parcel updates POST
Collection Events
- Webhook for pickup notifications POST

Powered by Bump.sh

Locker Events

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).