Rules

Create rule

Create a rule

POST/api/rules/createRule

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the write scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for creating a rule.

ruleobjectbody

Updated rule data

Show child attributes

actionobjectbody

The action to take when this lockdown rule is triggered.

Show child attributes

activateLocationLockdownobjectbody

Show child attributes

locationLockdownPlanUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

alertActionboolean | nullbody

audioPlaybackActionsobject[] | nullbody

Show child attributes

audioClipUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

audioGatewaysstring<RUUID>[] | nullbody

loopDurationSecinteger<int32> | nullbody

playCountinteger<int32> | nullbody

sourceenum<string>body

Available options: ON_DEVICE, STREAM

cancelLoopingAudioPlaybackActionobjectbody

Show child attributes

_audioDevicesstring<DeviceFacetUuid>[] | nullbody

audioDevicesstring<DeviceFacetUuid>[] | nullbody

changeComponentCompositeAccessStateActionsobject[] | nullbody

Show child attributes

accessStateenum<string>body

Available options: UNLOCKED, ACCESS_CONTROLLED

alwaysCreateOverrideIfNoFirstInboolean | nullbody

componentCompositeUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

expirationStrategyenum<string>body

Available options: TIME_DELAY, TIME_OF_DAY_LOCAL, NONE

expireTimeDelaySecondsinteger<int64> | nullbody

expireTimeOfDayLocalSecondsinteger<int64> | nullbody

useFirstInRulesIfPossibleboolean | nullbody

versioninteger<int32> | nullbody

connectAudioDeviceToMobileAppActionobjectbody

Show child attributes

audioDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceTypeenum<string>body

Available options: BLE_TRACKER, CAMERA, DOOR_SENSOR, ENVIRONMENTAL_SENSOR, OCCUPANCY_SENSOR, AUDIO_GATEWAY, EXECUTABLE, BADGE_READER, DOOR_CONTROLLER, BLE_BUTTON, IO_BOARD, ENVIRONMENTAL_GATEWAY, NVR, ROBOT, UNKNOWN

doorUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

targetDoorStationUuidsstring<RUUID>[] | nullbody

targetUserUuidsstring<RUUID>[] | nullbody

connectAudioDeviceToPhoneNumberActionobjectbody

Show child attributes

audioDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceTypeenum<string>body

doorUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

optionalGreetingstring | nullbody

phoneNumberstring | nullbody

createAlarmActionobjectbody

Show child attributes

attachMediaToActiveAlarmboolean | nullbody

entryInstructionsstring | nullbody

exclusiveEmergencyContactboolean | nullbody

exclusiveEntryInstructionsboolean | nullbody

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

mediaDeviceUuidsstring<DeviceFacetUuid>[] | nullbody

onsiteEmergencyContactobjectbody

Show child attributes

namestring | nullbodyrequired

The name of the emergency contact.

phoneNumberstring | nullbodyrequired

The phone number for this emergency contact.

reasonstring | nullbody

sirenSettingsobjectbody

Show child attributes

audioGatewaysstring<RUUID>[] | nullbodyrequired

UUIDs of audio gateways used to play this siren.

clipUuidstring<RUUID> | nullbodyrequired

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

durationSecondsinteger<int32> | nullbody

The duration (in seconds) to loop the clip audio for the siren.

playCountinteger<int32> | nullbody

The number of times to play the clip audio for the siren.

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | nullbody

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

triggerTypeenum<string>body

Available options: PANIC_BUTTON, ALARM_INTEGRATION

customActionsobject[] | nullbody

Show child attributes

headersobject | nullbody

pathstring | nullbody

customLLMActionsobject[] | nullbody

Show child attributes

deviceActivityEventsobject | nullbody

Show child attributes

activitiesenum<string>[] | nullbody

boundingBoxesobject[] | nullbody

Show child attributes

activityenum<string>body

