View all Webhooks

This API gives you the details of all the webhooks configured in your account. Details of multiple webhooks can be obtained through this API. This API also returns the unique IDs corresponding to each of the webhooks.

📘

Sample Request

https://services.azuga.com/azuga-ws-oauth/v3/webhooks.json

API Response Explanation

Field

Description

Data type

generatedAtInMillis

The time at which the API returns the response. Value returned is in milliseconds

Long

webHookId

Unique identifier representing the webhook

Long

token

Unique identifier representing the webhook

Date

name

Name of the webhook

String

webHookEventTypes

Array of webhook event types

String

eventType

Type of the event

String

url

Specify the URL where you want Azuga to send the webhook data.

String

authorizationType

Type of authorization

String

email

Address to which our application will send email when the specified URL is unavailable or does not respond

String

paused

Boolean to indicate if the webhook is paused

boolean

pausedTill

Period till which the webhook is paused

This field will be null if paused = false

Date

createdBy

Unique identifier of the user who created the webhook

String

createdAt

Timestamp (in Milliseconds) at which the webhook was created

Timestamp

lastModifiedBy

Unique identifier of the user who last modified the webhook

String

lastModifiedAt

Timestamp (in Milliseconds) at which the webhook was modified last

Timestamp

retryRate

Number of retries on errors

Integer

webHookAuthKeyValues

Array of key- value pairs used for authorization

Set<WebHookAuthKeyValueMapping>

authKey

Authorization key

String

authValue

Authorization value

String

deleted

boolean value representing the delete state of the auth key

boolean

webHookEventTypes

Array of webhook event types

List<WebHookEventTypeMapping>

eventType

Type of the event

String

deleted

Deleted state of the event

boolean

expired

boolean representing whether the webhook is expired or not

boolean

noOfSeconds

For Azuga internal use

int

make

For Azuga internal use

String

model

For Azuga internal use

String

year

For Azuga internal use

String

speed

For Azuga internal use

Integer

licensePlateNo

For Azuga internal use

String

error

Error message

List<Error>

key

Application key (internal reference)

String

Language
Credentials
Header
Click Try It! to start a request and see the response here!