View a Webhook

Use this API to get details of a particular webhook. You need to pass the ID (token) of the webhook, while calling this API.

Note: To get the ID of a webhook, you must call the View API. For more information, see Webhooks View API

Warning : Make sure that you are setting the method to GET. The same endpoint is used for deleting a Webhook using DELETE method. The deletion of the Webhook is an irreversible action.


Sample Request

API Response Explanation

FieldDescriptionData Type
generatedAtInMillisAPI generation timestamp in MillisecondsLong
dataObject representing the meta-data of the webhookObject
webHookIdUnique identifier representing the webhookLong
tokenUnique identifier representing the webhookString
timeTimestamp (in Milliseconds) at which the webhook was createdDate
nameName of the webhookString
urlEndpoint of the webhookString
authorizationTypeType of authorizationString
emailAddress to which our application will send email when the specified URL is unavailable or does not respondString
pausedBoolean to indicate if the webhook is pausedboolean
pausedTillPeriod till which the webhook is paused
This field will be null if paused = false
createdByUnique identifier of the user who created the webhookString
createdAtTimestamp (in Milliseconds) at which the webhook was createdTimestamp
lastModifiedByUnique identifier of the user who last modified the webhookString
lastModifiedAtTimestamp (in Milliseconds) at which the webhook was modified lastTimestamp
retryRateNumber of time to retry in case of failures while postingInteger
webHookAuthKeyValuesArray of key - value pair used for authorizationSet
authKeyAuthorization keyString
authValueAuthorization valueString
deletedBoolean representing whether the webHookAuthKeyValue is deleted or not.boolean
webHookEventTypesArray of event typesList
eventTypeName of the event typeString
deletedBoolean representing whether the webHookEventType is deleted or not.boolean
expiredboolean representing whether the webhook is expired or notboolean
noOfSecondsFor Azuga internal useint
makeFor Azuga internal useString
modelFor Azuga internal useString
yearFor Azuga internal useString
speedFor Azuga internal useInteger
licensePlateNoFor Azuga internal useString
errorError messageList
Click Try It! to start a request and see the response here!