Available options: SOUND_LOUD, SOUND_GUN_SHOT, TAMPER, VISUAL_TAMPER, MOTION_TAMPER, MOTION, MOTION_HUMAN, MOTION_CAR, MOTION_ANIMAL, MOTION_PACKAGE, PACKAGE_ARRIVED, PACKAGE_DEPARTED, FACE, FACE_IDENTIFIED, FACE_UNIDENTIFIED, FACE_BLACKLISTED, FACE_ALERT, POSE_ANOMALOUS, POSE_FALL, LICENSEPLATE, LICENSEPLATE_IDENTIFIED, LICENSEPLATE_UNIDENTIFIED, LICENSEPLATE_ALERT, LICENSEPLATE_BLACKLISTED, LICENSEPLATE_TRUSTED, PEOPLECOUNT_HIGH, PEOPLECOUNT_HIGH_RESET, PEOPLECOUNT_LOW, PEOPLECOUNT_LOW_RESET, HUMAN_ENTER, HUMAN_EXIT, CAR_ENTER, CAR_EXIT, TEMPERATURE_EXCEEDED_HIGH, TEMPERATURE_EXCEEDED_LOW, HUMIDITY_EXCEEDED_HIGH, HUMIDITY_EXCEEDED_LOW, PM25_EXCEEDED_HIGH, TVOC_EXCEEDED_HIGH, ETOH_EXCEEDED_HIGH, IAQ_EXCEEDED_HIGH, CO2_EXCEEDED_HIGH, CO2_EXCEEDED_LOW, PROBE_TEMPERATURE_EXCEEDED_HIGH, PROBE_TEMPERATURE_EXCEEDED_LOW, PROBE_DISCONNECTED, PROBE_CONNECTED, HEAT_INDEX_EXCEEDED_HIGH, PRESSURE_EXCEEDED_HIGH, PRESSURE_EXCEEDED_LOW, PM10_EXCEEDED_HIGH, PM40_EXCEEDED_HIGH, PM100_EXCEEDED_HIGH, VOC_IDX_EXCEEDED_HIGH, NOX_IDX_EXCEEDED_HIGH, FORMALDEHYDE_EXCEEDED_HIGH, CARBON_MONOXIDE_EXCEEDED_HIGH, AQI_EXCEEDED_HIGH, DOOR_AJAR, DOOR_OPENED, DOOR_CLOSED, BUTTON_SINGLE_PRESSED, BUTTON_DOUBLE_PRESSED, BUTTON_LONG_PRESSED, TAG_ARRIVED, TAG_DEPARTED, TAG_MOVED, TAG_POSITIONING_CHANGED, TAG_BOUNDARY_INGRESS, TAG_BOUNDARY_EGRESS, TAG_PANIC, BADGE_AUTHORIZED, BADGE_UNAUTHORIZED, BADGE_UNAUTHORIZED_V2, BADGE_AJAR, BADGE_MANUAL, BADGE_FORCED_OPEN, BADGE_LOCKDOWN, BADGE_REQUEST_TO_EXIT, BADGE_DURESS, BADGE_SECURITY_BREACH, BADGE_TAMPER, BADGE_FACE_MISMATCH, POS_ORDER, GUN_DETECT_EVENT, IOT_SOUND_AGGRESSION, IOT_SOUND_HELP, IOT_AIR_CO, IOT_AIR_CO2, IOT_AIR_MASKING, IOT_AIR_THC, IOT_AIR_VAPE, IOT_AIR_VOC, IOT_AIR_TEMP, IOT_TAMPER, IOT_GUNSHOT, IOT_BUTTON_SINGLE_CLICK, IOT_BUTTON_DOUBLE_CLICK, IOT_BUTTON_HOLD, IOT_PANIC_BUTTON_TRIGGERED, AUDIO_SOUND_SIGNIFICANT, AUDIO_SOUND_LOUD, AUDIO_SOUND_ABUSIVE, AUDIO_SOUND_GREETING, AUDIO_SOUND_HELP, AUDIO_SOUND_GUN, AUDIO_SOUND_GLASS_BREAK, AUDIO_SOUND_ALARM_SMOKE_FIRE, AUDIO_SOUND_ALARM_CARBON_MONOXIDE, AUDIO_SOUND_SIREN, CLIMATE_VOC, CLIMATE_VAPE, CLIMATE_SMOKE, CLIMATE_THC, CLIMATE_CO2, CLIMATE_ETOH, CLIMATE_PM25, CLIMATE_IAQ, CLIMATE_LEAK, SOUND_AGGRESSION, SOUND_HELP, AIR_CO, AIR_CO2, AIR_MASKING, AIR_THC, AIR_VAPE, AIR_VOC, MASK_MISSING, HELMET_MISSING, GLOVES_MISSING, PIR_OCCUPIED, PIR_MOVEMENT, PIR_VACANT, CUSTOM, VISITOR_ARRIVED, VISITOR_DEPARTED, AC_DR_CONNECTED, AC_DR_DISCONNECTED, AC_DPI_DOOR_OPEN, AC_DPI_DOOR_CLOSED, AC_DPI_DOOR_AJAR, AC_DPI_DOOR_FORCED_OPEN, AC_DSR_UNLOCKED, AC_DSR_LOCKED, AC_DB_TRIGGERED, AC_PANIC_BUTTON_TRIGGERED, AC_REMOTE_UNLOCK, AC_BADGE_AUTHORIZED, AC_BADGE_UNAUTHORIZED, AC_BADGE_FACE_MISMATCH, AC_LOCKDOWN_ACTIVATED, AC_LOCKDOWN_DEACTIVATED, AC_LOCKDOWN_PLAN_SWITCHED, AC_TAMPER_PROX, AC_TAMPER_ACCEL, AC_TAMPER_SWITCH, AC_GR_ACTIVE, AC_GR_INACTIVE, AC_GI_ACTIVE, AC_GI_INACTIVE, AC_REX_ACTIVE, AC_REX_INACTIVE, AC_APERIO_DEVICE_DISCONNECTED, AC_APERIO_DEVICE_CONNECTED, AC_APERIO_DEVICE_REBOOT, AC_APERIO_DEVICE_TAMPER, AC_APERIO_LOW_BATTERY, AC_APERIO_FLAT_BATTERY, AC_APERIO_OK_BATTERY, AC_SCHLAGE_GW_DISCONNECTED, AC_SCHLAGE_GW_CONNECTED, AC_SCHLAGE_APM_DISCONNECTED, AC_SCHLAGE_APM_CONNECTED, AC_SCHLAGE_LOW_BATTERY, AC_SCHLAGE_CRITICAL_BATTERY, AC_SCHLAGE_OK_BATTERY, POWER_SWITCH_BATTERY, POWER_SWITCH_PRIMARY, AI_SEARCH_MATCH, AI_SEARCH_MATCH_PERSON_SMOKING, AI_SEARCH_MATCH_PERSON_ON_PHONE, AI_SEARCH_MATCH_PERSON_FALLING, CUSTOM_LLM_BOOLEAN_TRUE, CUSTOM_LLM_BOOLEAN_FALSE, CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW, CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH, ALM_AUTHORITIES_CONTACTED, ALM_MONITORING_ENABLED, ALM_MONITORING_DISABLED, ALM_MONITORING_SETTINGS_CHANGE, ALM_THREAT_CASE_CLOSED, ALM_THREAT_DETECTED, ALM_MONITORING_EVENT_DETECTED, ROBOT_DOG_DETECTED, ROBOT_ARRIVED_AT_WAYPOINT, ROBOT_ARRIVED_AT_POSE, ROBOT_WAITING_AT_POSE, ROBOT_MANUAL_CMD_VEL, ROBOT_MANUAL_ACTION, ROBOT_MANUAL_POSTURE, ROBOT_NAVIGATE_TO_POSE_START, ROBOT_NAVIGATE_TO_POSE_END, ROBOT_NAVIGATE_TO_HOME_START, ROBOT_NAVIGATE_TO_HOME_END, ROBOT_NAVIGATE_TO_WAYPOINT_START, ROBOT_NAVIGATE_TO_WAYPOINT_END, ROBOT_ROUTE_RUN_START, ROBOT_ROUTE_RUN_END, ROBOT_LOW_BATTERY_DOCKING, ROBOT_IDLE_DOCKING, ROBOT_EMERGENCY, LOITER_HUMAN, INACTIVITY_HUMAN, INACTIVITY_CAR, GROUP_ENTRY, ONGUARD_BADGE_AUTHORIZED, ONGUARD_BADGE_ANOMALY, ONGUARD_NO_ENTRY_MADE, ELEMENTS_BADGE_AUTHORIZED, ELEMENTS_BADGE_ANOMALY, ELEMENTS_NO_ENTRY_MADE, NETBOX_BADGE_AUTHORIZED, NETBOX_BADGE_ANOMALY, NETBOX_NO_ENTRY_MADE, THERMAL_TEMPERATURE_ALARM, THERMAL_TEMPERATURE_WARNING, THERMAL_FIRE_DETECTED, THERMAL_SMOKING_DETECTED, THERMAL_FIRE_VERIFIED, THERMAL_HEAT_NO_THREAT, THERMAL_VISUAL_HOTSPOT, THERMAL_VISUAL_HEAT_RISE, THERMAL_VISUAL_WARM_BODY, UNKNOWN

alertboolean | nullbody

bottominteger<int32> | nullbody

confidencenumber<float> | nullbody

croppedImageLocatorstring | nullbody

customActivityColorenum<string>body

Available options: BLUE, RED, PURPLE, TAN, ORANGE, TEAL, GRAY, BLACK

customActivityDescriptionstring | nullbody

customActivityDisplayNamestring | nullbody

dwellingboolean | nullbody

faceNamestring | nullbody

inMotionboolean | nullbody

keypointsV2object | nullbody

Show child attributes

xinteger<int32> | nullbody

yinteger<int32> | nullbody

leftinteger<int32> | nullbody

licensePlatestring | nullbody

loudnessinteger<int32> | nullbody

objectIdinteger<int32> | nullbody

posestring | nullbody

relativeSecondnumber<float> | nullbody

rightinteger<int32> | nullbody

sensorValTypeobjectbody

Show child attributes

sensorBooleanboolean | nullbody

sensorDoublenumber<double> | nullbody

sensorLonginteger<int64> | nullbody

stableTrackIdinteger<int32> | nullbody

toastOrderIdInfoobjectbody

Show child attributes

employeeNamestring | nullbody

guidstring | nullbody

locationNamestring | nullbody

restaurantNamestring | nullbody

toastCheckInfoobjectbody

Show child attributes

totalAmountnumber<double> | nullbody

topinteger<int32> | nullbody

unidentifiedFaceIdstring | nullbody

vehicleNamestring | nullbody

durationSecinteger<int32> | nullbody

timestampMsinteger<int64> | nullbody

deviceFacetUuidsstring<DeviceFacetUuid>[] | nullbody

orgUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

promptUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

timestampMsinteger<int64> | nullbody

emailAuditLogExportActionsobject[] | nullbody

Show child attributes

includeActionsstring[] | nullbody

