Update Webhook

This operation updates the webhook details

SecuritybearerAuth
Request
path Parameters
webHookConfigID
required
string

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

Request Body schema: application/json
name
required
string

It indicates the desired name of the webhook
Max length = 50.

type
required
string

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"
events
required
Array of strings
url
required
string

It indicates the customer url to which events should be sent.

timeOut
number

It indicates the timeout value before system waits response from the customer url, here timeout indicates in seconds.

status
string

It indicates the status of the webhook. By default it takes active. To mark it inactive use in-active

required
custom (object) or basic (object) or OAuth (object)
Responses
200

Webhook update is successful

401

The request could not be authorized.

put/api/v1/webhookConfig/{webHookConfigID}
Request samples
application/json
{
  • "name": "dev_webhook1",
  • "type": "locker",
  • "events": [
    ],
  • "url": "https://webhook.com",
  • "timeOut": 5,
  • "status": "active",
  • "authParams": {
    }
}
Response samples
application/json
{
  • "webHookConfigID": "DELn75Jx7r3p",
  • "name": "dev_webhook1",
  • "type": "locker",
  • "events": [
    ],
  • "url": "https://webhook.com",
  • "authParams": {
    },
  • "timeOut": 5,
  • "status": "active",
  • "developerPartnerId": "xxxxxx"
}