Create a Webhook

This API can be utilized to Create a webhook and subscribe to specific events. Upon configuration, Azuga will transmit real-time JSON data to the designated endpoint whenever the subscribed events occur.

It is essential to establish the appropriate authentication method for your service.

📘

Sample Request

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

{
    "name": "Trips_Webhook",
    "url": "https://endpoint-to-receive-data.com/",
    "email": "[email protected]",
    "paused": false,
    "retryRate": 10,
    "authorizationType": "BASIC",
    "webHookAuthKeyValues": [
        {
            "authKey": "authKey",
            "authValue": "authValue"
        }
    ],
    "webHookEventTypes": [
        {
            "eventType": "TRIP_START_MESSAGE"
        },
        {
            "eventType": "TRIP_END_MESSAGE"
        },
        {
            "eventType": "GPS_MESSAGE"
        }
    ]
}

API Response explanation

FieldDescriptionData Type
generatedAtInMillisThe time at which the API returns the response. Value returned is in millisecondsLong
dataThe unique identifier generated for the webhookString
errorError messageList<Error>
Language
Credentials
Header
Click Try It! to start a request and see the response here!