includeApiInvocationboolean | nullbody

lookbackCountinteger<int32> | nullbody

lookbackTypeenum<string>body

Available options: ROLLING, PREVIOUS_DAY, PREVIOUS_WEEK, PREVIOUS_MONTH

lookbackUnitenum<string>body

Available options: HOURS, DAYS, WEEKS

recipientEmailsstring[] | nullbody

timezoneIdstring | nullbody

enableDisableAudioRecordActionsobject[] | nullbody

Show child attributes

audioDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

enableboolean | nullbody

integrationCommandActionsobject[] | nullbody

Show child attributes

commandPayloadstring | nullbody

delaySecsinteger<int32> | nullbody

integrationenum<string>body

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationNotificationActionsobject[] | nullbody

Show child attributes

integrationenum<string>body

notificationEntitystring | nullbody

notificationTargetstring | nullbody

liveNotificationActionboolean | nullbody

remoteDoorUnlockActionsobject[] | nullbody

Show child attributes

doorIdstring | nullbody

placeIdstring | nullbody

systemenum<string>body

Available options: BRIVO, OPENPATH, KISI, PLACEOS, GENEA, PDK, INNER_RANGE, RHOMBUS, HONEYWELL_ELEMENTS, UNKNOWN

robotActionsobject[] | nullbody

Show child attributes

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>body

Available options: DEPLOY, UNKNOWN

One of:

Show Deploy Robot variant

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>body

Available options: DEPLOY, UNKNOWN

mapUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

navTypeenum<string>body

Available options: ROUTE, PATROL, WAYPOINT, POSE

patrolUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

poseobjectbody

Show child attributes

orientationnumber<double>[] | nullbody

Items: 4 to 4

positionnumber<double>[] | nullbody

Items: 3 to 3

routeUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

waypointUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show No Op variant

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>body

Available options: DEPLOY, UNKNOWN

thirdPartyAudioPlaybackActionobjectbody

Show child attributes

audioFileNamestring | nullbody

ipAddressstring | nullbody

loopDurationSecinteger<int32> | nullbody

passwordstring | nullbody

playCountinteger<int32> | nullbody

proxyDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | nullbody

thirdPartyStrobeSirenActionobjectbody

Show child attributes

durationSecinteger<int32> | nullbody

ipAddressstring | nullbody

lightColorsstring[] | nullbody

lightIntensityinteger<int32> | nullbody

lightPatternstring | nullbody

lightSpeedinteger<int32> | nullbody

passwordstring | nullbody

profileNamestring | nullbody

proxyDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

sirenIntensityinteger<int32> | nullbody

sirenPatternstring | nullbody

usernamestring | nullbody

triggerComponentRelayActionsobject[] | nullbody

Show child attributes

componentUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

outputTypeenum<string>body

Available options: TRANSIENT, STEADY

overrideRelayDurationMsinteger<int32> | nullbody

overrideRelayDurationSecinteger<int32> | nullbody

ownerDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

stateenum<string>body

Available options: ACTIVE, INACTIVE, UNKNOWN

versioninteger<int32> | nullbody

webhookActionsobject[] | nullbody

Show child attributes

headersobject | nullbody

oauthClientIdstring | nullbody

oauthClientSecretstring | nullbody

oauthGrantTypestring | nullbody

oauthScopestring | nullbody

oauthUrlstring | nullbody

webhookSecretstring | nullbody

webhookUrlstring | nullbody

conjunctionenum<string>body

Available options: AND, OR, UNKNOWN

namestring | nullbody

orgUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ruleFiltersobjectbody

Optional filters to apply to this lockdown rule.

Show child attributes

scheduleUuidsstring<RUUID>[] | nullbody

List of schedules that apply to the rule. at least one schedule must be met to trigger this rule. If null, then this rule is enabled all the time.

triggerBackoffSecsinteger<int32> | nullbody

Number of seconds to back off after rule is triggered before triggering again. I.e. this rule will only trigger once every X seconds regardless of how many triggering events occur within that window

ruleTypeenum<string>body

Available options: BUTTON_DEFINED, USER_DEFINED, DOORBELL_CAMERA_DEFINED, DOOR_CONTROLLER_DEFINED, LOCKDOWN_PLAN_DEFINED, CUSTOM_LLM_DEFINED, ROBOT_DEFINED, SCHEDULED_REPORT_DEFINED

triggersobject[] | nullbody

Show child attributes

typeenum<string>body

Available options: DEVICE_ACTIVITY_EVENT, AUDIT_EVENT, DIAGNOSTIC_EVENT, ALERT_MONITORING_EVENT, BADGE_INTEGRATION_EVENT, SCHEDULED_EVENT, VISION_LLM_EVENT, RECURRING_EVENT, LOCATION_LOCKDOWN_ACTIVATED_EVENT, LOCATION_LOCKDOWN_DEACTIVATED_EVENT, BUTTON_INTEGRATION_EVENT, CUSTOM_LLM_EVENT, SHELLY_INTEGRATION_EVENT, INCOMING_WEBHOOK_EVENT, UNKNOWN

One of:

Show Device Activity variant

typeenum<string>body

activityEventobject | nullbody

Show child attributes

activityEventenum<string>body

componentCompositeUuidsstring<RUUID>[] | nullbody

componentUuidsstring<RUUID>[] | nullbody

deviceLabelsstring[] | nullbody

deviceUuidsstring<RUUID>[] | nullbody

locationUuidsstring<RUUID>[] | nullbody

Show Audit variant

typeenum<string>body

auditEventobject | nullbody

Show child attributes

auditEventenum<string>body

