Update rule
curl --request POST \
--url https://api2.rhombussystems.com/api/rules/updateRule \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"ruleUpdate": {
"action": {
"activateLocationLockdown": {
"locationLockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
},
"alertAction": true,
"audioPlaybackActions": [
{
"audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"audioGateways": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"loopDurationSec": 123,
"playCount": 123
}
],
"cancelLoopingAudioPlaybackAction": {
"_audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
]
},
"changeComponentCompositeAccessStateActions": [
{
"alwaysCreateOverrideIfNoFirstIn": true,
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"expireTimeDelaySeconds": 123,
"expireTimeOfDayLocalSeconds": 123,
"useFirstInRulesIfPossible": true
}
],
"connectAudioDeviceToMobileAppAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"targetUserUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"connectAudioDeviceToPhoneNumberAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"optionalGreeting": "<string>",
"phoneNumber": "<string>"
},
"createAlarmAction": {
"attachMediaToActiveAlarm": true,
"entryInstructions": "<string>",
"exclusiveEmergencyContact": true,
"exclusiveEntryInstructions": true,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"mediaDeviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"reason": "<string>",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
},
"customActions": [
{
"headers": {},
"path": "<string>"
}
],
"customLLMActions": [
{
"deviceActivityEvents": {},
"deviceFacetUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"timestampMs": 123
}
],
"emailAuditLogExportActions": [
{
"includeActions": [
"<string>"
],
"includeApiInvocation": true,
"lookbackCount": 123,
"recipientEmails": [
"<string>"
],
"timezoneId": "<string>"
}
],
"enableDisableAudioRecordActions": [
{
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"enable": true
}
],
"integrationCommandActions": [
{
"commandPayload": "<string>",
"delaySecs": 123
}
],
"integrationNotificationActions": [
{
"notificationEntity": "<string>",
"notificationTarget": "<string>"
}
],
"liveNotificationAction": true,
"remoteDoorUnlockActions": [
{
"doorId": "<string>",
"placeId": "<string>"
}
],
"robotActions": [
{
"mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"pose": {
"orientation": [
123
],
"position": [
123
]
},
"routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"thirdPartyAudioPlaybackAction": {
"audioFileName": "<string>",
"ipAddress": "<string>",
"loopDurationSec": 123,
"password": "<string>",
"playCount": 123,
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"username": "<string>"
},
"thirdPartyStrobeSirenAction": {
"durationSec": 123,
"ipAddress": "<string>",
"lightColors": [
"<string>"
],
"lightIntensity": 123,
"lightPattern": "<string>",
"lightSpeed": 123,
"password": "<string>",
"profileName": "<string>",
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"sirenIntensity": 123,
"sirenPattern": "<string>",
"username": "<string>"
},
"triggerComponentRelayActions": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"webhookActions": [
{
"headers": {},
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthGrantType": "<string>",
"oauthScope": "<string>",
"oauthUrl": "<string>",
"webhookSecret": "<string>",
"webhookUrl": "<string>"
}
]
},
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ruleFilters": {
"scheduleUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"triggerBackoffSecs": 123
},
"triggers": [
{
"activityEvent": {},
"componentCompositeUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"componentUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"deviceLabels": [
"<string>"
],
"deviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"locationUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
}
],
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}
'import requests
url = "https://api2.rhombussystems.com/api/rules/updateRule"
payload = { "ruleUpdate": {
"action": {
"activateLocationLockdown": {
"locationLockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
},
"alertAction": True,
"audioPlaybackActions": [
{
"audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"audioGateways": ["AAAAAAAAAAAAAAAAAAAAAA"],
"loopDurationSec": 123,
"playCount": 123
}
],
"cancelLoopingAudioPlaybackAction": {
"_audioDevices": ["AAAAAAAAAAAAAAAAAAAAAA.v0"],
"audioDevices": ["AAAAAAAAAAAAAAAAAAAAAA.v0"]
},
"changeComponentCompositeAccessStateActions": [
{
"alwaysCreateOverrideIfNoFirstIn": True,
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"expireTimeDelaySeconds": 123,
"expireTimeOfDayLocalSeconds": 123,
"useFirstInRulesIfPossible": True
}
],
"connectAudioDeviceToMobileAppAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"targetUserUuids": ["AAAAAAAAAAAAAAAAAAAAAA"]
},
"connectAudioDeviceToPhoneNumberAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"optionalGreeting": "<string>",
"phoneNumber": "<string>"
},
"createAlarmAction": {
"attachMediaToActiveAlarm": True,
"entryInstructions": "<string>",
"exclusiveEmergencyContact": True,
"exclusiveEntryInstructions": True,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"mediaDeviceUuids": ["AAAAAAAAAAAAAAAAAAAAAA.v0"],
"reason": "<string>",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
},
"customActions": [
{
"headers": {},
"path": "<string>"
}
],
"customLLMActions": [
{
"deviceActivityEvents": {},
"deviceFacetUuids": ["AAAAAAAAAAAAAAAAAAAAAA.v0"],
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"timestampMs": 123
}
],
"emailAuditLogExportActions": [
{
"includeActions": ["<string>"],
"includeApiInvocation": True,
"lookbackCount": 123,
"recipientEmails": ["<string>"],
"timezoneId": "<string>"
}
],
"enableDisableAudioRecordActions": [
{
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"enable": True
}
],
"integrationCommandActions": [
{
"commandPayload": "<string>",
"delaySecs": 123
}
],
"integrationNotificationActions": [
{
"notificationEntity": "<string>",
"notificationTarget": "<string>"
}
],
"liveNotificationAction": True,
"remoteDoorUnlockActions": [
{
"doorId": "<string>",
"placeId": "<string>"
}
],
"robotActions": [
{
"mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"pose": {
"orientation": [123],
"position": [123]
},
"routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"thirdPartyAudioPlaybackAction": {
"audioFileName": "<string>",
"ipAddress": "<string>",
"loopDurationSec": 123,
"password": "<string>",
"playCount": 123,
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"username": "<string>"
},
"thirdPartyStrobeSirenAction": {
"durationSec": 123,
"ipAddress": "<string>",
"lightColors": ["<string>"],
"lightIntensity": 123,
"lightPattern": "<string>",
"lightSpeed": 123,
"password": "<string>",
"profileName": "<string>",
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"sirenIntensity": 123,
"sirenPattern": "<string>",
"username": "<string>"
},
"triggerComponentRelayActions": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"webhookActions": [
{
"headers": {},
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthGrantType": "<string>",
"oauthScope": "<string>",
"oauthUrl": "<string>",
"webhookSecret": "<string>",
"webhookUrl": "<string>"
}
]
},
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ruleFilters": {
"scheduleUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"triggerBackoffSecs": 123
},
"triggers": [
{
"activityEvent": {},
"componentCompositeUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"componentUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"deviceLabels": ["<string>"],
"deviceUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"locationUuids": ["AAAAAAAAAAAAAAAAAAAAAA"]
}
],
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
} }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
ruleUpdate: {
action: {
activateLocationLockdown: {
locationLockdownPlanUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
locationUuid: 'AAAAAAAAAAAAAAAAAAAAAA'
},
alertAction: true,
audioPlaybackActions: [
{
audioClipUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
audioGateways: ['AAAAAAAAAAAAAAAAAAAAAA'],
loopDurationSec: 123,
playCount: 123
}
],
cancelLoopingAudioPlaybackAction: {
_audioDevices: ['AAAAAAAAAAAAAAAAAAAAAA.v0'],
audioDevices: ['AAAAAAAAAAAAAAAAAAAAAA.v0']
},
changeComponentCompositeAccessStateActions: [
{
alwaysCreateOverrideIfNoFirstIn: true,
componentCompositeUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
expireTimeDelaySeconds: 123,
expireTimeOfDayLocalSeconds: 123,
useFirstInRulesIfPossible: true
}
],
connectAudioDeviceToMobileAppAction: {
audioDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
doorUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
targetUserUuids: ['AAAAAAAAAAAAAAAAAAAAAA']
},
connectAudioDeviceToPhoneNumberAction: {
audioDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
doorUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
optionalGreeting: '<string>',
phoneNumber: '<string>'
},
createAlarmAction: {
attachMediaToActiveAlarm: true,
entryInstructions: '<string>',
exclusiveEmergencyContact: true,
exclusiveEntryInstructions: true,
locationUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
mediaDeviceUuids: ['AAAAAAAAAAAAAAAAAAAAAA.v0'],
reason: '<string>',
subLocationsHierarchyKey: 'AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA'
},
customActions: [{headers: {}, path: '<string>'}],
customLLMActions: [
{
deviceActivityEvents: {},
deviceFacetUuids: ['AAAAAAAAAAAAAAAAAAAAAA.v0'],
orgUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
promptUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
timestampMs: 123
}
],
emailAuditLogExportActions: [
{
includeActions: ['<string>'],
includeApiInvocation: true,
lookbackCount: 123,
recipientEmails: ['<string>'],
timezoneId: '<string>'
}
],
enableDisableAudioRecordActions: [{audioDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA', enable: true}],
integrationCommandActions: [{commandPayload: '<string>', delaySecs: 123}],
integrationNotificationActions: [{notificationEntity: '<string>', notificationTarget: '<string>'}],
liveNotificationAction: true,
remoteDoorUnlockActions: [{doorId: '<string>', placeId: '<string>'}],
robotActions: [
{
mapUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
pose: {orientation: [123], position: [123]},
routeUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
waypointUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
deviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA'
}
],
thirdPartyAudioPlaybackAction: {
audioFileName: '<string>',
ipAddress: '<string>',
loopDurationSec: 123,
password: '<string>',
playCount: 123,
proxyDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
username: '<string>'
},
thirdPartyStrobeSirenAction: {
durationSec: 123,
ipAddress: '<string>',
lightColors: ['<string>'],
lightIntensity: 123,
lightPattern: '<string>',
lightSpeed: 123,
password: '<string>',
profileName: '<string>',
proxyDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
sirenIntensity: 123,
sirenPattern: '<string>',
username: '<string>'
},
triggerComponentRelayActions: [
{
componentUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
overrideRelayDurationMs: 123,
overrideRelayDurationSec: 123,
ownerDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA'
}
],
webhookActions: [
{
headers: {},
oauthClientId: '<string>',
oauthClientSecret: '<string>',
oauthGrantType: '<string>',
oauthScope: '<string>',
oauthUrl: '<string>',
webhookSecret: '<string>',
webhookUrl: '<string>'
}
]
},
name: '<string>',
orgUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
ownerUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
ruleFilters: {scheduleUuids: ['AAAAAAAAAAAAAAAAAAAAAA'], triggerBackoffSecs: 123},
triggers: [
{
activityEvent: {},
componentCompositeUuids: ['AAAAAAAAAAAAAAAAAAAAAA'],
componentUuids: ['AAAAAAAAAAAAAAAAAAAAAA'],
deviceLabels: ['<string>'],
deviceUuids: ['AAAAAAAAAAAAAAAAAAAAAA'],
locationUuids: ['AAAAAAAAAAAAAAAAAAAAAA']
}
],
uuid: 'AAAAAAAAAAAAAAAAAAAAAA'
}
})
};
fetch('https://api2.rhombussystems.com/api/rules/updateRule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/rules/updateRule")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ruleUpdate\": {\n \"action\": {\n \"activateLocationLockdown\": {\n \"locationLockdownPlanUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n },\n \"alertAction\": true,\n \"audioPlaybackActions\": [\n {\n \"audioClipUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"audioGateways\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"loopDurationSec\": 123,\n \"playCount\": 123\n }\n ],\n \"cancelLoopingAudioPlaybackAction\": {\n \"_audioDevices\": [\n \"AAAAAAAAAAAAAAAAAAAAAA.v0\"\n ],\n \"audioDevices\": [\n \"AAAAAAAAAAAAAAAAAAAAAA.v0\"\n ]\n },\n \"changeComponentCompositeAccessStateActions\": [\n {\n \"alwaysCreateOverrideIfNoFirstIn\": true,\n \"componentCompositeUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"expireTimeDelaySeconds\": 123,\n \"expireTimeOfDayLocalSeconds\": 123,\n \"useFirstInRulesIfPossible\": true\n }\n ],\n \"connectAudioDeviceToMobileAppAction\": {\n \"audioDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"doorUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"targetUserUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ]\n },\n \"connectAudioDeviceToPhoneNumberAction\": {\n \"audioDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"doorUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"optionalGreeting\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"createAlarmAction\": {\n \"attachMediaToActiveAlarm\": true,\n \"entryInstructions\": \"<string>\",\n \"exclusiveEmergencyContact\": true,\n \"exclusiveEntryInstructions\": true,\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"mediaDeviceUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA.v0\"\n ],\n \"reason\": \"<string>\",\n \"subLocationsHierarchyKey\": \"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA\"\n },\n \"customActions\": [\n {\n \"headers\": {},\n \"path\": \"<string>\"\n }\n ],\n \"customLLMActions\": [\n {\n \"deviceActivityEvents\": {},\n \"deviceFacetUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA.v0\"\n ],\n \"orgUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"promptUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"timestampMs\": 123\n }\n ],\n \"emailAuditLogExportActions\": [\n {\n \"includeActions\": [\n \"<string>\"\n ],\n \"includeApiInvocation\": true,\n \"lookbackCount\": 123,\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"timezoneId\": \"<string>\"\n }\n ],\n \"enableDisableAudioRecordActions\": [\n {\n \"audioDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"enable\": true\n }\n ],\n \"integrationCommandActions\": [\n {\n \"commandPayload\": \"<string>\",\n \"delaySecs\": 123\n }\n ],\n \"integrationNotificationActions\": [\n {\n \"notificationEntity\": \"<string>\",\n \"notificationTarget\": \"<string>\"\n }\n ],\n \"liveNotificationAction\": true,\n \"remoteDoorUnlockActions\": [\n {\n \"doorId\": \"<string>\",\n \"placeId\": \"<string>\"\n }\n ],\n \"robotActions\": [\n {\n \"mapUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"pose\": {\n \"orientation\": [\n 123\n ],\n \"position\": [\n 123\n ]\n },\n \"routeUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"waypointUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"deviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n }\n ],\n \"thirdPartyAudioPlaybackAction\": {\n \"audioFileName\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"loopDurationSec\": 123,\n \"password\": \"<string>\",\n \"playCount\": 123,\n \"proxyDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"username\": \"<string>\"\n },\n \"thirdPartyStrobeSirenAction\": {\n \"durationSec\": 123,\n \"ipAddress\": \"<string>\",\n \"lightColors\": [\n \"<string>\"\n ],\n \"lightIntensity\": 123,\n \"lightPattern\": \"<string>\",\n \"lightSpeed\": 123,\n \"password\": \"<string>\",\n \"profileName\": \"<string>\",\n \"proxyDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"sirenIntensity\": 123,\n \"sirenPattern\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"triggerComponentRelayActions\": [\n {\n \"componentUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"overrideRelayDurationMs\": 123,\n \"overrideRelayDurationSec\": 123,\n \"ownerDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n }\n ],\n \"webhookActions\": [\n {\n \"headers\": {},\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"oauthGrantType\": \"<string>\",\n \"oauthScope\": \"<string>\",\n \"oauthUrl\": \"<string>\",\n \"webhookSecret\": \"<string>\",\n \"webhookUrl\": \"<string>\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"orgUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"ownerUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"ruleFilters\": {\n \"scheduleUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"triggerBackoffSecs\": 123\n },\n \"triggers\": [\n {\n \"activityEvent\": {},\n \"componentCompositeUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"componentUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"deviceLabels\": [\n \"<string>\"\n ],\n \"deviceUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"locationUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ]\n }\n ],\n \"uuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n }\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>",
"webhookSecrets": {}
}Rules Webservice
Update rule
Update a rule
POST
/
api
/
rules
/
updateRule
Update rule
curl --request POST \
--url https://api2.rhombussystems.com/api/rules/updateRule \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"ruleUpdate": {
"action": {
"activateLocationLockdown": {
"locationLockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
},
"alertAction": true,
"audioPlaybackActions": [
{
"audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"audioGateways": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"loopDurationSec": 123,
"playCount": 123
}
],
"cancelLoopingAudioPlaybackAction": {
"_audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
]
},
"changeComponentCompositeAccessStateActions": [
{
"alwaysCreateOverrideIfNoFirstIn": true,
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"expireTimeDelaySeconds": 123,
"expireTimeOfDayLocalSeconds": 123,
"useFirstInRulesIfPossible": true
}
],
"connectAudioDeviceToMobileAppAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"targetUserUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"connectAudioDeviceToPhoneNumberAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"optionalGreeting": "<string>",
"phoneNumber": "<string>"
},
"createAlarmAction": {
"attachMediaToActiveAlarm": true,
"entryInstructions": "<string>",
"exclusiveEmergencyContact": true,
"exclusiveEntryInstructions": true,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"mediaDeviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"reason": "<string>",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
},
"customActions": [
{
"headers": {},
"path": "<string>"
}
],
"customLLMActions": [
{
"deviceActivityEvents": {},
"deviceFacetUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"timestampMs": 123
}
],
"emailAuditLogExportActions": [
{
"includeActions": [
"<string>"
],
"includeApiInvocation": true,
"lookbackCount": 123,
"recipientEmails": [
"<string>"
],
"timezoneId": "<string>"
}
],
"enableDisableAudioRecordActions": [
{
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"enable": true
}
],
"integrationCommandActions": [
{
"commandPayload": "<string>",
"delaySecs": 123
}
],
"integrationNotificationActions": [
{
"notificationEntity": "<string>",
"notificationTarget": "<string>"
}
],
"liveNotificationAction": true,
"remoteDoorUnlockActions": [
{
"doorId": "<string>",
"placeId": "<string>"
}
],
"robotActions": [
{
"mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"pose": {
"orientation": [
123
],
"position": [
123
]
},
"routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"thirdPartyAudioPlaybackAction": {
"audioFileName": "<string>",
"ipAddress": "<string>",
"loopDurationSec": 123,
"password": "<string>",
"playCount": 123,
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"username": "<string>"
},
"thirdPartyStrobeSirenAction": {
"durationSec": 123,
"ipAddress": "<string>",
"lightColors": [
"<string>"
],
"lightIntensity": 123,
"lightPattern": "<string>",
"lightSpeed": 123,
"password": "<string>",
"profileName": "<string>",
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"sirenIntensity": 123,
"sirenPattern": "<string>",
"username": "<string>"
},
"triggerComponentRelayActions": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"webhookActions": [
{
"headers": {},
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthGrantType": "<string>",
"oauthScope": "<string>",
"oauthUrl": "<string>",
"webhookSecret": "<string>",
"webhookUrl": "<string>"
}
]
},
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ruleFilters": {
"scheduleUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"triggerBackoffSecs": 123
},
"triggers": [
{
"activityEvent": {},
"componentCompositeUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"componentUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"deviceLabels": [
"<string>"
],
"deviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"locationUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
}
],
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}
'import requests
url = "https://api2.rhombussystems.com/api/rules/updateRule"
payload = { "ruleUpdate": {
"action": {
"activateLocationLockdown": {
"locationLockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
},
"alertAction": True,
"audioPlaybackActions": [
{
"audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"audioGateways": ["AAAAAAAAAAAAAAAAAAAAAA"],
"loopDurationSec": 123,
"playCount": 123
}
],
"cancelLoopingAudioPlaybackAction": {
"_audioDevices": ["AAAAAAAAAAAAAAAAAAAAAA.v0"],
"audioDevices": ["AAAAAAAAAAAAAAAAAAAAAA.v0"]
},
"changeComponentCompositeAccessStateActions": [
{
"alwaysCreateOverrideIfNoFirstIn": True,
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"expireTimeDelaySeconds": 123,
"expireTimeOfDayLocalSeconds": 123,
"useFirstInRulesIfPossible": True
}
],
"connectAudioDeviceToMobileAppAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"targetUserUuids": ["AAAAAAAAAAAAAAAAAAAAAA"]
},
"connectAudioDeviceToPhoneNumberAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"optionalGreeting": "<string>",
"phoneNumber": "<string>"
},
"createAlarmAction": {
"attachMediaToActiveAlarm": True,
"entryInstructions": "<string>",
"exclusiveEmergencyContact": True,
"exclusiveEntryInstructions": True,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"mediaDeviceUuids": ["AAAAAAAAAAAAAAAAAAAAAA.v0"],
"reason": "<string>",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
},
"customActions": [
{
"headers": {},
"path": "<string>"
}
],
"customLLMActions": [
{
"deviceActivityEvents": {},
"deviceFacetUuids": ["AAAAAAAAAAAAAAAAAAAAAA.v0"],
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"timestampMs": 123
}
],
"emailAuditLogExportActions": [
{
"includeActions": ["<string>"],
"includeApiInvocation": True,
"lookbackCount": 123,
"recipientEmails": ["<string>"],
"timezoneId": "<string>"
}
],
"enableDisableAudioRecordActions": [
{
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"enable": True
}
],
"integrationCommandActions": [
{
"commandPayload": "<string>",
"delaySecs": 123
}
],
"integrationNotificationActions": [
{
"notificationEntity": "<string>",
"notificationTarget": "<string>"
}
],
"liveNotificationAction": True,
"remoteDoorUnlockActions": [
{
"doorId": "<string>",
"placeId": "<string>"
}
],
"robotActions": [
{
"mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"pose": {
"orientation": [123],
"position": [123]
},
"routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"thirdPartyAudioPlaybackAction": {
"audioFileName": "<string>",
"ipAddress": "<string>",
"loopDurationSec": 123,
"password": "<string>",
"playCount": 123,
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"username": "<string>"
},
"thirdPartyStrobeSirenAction": {
"durationSec": 123,
"ipAddress": "<string>",
"lightColors": ["<string>"],
"lightIntensity": 123,
"lightPattern": "<string>",
"lightSpeed": 123,
"password": "<string>",
"profileName": "<string>",
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"sirenIntensity": 123,
"sirenPattern": "<string>",
"username": "<string>"
},
"triggerComponentRelayActions": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"webhookActions": [
{
"headers": {},
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthGrantType": "<string>",
"oauthScope": "<string>",
"oauthUrl": "<string>",
"webhookSecret": "<string>",
"webhookUrl": "<string>"
}
]
},
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ruleFilters": {
"scheduleUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"triggerBackoffSecs": 123
},
"triggers": [
{
"activityEvent": {},
"componentCompositeUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"componentUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"deviceLabels": ["<string>"],
"deviceUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"locationUuids": ["AAAAAAAAAAAAAAAAAAAAAA"]
}
],
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
} }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
ruleUpdate: {
action: {
activateLocationLockdown: {
locationLockdownPlanUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
locationUuid: 'AAAAAAAAAAAAAAAAAAAAAA'
},
alertAction: true,
audioPlaybackActions: [
{
audioClipUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
audioGateways: ['AAAAAAAAAAAAAAAAAAAAAA'],
loopDurationSec: 123,
playCount: 123
}
],
cancelLoopingAudioPlaybackAction: {
_audioDevices: ['AAAAAAAAAAAAAAAAAAAAAA.v0'],
audioDevices: ['AAAAAAAAAAAAAAAAAAAAAA.v0']
},
changeComponentCompositeAccessStateActions: [
{
alwaysCreateOverrideIfNoFirstIn: true,
componentCompositeUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
expireTimeDelaySeconds: 123,
expireTimeOfDayLocalSeconds: 123,
useFirstInRulesIfPossible: true
}
],
connectAudioDeviceToMobileAppAction: {
audioDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
doorUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
targetUserUuids: ['AAAAAAAAAAAAAAAAAAAAAA']
},
connectAudioDeviceToPhoneNumberAction: {
audioDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
doorUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
optionalGreeting: '<string>',
phoneNumber: '<string>'
},
createAlarmAction: {
attachMediaToActiveAlarm: true,
entryInstructions: '<string>',
exclusiveEmergencyContact: true,
exclusiveEntryInstructions: true,
locationUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
mediaDeviceUuids: ['AAAAAAAAAAAAAAAAAAAAAA.v0'],
reason: '<string>',
subLocationsHierarchyKey: 'AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA'
},
customActions: [{headers: {}, path: '<string>'}],
customLLMActions: [
{
deviceActivityEvents: {},
deviceFacetUuids: ['AAAAAAAAAAAAAAAAAAAAAA.v0'],
orgUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
promptUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
timestampMs: 123
}
],
emailAuditLogExportActions: [
{
includeActions: ['<string>'],
includeApiInvocation: true,
lookbackCount: 123,
recipientEmails: ['<string>'],
timezoneId: '<string>'
}
],
enableDisableAudioRecordActions: [{audioDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA', enable: true}],
integrationCommandActions: [{commandPayload: '<string>', delaySecs: 123}],
integrationNotificationActions: [{notificationEntity: '<string>', notificationTarget: '<string>'}],
liveNotificationAction: true,
remoteDoorUnlockActions: [{doorId: '<string>', placeId: '<string>'}],
robotActions: [
{
mapUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
pose: {orientation: [123], position: [123]},
routeUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
waypointUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
deviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA'
}
],
thirdPartyAudioPlaybackAction: {
audioFileName: '<string>',
ipAddress: '<string>',
loopDurationSec: 123,
password: '<string>',
playCount: 123,
proxyDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
username: '<string>'
},
thirdPartyStrobeSirenAction: {
durationSec: 123,
ipAddress: '<string>',
lightColors: ['<string>'],
lightIntensity: 123,
lightPattern: '<string>',
lightSpeed: 123,
password: '<string>',
profileName: '<string>',
proxyDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
sirenIntensity: 123,
sirenPattern: '<string>',
username: '<string>'
},
triggerComponentRelayActions: [
{
componentUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
overrideRelayDurationMs: 123,
overrideRelayDurationSec: 123,
ownerDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA'
}
],
webhookActions: [
{
headers: {},
oauthClientId: '<string>',
oauthClientSecret: '<string>',
oauthGrantType: '<string>',
oauthScope: '<string>',
oauthUrl: '<string>',
webhookSecret: '<string>',
webhookUrl: '<string>'
}
]
},
name: '<string>',
orgUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
ownerUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
ruleFilters: {scheduleUuids: ['AAAAAAAAAAAAAAAAAAAAAA'], triggerBackoffSecs: 123},
triggers: [
{
activityEvent: {},
componentCompositeUuids: ['AAAAAAAAAAAAAAAAAAAAAA'],
componentUuids: ['AAAAAAAAAAAAAAAAAAAAAA'],
deviceLabels: ['<string>'],
deviceUuids: ['AAAAAAAAAAAAAAAAAAAAAA'],
locationUuids: ['AAAAAAAAAAAAAAAAAAAAAA']
}
],
uuid: 'AAAAAAAAAAAAAAAAAAAAAA'
}
})
};
fetch('https://api2.rhombussystems.com/api/rules/updateRule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/rules/updateRule")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ruleUpdate\": {\n \"action\": {\n \"activateLocationLockdown\": {\n \"locationLockdownPlanUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n },\n \"alertAction\": true,\n \"audioPlaybackActions\": [\n {\n \"audioClipUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"audioGateways\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"loopDurationSec\": 123,\n \"playCount\": 123\n }\n ],\n \"cancelLoopingAudioPlaybackAction\": {\n \"_audioDevices\": [\n \"AAAAAAAAAAAAAAAAAAAAAA.v0\"\n ],\n \"audioDevices\": [\n \"AAAAAAAAAAAAAAAAAAAAAA.v0\"\n ]\n },\n \"changeComponentCompositeAccessStateActions\": [\n {\n \"alwaysCreateOverrideIfNoFirstIn\": true,\n \"componentCompositeUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"expireTimeDelaySeconds\": 123,\n \"expireTimeOfDayLocalSeconds\": 123,\n \"useFirstInRulesIfPossible\": true\n }\n ],\n \"connectAudioDeviceToMobileAppAction\": {\n \"audioDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"doorUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"targetUserUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ]\n },\n \"connectAudioDeviceToPhoneNumberAction\": {\n \"audioDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"doorUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"optionalGreeting\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"createAlarmAction\": {\n \"attachMediaToActiveAlarm\": true,\n \"entryInstructions\": \"<string>\",\n \"exclusiveEmergencyContact\": true,\n \"exclusiveEntryInstructions\": true,\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"mediaDeviceUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA.v0\"\n ],\n \"reason\": \"<string>\",\n \"subLocationsHierarchyKey\": \"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA\"\n },\n \"customActions\": [\n {\n \"headers\": {},\n \"path\": \"<string>\"\n }\n ],\n \"customLLMActions\": [\n {\n \"deviceActivityEvents\": {},\n \"deviceFacetUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA.v0\"\n ],\n \"orgUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"promptUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"timestampMs\": 123\n }\n ],\n \"emailAuditLogExportActions\": [\n {\n \"includeActions\": [\n \"<string>\"\n ],\n \"includeApiInvocation\": true,\n \"lookbackCount\": 123,\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"timezoneId\": \"<string>\"\n }\n ],\n \"enableDisableAudioRecordActions\": [\n {\n \"audioDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"enable\": true\n }\n ],\n \"integrationCommandActions\": [\n {\n \"commandPayload\": \"<string>\",\n \"delaySecs\": 123\n }\n ],\n \"integrationNotificationActions\": [\n {\n \"notificationEntity\": \"<string>\",\n \"notificationTarget\": \"<string>\"\n }\n ],\n \"liveNotificationAction\": true,\n \"remoteDoorUnlockActions\": [\n {\n \"doorId\": \"<string>\",\n \"placeId\": \"<string>\"\n }\n ],\n \"robotActions\": [\n {\n \"mapUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"pose\": {\n \"orientation\": [\n 123\n ],\n \"position\": [\n 123\n ]\n },\n \"routeUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"waypointUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"deviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n }\n ],\n \"thirdPartyAudioPlaybackAction\": {\n \"audioFileName\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"loopDurationSec\": 123,\n \"password\": \"<string>\",\n \"playCount\": 123,\n \"proxyDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"username\": \"<string>\"\n },\n \"thirdPartyStrobeSirenAction\": {\n \"durationSec\": 123,\n \"ipAddress\": \"<string>\",\n \"lightColors\": [\n \"<string>\"\n ],\n \"lightIntensity\": 123,\n \"lightPattern\": \"<string>\",\n \"lightSpeed\": 123,\n \"password\": \"<string>\",\n \"profileName\": \"<string>\",\n \"proxyDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"sirenIntensity\": 123,\n \"sirenPattern\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"triggerComponentRelayActions\": [\n {\n \"componentUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"overrideRelayDurationMs\": 123,\n \"overrideRelayDurationSec\": 123,\n \"ownerDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n }\n ],\n \"webhookActions\": [\n {\n \"headers\": {},\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"oauthGrantType\": \"<string>\",\n \"oauthScope\": \"<string>\",\n \"oauthUrl\": \"<string>\",\n \"webhookSecret\": \"<string>\",\n \"webhookUrl\": \"<string>\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"orgUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"ownerUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"ruleFilters\": {\n \"scheduleUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"triggerBackoffSecs\": 123\n },\n \"triggers\": [\n {\n \"activityEvent\": {},\n \"componentCompositeUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"componentUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"deviceLabels\": [\n \"<string>\"\n ],\n \"deviceUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"locationUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ]\n }\n ],\n \"uuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n }\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>",
"webhookSecrets": {}
}Authorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Headers
Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.
Available options:
api-token, api, partner-api-token, partner-api Body
application/json
Request object for updating a rule.
Updated rule data
Show child attributes
Show child attributes
Response
200 - application/json
OK
Response object for updating a rule.
Shared secret per webhook action, keyed by webhook URL. Use it to verify the x-rhombus-signature-sha256 HMAC on webhooks Rhombus sends when this rule fires. Existing webhook URLs keep their previous secret; newly added webhook URLs get a new secret returned here. Store it securely.
Show child attributes
Show child attributes
Last modified on August 22, 2026
⌘I