Create a Webhook

Use this API to create a webhook and subscribe to an event. When these events occur in real-time, Azuga will make a request to the endpoint with a JSON payload. You also need to provide the authentication schemes to your service.

📘

Sample Request

https://api.azuga.com/azuga-ws/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
generatedAtInMillisAPI generation timestamp in MillisecondsLong
dataAPI Message (Success/Failure)String
errorError messageList
Language
Authorization
Header
Click Try It! to start a request and see the response here!