Available options: THREAT_CASE_ESCALATED, THREAT_CASE_CANCELLED, THREAT_CASE_DISMISSED, THREAT_CASE_DELETED, THREAT_CASE_DELETE_BY_STATUS, PIN_CREATED, PIN_DELETED, ALM_PIN_CREATE, ALM_PIN_BULK_CREATE, ALM_PIN_UPDATE, ALM_PIN_ROTATE, ALM_PIN_BULK_ROTATE, ALM_PIN_DELETE, ALM_PIN_KEY_IN, ALM_PIN_KEY_IN_FAILED, BASIC_AUTH_SUCCESS, BASIC_AUTH_FAILURE, SAML_LOGIN_WEB, LOGIN_WEB, PASSWORDLESS_LOGIN_WEB, PARTNER_LOGIN_WEB, PARTNER_PASSWORDLESS_LOGIN_WEB, SAML_LOGIN_FAILURE_WEB, LOGIN_FAILURE_WEB, RHOMBUS_KEY_LOGIN, RHOMBUS_KEY_PASSWORDLESS_LOGIN, RHOMBUS_KEY_SAML_LOGIN, LOGOUT_WEB, PARTNER_LOGOUT_WEB, WEB_CONSOLE_ACCESS, MOBILE_CONSOLE_ACCESS, SAML_LOGIN_MOBILE, PARTNER_LOGIN_MOBILE, PARTNER_PASSWORDLESS_LOGIN_MOBILE, LOGIN_MOBILE, PASSWORDLESS_LOGIN_MOBILE, SAML_LOGIN_FAILURE_MOBILE, LOGIN_FAILURE_MOBILE, LOGOUT_MOBILE, PARTNER_LOGOUT_MOBILE, MOBILE_ACCESS, PARTNER_LOGIN_MOBIlE_REFRESH, LOGIN_MOBIlE_REFRESH, RHOMBUS_KEY_LOGIN_REFRESH, CAMERA_WIFI_NETWORK_CHANGED, CAMERA_FORCED_REBOOT, AUDIO_GATEWAY_FORCED_REBOOT, ENVIRONMENTAL_GATEWAY_FORCED_REBOOT, DOORBELL_CAMERA_FORCED_REBOOT, BADGE_READER_FORCED_REBOOT, NVR_FORCED_REBOOT, FIRMWARE_UPDATE_CAMERA, DELETE_CAMERA, DELETE_USER, USER_SESSIONS_LOGOUT, DELETE_LOCATION, LOCATION_CREATE, LOCATION_UPDATED, DELETE_ROLE, ERASE_CAMERA, POLICY_UPDATE, POLICY_DELETE, POLICY_PAUSED_LOCATION, POLICY_PAUSED_DEVICE, POLICY_PAUSED_COMPONENT_COMPOSITE, CREATE_POLICY_ADDENDUM, DEVICE_REGISTERED, PENDING_REGISTRATION_CREATE, PENDING_REGISTRATION_REMOVED, PENDING_REGISTRATION_UPDATED, DEVICE_UPDATE, DEVICE_SETTINGS_UPDATE, REVERT_TO_DEFAULTS, DEVICE_FEATURE_UPDATE, DEVICE_ORG_REASSIGN, CLAIMKEY_RENEWAL_CREATED, LICENSES_CLAIMED, LICENSES_RETURNED, LICENSE_ASSIGNED, LICENSE_CREATED, LICENSE_UPDATED, USER_UPDATE, USER_CREATE, USER_IMPORT, BULK_PROVISION_CREDENTIALS, ROLE_CREATE, POLICY_CREATE, PARTNER_CLIENT_CREATE, PARTNER_CLIENT_DELETE, PARTNER_CUSTOMIZE_CLIENT, PARTNER_CUSTOMIZE_CLIENT_DEVICE, ORG_UPDATE, DELETE_ORG, DISABLE_ORG, CREATE_ORG, ROLE_UPDATE, USER_ROLE_UPDATE, USER_EMAIL_UPDATE, TIMELAPSE_CREATE, TIMELAPSE_DELETE, ALERT_DISMISS, ALL_ALERT_DISMISS, SAVED_CLIP_CREATE, SAVED_CLIP_DELETE, CLIP_GROUP_CREATED, CLIP_GROUP_DELETE, SHARED_CLIP_DELETE, SHARED_CLIP_CREATE, SHARED_LINK_SENT, SHARED_LIVE_VIDEO_STREAM_WITH_PASSWORD_CREATE, SHARED_LIVE_VIDEO_STREAM_WITHOUT_PASSWORD_CREATE, SHARED_LIVE_VIDEO_STREAM_DELETE, SHARED_VIDEOWALL_WITH_PASSWORD_CREATE, SHARED_VIDEOWALL_WITHOUT_PASSWORD_CREATE, SHARED_VIDEOWALL_DELETE, RAW_HTTP_STREAM_CREATED, RAW_HTTP_STREAM_DELETED, SETUP_VIRTUAL_MFA_DEVICE, DELETE_VIRTUAL_MFA_DEVICE, SETUP_SCIM_API_ACCESS, REVOKE_SCIM_API_ACCESS, AUDIT_EXPORT, COUNT_EXPORT, DIAGNOSTIC_EXPORT, INVENTORY_EXPORT, USERS_EXPORT, UPTIME_EXPORT, ALM_EVENT_EXPORT, SUPPORT_TICKET_OPEN, RMA_OPEN, FEEDBACK_CREATE, SUPPORT_ACCESS_GRANT, SUPPORT_ACCESS_REVOKE, SUPPORT_PARTNER_ADD, SUPPORT_PARTNER_REMOVE, SUPPORT_PARTNER_LOGIN_ACCESS_EXPIRED, SUPPORT_SEARCH_TICKETS, ACCEPT_UAP, ACCEPT_RHOMBUS_UAP, ACCEPT_ALERTMONITORING_UAP, CREATE_SEEKPOINT, DELETE_CUSTOM_SEEKPOINT, UPDATE_INTEGRATION_SAML, UPDATE_INTEGRATION_SLACK, UPDATE_INTEGRATION_SLACK_V2, DELETE_INTEGRATION_SLACK_V2, UPDATE_INTEGRATION_BOX, DELETE_INTEGRATION_BOX, UPDATE_INTEGRATION_GOOGLE, DELETE_INTEGRATION_GOOGLE, UPDATE_INTEGRATION_GOOGLE_V2, DELETE_INTEGRATION_GOOGLE_V2, UPDATE_INTEGRATION_PAGERDUTY, DELETE_INTEGRATION_PAGERDUTY, UPDATE_INTEGRATION_SERVICENOW, DELETE_INTEGRATION_SERVICENOW, UPDATE_INTEGRATION_OFFICE365, DELETE_INTEGRATION_OFFICE365, UPDATE_INTEGRATION_DROPBOX, DELETE_INTEGRATION_DROPBOX, UPDATE_INTEGRATION_SQUARE, DELETE_INTEGRATION_SQUARE, UPDATE_INTEGRATION_AWS, DELETE_INTEGRATION_AWS, UPDATE_INTEGRATION_HALO, DELETE_INTEGRATION_HALO, UPDATE_INTEGRATION_TRITON, DELETE_INTEGRATION_TRITON, UPDATE_INTEGRATION_WEBHOOK, DELETE_INTEGRATION_WEBHOOK, UPDATE_INTEGRATION_EMAIL, DELETE_INTEGRATION_EMAIL, UPDATE_INTEGRATION_MATTERMOST, DELETE_INTEGRATION_MATTERMOST, UPDATE_INTEGRATION_OPENPATH, DELETE_INTEGRATION_OPENPATH, UPDATE_INTEGRATION_AVIGILON_ALTA, DELETE_INTEGRATION_AVIGILON_ALTA, UPDATE_INTEGRATION_DICE, DELETE_INTEGRATION_DICE, UPDATE_INTEGRATION_LUMEO, DELETE_INTEGRATION_LUMEO, UPDATE_INTEGRATION_DEVICE, DELETE_INTEGRATION_DEVICE, UPDATE_INTEGRATION_GUESTMANAGEMENT, DELETE_INTEGRATION_GUESTMANAGEMENT, UPDATE_GUESTMANAGEMENT_SETTINGS, DELETE_GUESTMANAGEMENT_SETTINGS, INVITE_GUEST, CREATE_GUEST, CHECKIN_GUEST, CHECKOUT_GUEST, UPDATE_GUEST, DELETE_GUEST, ACTIVATE_KIOSK, UPDATE_INTEGRATION_OMNIALERT, DELETE_INTEGRATION_OMNIALERT, UPDATE_INTEGRATION_OPENTECHALLIANCE, DELETE_INTEGRATION_OPENTECHALLIANCE, UPDATE_INTEGRATION_TOAST, DELETE_INTEGRATION_TOAST, UPDATE_INTEGRATION_KISI, DELETE_INTEGRATION_KISI, UPDATE_INTEGRATION_BRIVO, DELETE_INTEGRATION_BRIVO, UPDATE_INTEGRATION_BUTTERFLYMX, DELETE_INTEGRATION_BUTTERFLYMX, UPDATE_INTEGRATION_ENVOY, DELETE_INTEGRATION_ENVOY, CREATE_ENVOY_INVITE, UPDATE_INTEGRATION_SALTO, UPDATE_INTEGRATION_PDK, DELETE_INTEGRATION_PDK, UPDATE_INTEGRATION_GENEA, DELETE_INTEGRATION_GENEA, UPDATE_INTEGRATION_MICROSOFTTEAMS, DELETE_INTEGRATION_MICROSOFTTEAMS, UPDATE_INTEGRATION_AMT, DELETE_INTEGRATION_AMT, UPDATE_INTEGRATION_PLACEOS, DELETE_INTEGRATION_PLACEOS, UPDATE_INTEGRATION_INTUIFACE, DELETE_INTEGRATION_INTUIFACE, UPDATE_INTEGRATION_INFORMACAST, DELETE_INTEGRATION_INFORMACAST, UPDATE_INTEGRATION_BOULEVARD, DELETE_INTEGRATION_BOULEVARD, UPDATE_INTEGRATION_INNERRANGE, DELETE_INTEGRATION_INNERRANGE, UPDATE_INTEGRATION_HONEYWELL_ELEMENTS, DELETE_INTEGRATION_HONEYWELL_ELEMENTS, UPDATE_INTEGRATION_HONEYWELL_ONGUARD, DELETE_INTEGRATION_HONEYWELL_ONGUARD, UPDATE_INTEGRATION_SHELLY, DELETE_INTEGRATION_SHELLY, SEND_INTEGRATION_COMMAND_SHELLY, UPDATE_INTEGRATION_FLIC, DELETE_INTEGRATION_FLIC, UPDATE_INTEGRATION_NINEONEONECELLULAR, DELETE_INTEGRATION_NINEONEONECELLULAR, UPDATE_INTEGRATION_PIMLOC, DELETE_INTEGRATION_PIMLOC, UPDATE_INTEGRATION_RAPTOR, DELETE_INTEGRATION_RAPTOR, UPDATE_INTEGRATION_LLM, DELETE_INTEGRATION_LLM, UPDATE_INTEGRATION_NOONLIGHT, UPDATE_INTEGRATION_ALARM_MONITORING, ENABLE_LIVE_ALARM_MONITORING, ENABLE_LIVE_ALARM_MONITORING_LOCATION, CREATE_ALARM_MONITORING_SETTINGS, UPDATE_ALARM_MONITORING_SETTINGS, DELETE_ALARM_MONITORING_SETTINGS, ENABLE_ALARM_MONITORING_SETTINGS, DISABLE_ALARM_MONITORING_SETTINGS, ALM_CANCEL_MANUAL_ARM, ALM_CANCEL_MANUAL_DISARM, ALM_THREAT_QUALIFICATION_CREATE, ALM_THREAT_QUALIFICATION_UPDATE, ALM_THREAT_QUALIFICATION_DELETE, REPORT_VEHICLE_EVENT, API_TOKEN_REQUEST, API_TOKEN_REVOKE, API_INVOCATION, API_OAUTH_TOKEN_REQUEST, API_OAUTH_TOKEN_REFRESH, API_OAUTH_TOKEN_REVOKE, API_OAUTH_INVOCATION, API_OAUTH_SUBMIT_APPLICATION, API_OAUTH_UPDATE_APPLICATION, API_OAUTH_DELETE_APPLICATION, API_OAUTH_AUTHORIZE, VIDEO_WALL_CREATE, VIDEO_WALL_UPDATE, VIDEO_WALL_DELETE, VIEW_SHARE_TIMELAPSE, VIEW_SHARE_CLIP, VIEW_SHARE_STREAM, VIEW_SHARE_VIDEOWALL, VIEW_CAMERA_VOD, CAMERA_POLICY_UPDATE, CAMERA_POLICY_CREATE, CAMERA_POLICY_DELETE, TAG_POLICY_UPDATE, TAG_POLICY_CREATE, TAG_POLICY_DELETE, CLIMATE_POLICY_UPDATE, CLIMATE_POLICY_CREATE, CLIMATE_POLICY_DELETE, DOOR_POLICY_UPDATE, DOOR_POLICY_CREATE, DOOR_POLICY_DELETE, DOOR_SCHEDULE_EXCEPTION_UPDATE, DOOR_SCHEDULE_EXCEPTION_CREATE, DOOR_SCHEDULE_EXCEPTION_DELETE, ACCESS_CONTROLLED_DOOR_POLICY_UPDATE, ACCESS_CONTROLLED_DOOR_POLICY_CREATE, ACCESS_CONTROLLED_DOOR_POLICY_DELETE, VIDEO_INTERCOM_POLICY_UPDATE, VIDEO_INTERCOM_POLICY_CREATE, VIDEO_INTERCOM_POLICY_DELETE, OCCUPANCY_POLICY_UPDATE, OCCUPANCY_POLICY_CREATE, OCCUPANCY_POLICY_DELETE, AUDIO_POLICY_UPDATE, AUDIO_POLICY_CREATE, AUDIO_POLICY_DELETE, SCHEDULE_CREATE, SCHEDULE_DELETE, SCHEDULE_UPDATE, CUSTOM_EVENT_CREATE, CUSTOM_EVENT_DELETE, CUSTOM_EVENT_UPDATE, CUSTOM_EVENT_TOS_ACCEPTED, CUSTOM_EVENT_TOS_REVOKED, SUBSCRIPTION_SETUP_INTENT_CREATE, SUBSCRIPTION_CREATE, SUBSCRIPTION_DELETE, SUBSCRIPTION_PAYMENT_METHOD_DELETE, SUBSCRIPTION_PAYMENT_METHOD_UPDATE, SUBSCRIPTION_MAX_SPEND_UPDATE, SUBSCRIPTION_CHECKOUT_SESSION_CREATE, UPLOAD_FLOORPLAN, ORG_AUDIO_RECORD_UPDATE, ORG_AUDIO_ANALYSIS_UPDATE, ORG_LLM_USAGE_UPDATE, ORG_LLM_USAGE_ENABLED, ORG_LLM_USAGE_DISABLED, DOOR_ACCESS_UNLOCK, RHOMBUS_KEY_DOOR_UNLOCK, ELEVATOR_ACCESS_UNLOCK, RHOMBUS_KEY_ELEVATOR_UNLOCK, VIDEO_INTERCOM_TALK, RHOMBUS_KEY_UPDATE_APP_SETTINGS, UPLOAD_ACCESS_CONTROLLED_DOOR, UPLOAD_ACCESS_CONTROLLED_ELEVATOR, UPLOAD_ACCESS_CONTROLLED_ELEVATOR_LANDING, UPLOAD_USER_PROFILE_PICTURE, ACCESS_GRANT_CREATE, ACCESS_GRANT_UPDATE, ACCESS_GRANT_DELETE, ACCESS_REVOCATION_CREATE, ACCESS_REVOCATION_UPDATE, ACCESS_REVOCATION_DELETE, ACCESS_CONTROLLED_DOOR_CREATE, ACCESS_CONTROLLED_DOOR_UPDATE, ACCESS_CONTROLLED_DOOR_DELETE, ACCESS_CONTROLLED_ELEVATOR_CREATE, ACCESS_CONTROLLED_ELEVATOR_UPDATE, ACCESS_CONTROLLED_ELEVATOR_DELETE, ACCESS_CONTROLLED_ELEVATOR_LANDING_CREATE, ACCESS_CONTROLLED_ELEVATOR_LANDING_UPDATE, ACCESS_CONTROLLED_ELEVATOR_LANDING_DELETE, AC_CRED_RHOMBUS_SECURE_CSN_CREATE, AC_CRED_RHOMBUS_SECURE_CSN_UPDATE, AC_CRED_RHOMBUS_SECURE_CSN_DELETE, AC_CRED_RHOMBUS_SECURE_CSN_REVOKED, AC_CRED_RHOMBUS_SECURE_CSN_ASSIGN, AC_CRED_RHOMBUS_SECURE_CSN_UNASSIGN, AC_CRED_RHOMBUS_SECURE_CSN_SUSPEND, AC_CRED_RHOMBUS_SECURE_CSN_UNSUSPEND, AC_CRED_STANDARD_CSN_CREATE, AC_CRED_STANDARD_CSN_UPDATE, AC_CRED_STANDARD_CSN_DELETE, AC_CRED_STANDARD_CSN_REVOKED, AC_CRED_STANDARD_CSN_ASSIGN, AC_CRED_STANDARD_CSN_UNASSIGN, AC_CRED_STANDARD_CSN_SUSPEND, AC_CRED_STANDARD_CSN_UNSUSPEND, AC_CRED_RHOMBUS_SECURE_MOBILE_CREATE, AC_CRED_RHOMBUS_SECURE_MOBILE_UPDATE, AC_CRED_RHOMBUS_SECURE_MOBILE_DELETE, AC_CRED_RHOMBUS_SECURE_MOBILE_REVOKED, AC_CRED_RHOMBUS_SECURE_MOBILE_ASSIGN, AC_CRED_RHOMBUS_SECURE_MOBILE_UNASSIGN, AC_CRED_RHOMBUS_SECURE_MOBILE_SUSPEND, AC_CRED_RHOMBUS_SECURE_MOBILE_UNSUSPEND, AC_CRED_PIN_CREATE, AC_CRED_PIN_BULK_CREATE, AC_CRED_PIN_UPDATE, AC_CRED_PIN_ROTATE, AC_CRED_PIN_BULK_ROTATE, AC_CRED_PIN_DELETE, AC_CRED_PIN_REVOKED, AC_CRED_PIN_ASSIGN, AC_CRED_PIN_UNASSIGN, AC_CRED_PIN_SUSPEND, AC_CRED_PIN_UNSUSPEND, AC_CRED_QR_CREATE, AC_CRED_QR_REVOKED, AC_CRED_QR_DELETE, AC_CRED_QR_SUSPEND, AC_CRED_QR_UNSUSPEND, AC_CRED_RHOMBUS_SECURE_NFC_CREATE, AC_CRED_RHOMBUS_SECURE_NFC_REVOKED, AC_CRED_RHOMBUS_SECURE_NFC_DELETE, AC_CRED_RHOMBUS_SECURE_NFC_SUSPEND, AC_CRED_RHOMBUS_SECURE_NFC_UNSUSPEND, AC_CRED_WIEGAND_CREATE, AC_CRED_WIEGAND_UPDATE, AC_CRED_WIEGAND_DELETE, AC_CRED_WIEGAND_REVOKED, AC_CRED_WIEGAND_ASSIGN, AC_CRED_WIEGAND_UNASSIGN, AC_CRED_WIEGAND_SUSPEND, AC_CRED_WIEGAND_UNSUSPEND, AC_CRED_NOTE_UPDATE, AC_LOCKDOWN_PLAN_CREATED, AC_LOCKDOWN_PLAN_UPDATED, AC_LOCKDOWN_PLAN_DELETED, AC_LOCKDOWN_ACTIVATED, AC_LOCKDOWN_DEACTIVATED, AC_LOCKDOWN_PLAN_SWITCHED, AC_COMPONENT_POWER_CYCLE, AC_DOOR_STATE_OVERRIDE_APPLIED, AC_DOOR_STATE_OVERRIDE_CANCELLED, AC_ELEVATOR_LANDING_ACCESS_STATE_OVERRIDE_APPLIED, AC_ELEVATOR_LANDING_ACCESS_STATE_OVERRIDE_CANCELLED, AC_GUEST_PASS_CREATE, AC_GUEST_PASS_UPDATE, AC_GUEST_PASS_SUSPEND, AC_GUEST_PASS_UNSUSPEND, AC_GUEST_PASS_EXPIRE, AC_GUEST_PASS_DELETE, SCIM_GET_ALL_USERS, SCIM_POST_CREATE_USER, SCIM_PUT_UPDATE_USER, SCIM_PATCH_UPDATE_USER, SCIM_GET_USER_BY_ID, SCIM_DELETE_USER_BY_ID, SCIM_GET_ALL_GROUPS, SCIM_POST_CREATE_GROUP, SCIM_PUT_UPDATE_GROUP, SCIM_PATCH_UPDATE_GROUP, SCIM_GET_GROUP_BY_ID, SCIM_DELETE_GROUP_BY_ID, CREATE_ACCESS_CONTROL_GROUP, UPDATE_ACCESS_CONTROL_GROUP, DELETE_ACCESS_CONTROL_GROUP, RULE_CREATE, RULE_DELETE, RULE_UPDATE, RULE_PAUSE, UPLOAD_FACES, UPDATE_FACE, REPORT_FACE_EVENT, FACE_EVENT_UPDATED, FACE_EVENT_DELETED, FACE_PERSON_CREATED, FACE_PERSON_UPDATED, FACE_PERSON_DELETED, FACE_MATCHMAKER_CREATED, FACE_MATCHMAKER_DELETED, FACE_MATCHMAKER_UPLOADED, FACE_MATCHING_CONFIG_UPDATED, EXPUNGE_FACES_ORG, EXPUNGE_VEHICLES_ORG, DEVICE_NETWORK_CONFIGURATION_CHANGE, KIOSK_UPDATED, KIOSK_DELETED, KIOSK_CREATED, GUEST_DELETED, UPDATE_APERIO_FIRMWARE, UPDATE_INTEGRATION_APERIO, DELETE_INTEGRATION_APERIO, APERIO_GATEWAY_CREATE, APERIO_DOORS_CREATE, APERIO_GATEWAY_REBOOT, APERIO_DTC_CLEAR, THIRD_PARTY_CAMERA_CREATE, THIRD_PARTY_CAMERA_DELETE, THIRD_PARTY_CAMERA_UPDATED, THIRD_PARTY_CAMERA_ASSIGNED_TO_CORE, THIRD_PARTY_CAMERA_ASSIGNED_TO_LITE, THIRD_PARTY_CAMERA_UNASSIGNED, THIRD_PARTY_CAMERA_PASSWORD_CREATE, THIRD_PARTY_CAMERA_PASSWORD_DELTE, THIRD_PARTY_CAMERA_PASSWORD_DELETE, CREATE_CHATBOT_CONFIG, UPDATE_CHATBOT_CONFIG, DELETE_CHATBOT_CONFIG, SUPPORT_AUTHORITY_UPDATE, SUPPORT_AUTHORITY_LOGOUT_ALL, DELETE_DOOR_CONTROLLER, DELETE_DOORBELL_CAMERA, DELETE_BADGE_READER, DELETE_ENVIRONMENTAL_GATEWAY, AC_LOCKDOWN_TEST_MODE_ENABLED, AC_LOCKDOWN_TEST_MODE_DISABLED, CLOUD_ARCHIVING_CONFIG_UPDATE, CLOUD_ARCHIVING_CONFIG_DELETE, SCIM_UPDATE_SETTINGS, INCIDENT_REPORT_CREATE, INCIDENT_REPORT_DELETE, INCIDENT_REPORT_UPDATE, INCIDENT_REPORT_SHARE, DATA_RETENTION_SETTINGS_UPDATE, MSP_DESIGNATION_SYNC, MSP_DESIGNATION_ACTIVATED, MSP_DESIGNATION_REVOKED, MSP_CLIENT_ADOPT, MSP_CLIENT_RELEASE, MSP_CLIENT_DEACTIVATE, MSP_CLIENT_POLICY_UPDATE, MSP_LICENSE_ASSIGN, MSP_LICENSE_RECLAIM, MSP_HARDWARE_MOVE, UNKNOWN

