Create a Webhook

post

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

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
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

Field	Description	Data Type
generatedAtInMillis	The time at which the API returns the response. Value returned is in milliseconds	Long
data	The unique identifier generated for the webhook	String
error	Error message	List<Error>

Body Params

name

string

required

Name of the webhook. Webhook name is required of length more than or equal to 3 characters

url

string

required

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

string

required

Azuga will send an email to this address if the specified URL becomes unreachable or fails to respond.

paused

boolean

Specify if you want to pause this webhook. By default, the value is false. True = Paused, False = Unpause

authorizationType

string

required

Choose the authentication method you want to use. Valid types are: BASIC, KEY.

webHookAuthKeyValues

array of objects

required

Array of key-value pair used for authorization. For both types, update the username/key and password/value against fields - webHookAuthKeyValues & webHookEventTypes

webHookAuthKeyValues*

webHookEventTypes

array of objects

required

Array of event types. The valid event types that can be subscribed can be fetched from using 'View Events' endpoint.

webHookEventTypes*

retryRate

int32

required

Number of times to retry in case of failures.

Responses

Sample Request

API Response explanation

200200

400400