Update device webhooks settings

Update all webhook settings for all devices in an organization. These settings apply to all devices currently in the organization and any devices added in the future.

Note: This call updates all webhook settings in the call. Any webhook setting not configured in the call, is 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

gpsWebhookUrl	Array of strings (gpsWebhookUrl) <= 3 items The destination URLs for GPS webhooks.
eventWebhookUrl	Array of strings (eventWebhookUrl) <= 3 items The destination URLs for event webhooks.
	object (Events webhook configuration) The events webhook configuration of organization object.
alarmsWebhookUrl	Array of strings (alarmsWebhookUrl) <= 3 items The destination URLs for alarms webhooks.
	object (Alarms webhook configuration) The alarms webhook configuration of organization object.
	Array of objects (systemMessagesWebhook) <= 3 items The destination URLs and their configuration for system messages webhooks.

Responses

200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

500

Internal server error

post/organizations/{orgId}/webhook-settings

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"gpsWebhookUrl": ["string"
],
"eventWebhookUrl": ["string"
],
"eventWebhookConfig": {"notifyMediaAvailable": {"isEnabled": true
}
},
"alarmsWebhookUrl": ["string"
],
"alarmsWebhookConfig": {"subscribeForAlarmUpdates": {"isEnabled": false
}
},
"systemMessagesWebhook": [{"url": "string",
"config": {"dataProfile": {"isEnabled": false,
"dataProfileLimit": 90
},
"deviceStatus": {"isEnabled": false
},
"deviceBillingStatus": {"isEnabled": false
},
"deviceRemoved": {"isEnabled": false
}
}
}
]
}

Response samples

application/json

{"data": {"gpsWebhookUrl": ["string"
],
"eventWebhookUrl": ["string"
],
"eventWebhookConfig": {"notifyMediaAvailable": {"isEnabled": true
}
},
"alarmsWebhookUrl": ["string"
],
"alarmsWebhookConfig": {"subscribeForAlarmUpdates": {"isEnabled": false
}
},
"systemMessagesWebhook": [{"url": "string",
"config": {"dataProfile": {"isEnabled": false,
"dataProfileLimit": 90
},
"deviceStatus": {"isEnabled": false
},
"deviceBillingStatus": {"isEnabled": false
},
"deviceRemoved": {"isEnabled": false
}
}
}
]
},
"requestId": "df5fg-45fgfdsg-45fg-45454"
}