userUuidsstring<RUUID>[] | nullbody

Show Alert Monitoring variant

typeenum<string>body

alertMonitoringRulesEventTypeenum<string>body

Available options: ALARM_CREATED, ALARM_CANCELED, UNKNOWN

locationUuidsstring<RUUID>[] | nullbody

Show Diagnostic variant

typeenum<string>body

deviceLabelsstring[] | nullbody

deviceUuidsstring<RUUID>[] | nullbody

diagnosticEventobject | nullbody

Show child attributes

diagnosticEventenum<string>body

Available options: CAMERA_CONNECTED, CAMERA_DISCONNECTED, STARTUP, GATEWAY_CONNECTED, GATEWAY_DISCONNECTED, UPDATE_STARTED, UPDATE_FIRMWARE_DOWNLOADED, UPDATE_FIRMWARE_APPLIED, UPDATE_STARTING_REBOOT, UPDATE_FAILED_MD5_MISMATCH, UPDATE_FAILED_ACCESS_DENIED, UPDATE_FAILED_MITM, UPDATE_FAILED_CONNNECTION_REFUSED, UPDATE_FAILED_CONNNECTION_TIMEOUT, UPDATE_FAILED_CONNECTION_REFUSED, UPDATE_FAILED_CONNECTION_TIMEOUT, UPDATE_FAILED_DNS_FAILURE, UPDATE_RUNNING, UPDATE_HALTED_FOR_INVESTIGATION, UPDATE_HALT_CLEARED, UPDATE_HALT_STATE_ACTIVE, UPDATE_REFUSED_HALTED, BLE_CONNECTED, BLE_CONNECTION_FAILED, BLE_DISCONNECTED, BLE_OP_SUCCESS, BLE_OP_FAILURE, UPLOAD_CLIP_SUCCESS, UPLOAD_CLIP_FAILURE, NOTIFICATION_FAILURE, USB_FAILURE_REBOOT, PERSISTENT_STORAGE_FAILURE, PING, FORCED_REBOOT, AUTO_REBOOT, AUDIO_HARDWARE_NOT_DETECTED, ENCRYPTED_CONTAINER_FAILURE_CREATE, ENCRYPTED_CONTAINER_FAILURE_OPEN, ENCRYPTED_CONTAINER_FAILURE_MOUNT, VIDEO_HARDWARE_FAILURE, WIFI_NETWORK_CHANGED, AI_ENGINE_DOWNLOADED, AI_ENGINE_DOWNLOAD_FAILED_MD5_MISMATCH, AI_ENGINE_CONFIGURED, AI_ENGINE_CONFIGURATION_FAILED, MITM_FAILURE, SERVER_RECONNECT, AP_CHANGED, WATCHDOG_KILLED_AGENT, WATCHDOG_DID_RESET, CLIMATE_OFFLINE, CLIMATE_ONLINE, CLIMATE_LOW_BATTERY, CLIMATE_PROBE_CONNECTED, CLIMATE_PROBE_DISCONNECTED, DOOR_OFFLINE, DOOR_ONLINE, DOOR_LOW_BATTERY, OCCUPANCY_SENSOR_ONLINE, OCCUPANCY_SENSOR_OFFLINE, OCCUPANCY_SENSOR_LOW_BATTERY, BUTTON_OFFLINE, BUTTON_ONLINE, BUTTON_LOW_BATTERY, PROXIMITY_LOW_BATTERY, ROBOT_LOW_BATTERY, DOOR_CONTROLLER_CONNECTED, DOOR_CONTROLLER_DISCONNECTED, APERIO_LOW_BATTERY, APERIO_FLAT_BATTERY, APERIO_OK_BATTERY, APERIO_GW_CONNECTED, APERIO_GW_DISCONNECTED, APERIO_DEVICE_CONNECTED, APERIO_DEVICE_DISCONNECTED, SCHLAGE_LOW_BATTERY, SCHLAGE_CRITICAL_BATTERY, SCHLAGE_OK_BATTERY, SCHLAGE_GW_CONNECTED, SCHLAGE_GW_DISCONNECTED, SCHLAGE_APM_CONNECTED, SCHLAGE_APM_DISCONNECTED, BADGE_READER_CONNECTED, BADGE_READER_DISCONNECTED, REBOOT, NETWORK_INTERRUPTION, OPENPATH_WEBHOOK_FAILURE, TOAST_WEBHOOK_FAILURE, KISI_WEBHOOK_FAILURE, BRIVO_WEBHOOK_FAILURE, HALO_WEBHOOK_FAILURE, SALTO_WEBHOOK_FAILURE, SQUARE_WEBHOOK_FAILURE, BUTTERFLYMX_WEBHOOK_FAILURE, ENVOY_WEBHOOK_FAILURE, GENEA_WEBHOOK_FAILURE, PRODATAKEY_WEBHOOK_FAILURE, AMT_WEBHOOK_FAILURE, PLACEOS_WEBHOOK_FAILURE, OMNIALERT_WEBHOOK_FAILURE, FLIC_WEBHOOK_FAILURE, SHELLY_WEBHOOK_FAILURE, PIMLOC_WEBHOOK_FAILURE, NINEONEONECELLULAR_WEBHOOK_FAILURE, HONEYWELL_ELEMENTS_WEBHOOK_FAILURE, HONEYWELL_ONGUARD_WEBHOOK_FAILURE, TRITON_WEBHOOK_FAILURE, EXTERNAL_WEBHOOK_FAILURE, VOICE_CALL_INITIATED, VOICE_CALL_ANSWERED, VOICE_CALL_REJECTED_AS_MACHINE, VOICE_CALL_COMPLETED, VOICE_CALL_NO_ANSWER, VOICE_CALL_FAILED, VOICE_CALL_SKIPPED, CV_FAILURE, NFC_HW_FAILURE, CONFIG_ERROR, HW_FAILURE, BLE_HW_RECOVERED, BLE_HW_FAILURE, KEYPAD_ONLINE, KEYPAD_OFFLINE, ALM_OVERAGE_APPROACHING, ALM_OVERAGE_REACHED, ALM_OVERAGE_EXCEEDED, ALM_EXCESSIVE_VERIFICATIONS, KIOSK_OFFLINE, KIOSK_ONLINE, TUNNELED_DEVICE_CONNECTED, TUNNELED_DEVICE_DISCONNECTED, SD_CARD_CHANGED, SD_CARD_NOT_FOUND, SUPERVISION_CUT_DETECTED, SUPERVISION_SHORT_DETECTED, SUPERVISION_INVALID_SETUP, THIRD_PARTY_DEVICE_CONNECTED, THIRD_PARTY_DEVICE_DISCONNECTED, NVR_STREAMING_STATUS, STORAGE_SM, DEVICE_OFFLINE_EXTENDED, DEVICE_OFFLINE_RECOVERED, DEVICES_OFFLINE_THRESHOLD, CLOUD_ARCHIVE_LAGGING, CLOUD_ARCHIVE_RECOVERED, LOCAL_RECORDING_INTERRUPTED, LOCAL_RECORDING_RECOVERED, UNKNOWN

