Skip to content
Pitney Locker APIs
/
Locker Webhook APIs
/
/
Get All Webhooks

Get All Webhooks

Request

This operation gets all the configured webhook and its details.

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

Responses

all Webhooks get successful

Bodyapplication/json
webHookConfigIDstring

webhook config id of the webhook

Example:"1Q86AvxyqmA"
namestring

name of the webhook

Example:"webhook1"
typestring

It indicates the type of webhook. Currently it takes tracking and lockeras value. These event codes are supported for the defined type:

typesupported events
lockerreservation, cancelreservation, deposit, pickup, stalemailpickup
trackingManifest, Acceptance, InTransit, DeliveryAttempt, OutForDelivery, Delivered, Exception, ReturnToSender, ReadyForPickup, PickupMissed, PickedUp
Enum:"locker""tracking"
eventsArray of strings
Example:
[
  "Manifest",
  "InTransit",
  "Delivered"
]
urlstring

url of the webhook

Example:"https://webhook.com"
timeOutnumber

timeout seconds

Example:5
statusstring

status of the webhook

Example:"active"
authParamsobject
Response
{
  "data": [
    {
      "webHookConfigID": "DELn75Jx7r3p",
      "name": "dev_webhook1",
      "type": "locker",
      "events": [ … ],
      "url": "https://webhook.com",
      "authParams": { … },
      "timeOut": 5,
      "status": "active",
      "developerPartnerId": "xxxxx"
    },
    {
      "webHookConfigID": "K3M01oqmEbe2",
      "name": "dev_webhook1",
      "type": "locker",
      "events": [ … ],
      "url": "https://webhook.com",
      "authParams": { … },
      "timeOut": 5,
      "status": "active",
      "developerPartnerId": "xxxxx"
    }
  ],
  "pageInfo": {
    "total": 2,
    "pages": 1,
    "page": 1
  }
}