Edit a Webhook

put https://services.azuga.com/azuga-ws-oauth/v3/webhooks/{token}.json

Use this API to edit an existing webhook. You need to pass the ID (token) of the webhook in the API call. Only one webhook can be modified per API call.

Note: To obtain the ID of the webhook, you need to call the View API. For more information, see Webhooks View API

📘
Sample Request
https://services.azuga.com/azuga-ws-oauth/v3/FXVYCV6XZ.json

{  
   "name":"Trips_Webhook",
   "url":"http://api.azuga.com",
   "email":"test@azuga.com",
   "paused":false,
   "retryRate":3,
   "pausedTill":null,
   "authorizationType":"BASIC",
   "webHookAuthKeyValues":[  
      {  
         "authKey":"azuga",
         "authValue":"azugapassword"
      }
   ],
   "webHookEventTypes":[  
      {  
         "eventType":"TRIP_START_MESSAGE"
      },
      {  
         "eventType":"TRIP_END_MESSAGE"
      },
      {  
         "eventType":"GPS_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	API response message (Success/Failure)	String
error	Error message	List

Path Params

token

string

required

Unique identifier representing the webhook

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

Type of authorization you wish to use. Valid types are: BASIC, KEY. For both types, the Username and Password for BASIC and Key and Value for KEY can be updated in fields - webHookAuthKeyValues & webHookEventTypes

webHookAuthKeyValues

array of objects

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

List/Array of event types. To see the available event types you can subscribe to, use the 'View Events' endpoint.

webHookEventTypes*

retryRate

int32

required

Number of times to retry in case of failures.

pausedTill

int64

Period up to which the webhook is paused. This field will be null if paused = false

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://services.azuga.com/azuga-ws-oauth/v3/webhooks/token.json \
3
     --header 'Content-Type: application/json' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘Sample Request

API Response Explanation

200200

400400

📘
Sample Request