locationUuidsstring<RUUID>[] | nullbody

Show Badge Integration variant

typeenum<string>body

Show Scheduled variant

typeenum<string>body

locationUuidsstring<RUUID>[] | nullbody

List of locations to use for timezone evaluation and for display purposes

minOfDayinteger<int32> | nullbody

minute of the day for this trigger. note that it is dependent on the timezone of the devices in the rule actions or the timezone of the specified locations.

Show Vision LLM variant

typeenum<string>body

createAffirmativeSeekpointsboolean | nullbody

createNegativeSeekpointsboolean | nullbody

deviceFacetUuidstring<DeviceFacetUuid> | nullbody

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

highDetailboolean | nullbody

userPromptstring | nullbody

Show Recurring variant

typeenum<string>body

locationUuidsstring<RUUID>[] | nullbody

Optional list of locations to specify timezones for evaluation. Note that if not specified, then we rely on the Actions to derive timezones.

repeatIntervalinteger<int32> | nullbody

Interval of timeUnit to re-occur at. i.e. trigger every 5 minutes, repeatInerval would be 5

timeUnitenum<string>body

Time unit of recurrence. i.e. trigger every 5 minutes, timeUnit would be MINUTES

Available options: SECONDS, MINUTES, HOURS

Show Location Lockdown Activated variant

