Replace webhooks subscription devices

Replace the entire list of devices subscribed to webhooks with a new list of devices.

Note: PUT calls update data entirely. Any data not mentioned in the call, will be deleted.

Request

Security:

bearerAuth

path Parameters

orgId

required

string

The ID of the organization. Obtain this from GET /organizations.

Example: 62

Request Body schema: application/json

Array

Any of:

imei required	string (IMEI) The IMEI number of the device. The IMEI number can be found on a sticker on the device itself or on the back of the device box.
url required	string The URL where the webhook is posted.
type required	string The type of the webhook. For the event type, every event triggered for this device is posted using the webhook. For the GPS type, all GPS information is posted. For the alarms type, every alarm is posted. For the systemMessages type, every system message triggered for this device is posted using the webhook based on config settings. Value: "systemMessages"
	object

Responses

200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

put/organizations/{orgId}/webhooks

Request samples

Payload
curl
JavaScript
Node.js

application/json

[{"imei": "357660101000198",
"url": "http://mywebhook.com",
"type": "systemMessages",
"config": {"dataProfile": {"isEnabled": false,
"dataProfileLimit": 90
},
"deviceStatus": {"isEnabled": false
},
"deviceBillingStatus": {"isEnabled": false
},
"deviceRemoved": {"isEnabled": false
},
"auxiliaryCamerasConnectionStatus": {"isEnabled": false
},
"privacyMode": {"isEnabled": false
},
"dataUsage": {"isEnabled": false,
"dataPlan": 1
}
}
}
]

Response samples

application/json

{"requestId": "df5fg-45fgfdsg-45fg-45454"
}