Get Webhook details by Id

Request

This operation gets the webhook details

Security

bearerAuth

Path

webHookConfigIDstringrequired

This is unique id of webhook which will get from create webhook config api.

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

Responses

Webhook details retrieved successfully

Bodyapplication/json

webHookConfigIDstring

It is unique id system generates for the created 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:

type	supported events
locker	reservation, cancelreservation, deposit, pickup, stalemailpickup
tracking	Manifest, Acceptance, InTransit, DeliveryAttempt, OutForDelivery, Delivered, Exception, ReturnToSender, ReadyForPickup, PickupMissed, PickedUp

Enum:"locker""tracking"

Example:"locker"

eventsArray of strings

Example:

[
  "Manifest",
  "InTransit",
  "Delivered"
]

urlstring

URL to which events be pushed to

Example:"https://webhook.com"

timeOutnumber

It shows the timeout value untill which it waits to receive response from the customer url, here timeout indicates in seconds.

Example:5

statusstring

status of the webhook

Example:"active"

authParamscustom (object) or basic (object) or OAuth (object)

Example:

{
  "authType": "custom",
  "apiKey": "JsuG7jk",
  "headerName": "webhook1"
}

One of:

Response

{
  "webHookConfigID": "DELn75Jx7r3p",
  "name": "dev_webhook1",
  "type": "locker",
  "events": [
    "reservation",
    "cancelreservation",
    "deposit"
  ],
  "url": "https://webhook.com",
  "authParams": {
    "authType": "custom",
    "apiKey": "JsuG7jk",
    "headerName": "webhook1"
  },
  "timeOut": 5,
  "status": "active",
  "developerPartnerId": "xxxxxx"
}