typeenum<string>body

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lockdownPlanUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Location Lockdown Deactivated variant

typeenum<string>body

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lockdownPlanUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Custom LLM Event variant

typeenum<string>body

deviceFacetUuidsstring<DeviceFacetUuid>[] | nullbody

promptUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Button Integration variant

typeenum<string>body

thirdPartyBatteryLevelstring | nullbody

thirdPartyButtonActionstring | nullbody

thirdPartyButtonNamestring | nullbody

thirdPartyButtonSerialNumberstring | nullbody

thirdPartyButtonUuidstring | nullbody

timestampinteger<int64> | nullbody

Show Shelly Integration variant

typeenum<string>body

shellyChannelinteger<int32> | nullbody

shellyDeviceIdstring | nullbody

shellyEventTypeenum<string>body

Available options: SWITCH_ON, SWITCH_OFF, INPUT_ON, INPUT_OFF, BUTTON_PUSH, BUTTON_LONG_PUSH, BUTTON_DOUBLE_PUSH

timestampinteger<int64> | nullbody

Show Incoming Webhook variant

typeenum<string>body

displayNamestring | nullbody

webhookTokenstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/rules/createRule' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "rule": {
      "action": {
        "activateLocationLockdown": {},
        "alertAction": true,
        "audioPlaybackActions": [],
        "cancelLoopingAudioPlaybackAction": {},
        "changeComponentCompositeAccessStateActions": [],
        "connectAudioDeviceToMobileAppAction": {},
        "connectAudioDeviceToPhoneNumberAction": {},
        "createAlarmAction": {},
        "customActions": [],
        "customLLMActions": [],
        "emailAuditLogExportActions": [],
        "enableDisableAudioRecordActions": [],
        "integrationCommandActions": [],
        "integrationNotificationActions": [],
        "liveNotificationAction": true,
        "remoteDoorUnlockActions": [],
        "robotActions": [],
        "thirdPartyAudioPlaybackAction": {},
        "thirdPartyStrobeSirenAction": {},
        "triggerComponentRelayActions": [],
        "webhookActions": []
      },
      "conjunction": "AND",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ruleFilters": {
        "scheduleUuids": [],
        "triggerBackoffSecs": 0
      },
      "ruleType": "BUTTON_DEFINED",
      "triggers": [
        {}
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  }'

