Skip to content
Pitney Locker APIs
/
/Webhook

Webhook

APIs for managing webhook configurations and event subscriptions. These APIs support operations such as retrieving supported events, creating webhook configurations, fetching webhook details, updating configurations, and deleting webhooks.

Operations

Get Applicable Event list for Webhook configuration

Request

This operation gets the events details

Security
bearerAuth
curl -i -X GET \
  https://api-sandbox.sendpro360.pitneybowes.com/webhook/api/v1/events \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully retrieved all applicable events on which webhook can be configured

Bodyapplication/json
Array [
eventIdstring

event id of an event

namestring

name of an event

]
Response
[
  {
    "eventId": "reservation",
    "name": "reservation"
  },
  {
    "eventId": "cancelreservation",
    "name": "cancelreservation"
  },
  {
    "eventId": "deposit",
    "name": "deposit"
  },
  {
    "eventId": "pickup",
    "name": "pickup"
  },
  {
    "eventId": "stalemailpickup",
    "name": "stalemailpickup"
  },
  {
    "eventId": "updatereservation",
    "name": "updatereservation"
  },
  {
    "eventId": "onhold",
    "name": "onhold"
  }
]