import requests

url = "https://api2.rhombussystems.com/api/rules/createRule"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "rule": {
        "action": {
            "activateLocationLockdown": {},
            "alertAction": True,
            "audioPlaybackActions": [],
            "cancelLoopingAudioPlaybackAction": {},
            "changeComponentCompositeAccessStateActions": [],
            "connectAudioDeviceToMobileAppAction": {},
            "connectAudioDeviceToPhoneNumberAction": {},
            "createAlarmAction": {},
            "customActions": [],
            "customLLMActions": [],
            "emailAuditLogExportActions": [],
            "enableDisableAudioRecordActions": [],
            "integrationCommandActions": [],
            "integrationNotificationActions": [],
            "liveNotificationAction": True,
            "remoteDoorUnlockActions": [],
            "robotActions": [],
            "thirdPartyAudioPlaybackAction": {},
            "thirdPartyStrobeSirenAction": {},
            "triggerComponentRelayActions": [],
            "webhookActions": []
        },
        "conjunction": "AND",
        "name": "<string>",
        "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "ruleFilters": {
            "scheduleUuids": [],
            "triggerBackoffSecs": 0
        },
        "ruleType": "BUTTON_DEFINED",
        "triggers": [
            {}
        ],
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/rules/createRule', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "rule": {
      "action": {
        "activateLocationLockdown": {},
        "alertAction": true,
        "audioPlaybackActions": [],
        "cancelLoopingAudioPlaybackAction": {},
        "changeComponentCompositeAccessStateActions": [],
        "connectAudioDeviceToMobileAppAction": {},
        "connectAudioDeviceToPhoneNumberAction": {},
        "createAlarmAction": {},
        "customActions": [],
        "customLLMActions": [],
        "emailAuditLogExportActions": [],
        "enableDisableAudioRecordActions": [],
        "integrationCommandActions": [],
        "integrationNotificationActions": [],
        "liveNotificationAction": true,
        "remoteDoorUnlockActions": [],
        "robotActions": [],
        "thirdPartyAudioPlaybackAction": {},
        "thirdPartyStrobeSirenAction": {},
        "triggerComponentRelayActions": [],
        "webhookActions": []
      },
      "conjunction": "AND",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ruleFilters": {
        "scheduleUuids": [],
        "triggerBackoffSecs": 0
      },
      "ruleType": "BUTTON_DEFINED",
      "triggers": [
        {}
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "rule": {
                "action": {
                  "activateLocationLockdown": {},
                  "alertAction": true,
                  "audioPlaybackActions": [],
                  "cancelLoopingAudioPlaybackAction": {},
                  "changeComponentCompositeAccessStateActions": [],
                  "connectAudioDeviceToMobileAppAction": {},
                  "connectAudioDeviceToPhoneNumberAction": {},
                  "createAlarmAction": {},
                  "customActions": [],
                  "customLLMActions": [],
                  "emailAuditLogExportActions": [],
                  "enableDisableAudioRecordActions": [],
                  "integrationCommandActions": [],
                  "integrationNotificationActions": [],
                  "liveNotificationAction": true,
                  "remoteDoorUnlockActions": [],
                  "robotActions": [],
                  "thirdPartyAudioPlaybackAction": {},
                  "thirdPartyStrobeSirenAction": {},
                  "triggerComponentRelayActions": [],
                  "webhookActions": []
                },
                "conjunction": "AND",
                "name": "<string>",
                "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                "ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                "ruleFilters": {
                  "scheduleUuids": [],
                  "triggerBackoffSecs": 0
                },
                "ruleType": "BUTTON_DEFINED",
                "triggers": [
                  {}
                ],
                "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
              }
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/rules/createRule"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "webhookSecrets": {
    "<key>": "<string>"
  }
}

Response

200 OK

application/json · object

Response object for creating a rule.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

ruleUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

warningMsgstring | null

webhookSecretsobject | null

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. Returned once at create time; store it securely.

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.