How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rhombus Systems Rules Webservice API

The Rules Webservice API from Rhombus Systems — 10 operation(s) for rules webservice.

Rhombus Systems Rules Webservice API is one of 65 APIs that Rhombus Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Rules Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 10 paths, and defines 93 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api2.rhombussystems.com.

10 operations 10 paths 93 schemas 10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api2.rhombussystems.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rhombus Systems Rules Webservice API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-auth-apikey (ApiKeyAuth). By default, every request must be authenticated.

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

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 10 POST. Each is listed below with its method, path, parameters, and response codes.

Rules Webservice 10
POST
/api/rules/createRule
Create rule
createRule 1 param body → 200
POST
/api/rules/deleteIncomingWebhookToken
Delete incoming webhook trigger token
deleteIncomingWebhookToken 1 param body → 200
POST
/api/rules/deleteRule
Delete rule
deleteRule 1 param body → 200
POST
/api/rules/deleteRulePauseSetting
Delete rule pause setting
deleteRulePauseSetting 1 param body → 200
POST
/api/rules/generateIncomingWebhookToken
Generate incoming webhook trigger token
generateIncomingWebhookToken 1 param body → 200
POST
/api/rules/getRulePauseSettings
Get rule pause settings
getRulePauseSettings 1 param body → 200
POST
/api/rules/getRulesFiltered
Get rules filtered
getRulesFiltered 1 param body → 200
POST
/api/rules/getRulesForOrg
Get rules for org
getRulesForOrg 1 param body → 200
POST
/api/rules/pauseRule
Pause rule
pauseRule 1 param body → 200
POST
/api/rules/updateRule
Update rule
updateRule 1 param body → 200

Schemas 93

The contract defines 93 schemas that model the data the API accepts and returns. The most detailed are ClipBoundingBoxType (25 properties), RuleActionType (21 properties), ThirdPartyStrobeSirenActionType (12 properties), CreateAlarmActionType (11 properties). Each schema is shown below with its type and property counts.

Rules_DeleteRulePauseSettingWSRequest
object
Request object for deleting a rule pause setting.
1 property
ConnectAudioDeviceToMobileAppActionType
object
4 properties
RuleType
object
Updated rule data
9 properties
CustomLLMEventRuleTriggerType
objectnull
1 property
PointType
object
2 properties
Rules_GetRulesForOrgWSRequest
object
Request object for getting rules for an organization.
Rules_records_GetRulesFilteredWSRequest
object
Request object for getting filtered rules.
2 properties
IncomingWebhookRuleTriggerType
objectnull
1 property
RuleTypeEnum
string
ScheduledIntervalType
object
Map of location UUIDs to snooze intervals
3 properties
AccessStateOverrideExpirationStrategyEnum
string
ChangeComponentCompositeAccessStateActionType
object
8 properties
ReportLookbackTypeEnum
string
EnableDisableAudioRecordActionType
object
2 properties
IntegrationNotificationActionType
object
3 properties
NoOpAction
objectnull
2 properties
Rules_DeleteRuleWSRequest
object
Request object for deleting a rule.
1 property
SensorValType
object
3 properties
Rules_GenerateIncomingWebhookTokenWSRequest
object
Request object for generating an incoming webhook trigger token.
1 property
CreateAlarmTriggerTypeEnum
string
ComponentRelayOutputTypeEnum
string
ActivityEnum
string
CancelLoopingAudioPlaybackActionType
object
2 properties
RuleActionType
object
The action to take when this lockdown rule is triggered.
21 properties
ToastOrderIdType
object
5 properties
ActivateLocationLockdownActionType
object
2 properties
CustomRuleAction
object
2 properties
BadgeIntegrationRuleTriggerType
objectnull
1 property
GenericRelayStateEnumType
string
AudioPlaybackActionType
object
4 properties
DiagnosticRuleTriggerType
objectnull
1 property
Rules_GetRulePauseSettingsResponse
object
Response object for getting rule pause settings.
4 properties
SimpleDiagnosticEventType
objectnull
1 property
RuleTriggerConjunctionEnum
string
ReportLookbackUnitEnum
string
ActivityEventData
object
4 properties
AuditRuleTriggerType
objectnull
1 property
Rules_UpdateRuleWSResponse
object
Response object for updating a rule.
4 properties
Rules_DeleteRulePauseSettingWSResponse
object
Response object for deleting a rule pause setting.
3 properties
TriggerComponentRelayActionType
object
7 properties
ShellyIntegrationRuleTriggerType
objectnull
1 property
DeviceTypeEnum
string
RecurringTimeUnitEnum
string
Time unit of recurrence. i.e. trigger every 5 minutes, timeUnit would be MINUTES
Rules_DeleteIncomingWebhookTokenWSRequest
object
Request object for deleting an incoming webhook trigger token.
1 property
NavigationTypeEnum
string
RecurringRuleTriggerType
objectnull
1 property
ShellyEventTypeEnum
string
EmailAuditLogExportActionType
object
7 properties
ConnectAudioDeviceToPhoneNumberActionType
object
5 properties
LocationLockdownDeactivatedRuleTriggerType
objectnull
1 property
ThirdPartyAudioPlaybackActionType
object
7 properties
Rules_DeleteIncomingWebhookTokenWSResponse
object
Response object for deleting an incoming webhook trigger token.
3 properties
RobotActionTypeEnum
string
LocationLockdownActivatedRuleTriggerType
objectnull
1 property
RobotAction
object
2 properties
Rules_GenerateIncomingWebhookTokenWSResponse
object
Response object for generating an incoming webhook trigger token.
5 properties
SimpleAuditEventType
objectnull
1 property
ButtonIntegrationRuleTriggerType
objectnull
1 property
Rules_GetRulesForOrgWSResponse
object
Response object for getting rules for an organization.
4 properties
Rules_PauseRuleWSResponse
object
Response object for pausing a rule.
3 properties
Rules_CreateRuleWSRequest
object
Request object for creating a rule.
1 property
IntegrationCommandActionType
object
3 properties
Rules_CreateRuleWSResponse
object
Response object for creating a rule.
5 properties
EmergencyContact
object
2 properties 2 required
Rules_DeleteRuleWSResponse
object
Response object for deleting a rule.
3 properties
ScheduledRuleTriggerType
objectnull
1 property
ClipBoundingBoxType
object
25 properties
Rules_PauseRuleWSRequest
object
Request object for pausing a rule.
3 properties
FootageSeekPointColorEnum
string
ToastCheckInfo
object
1 property
DeviceActivityRuleTriggerType
objectnull
1 property
ThirdPartyStrobeSirenActionType
object
12 properties
WebhookActionType
object
8 properties
Rules_GetRulePauseSettingsWSRequest
object
Request object for getting rule pause settings.
Rules_UpdateRuleWSRequest
object
Request object for updating a rule.
1 property
RemoteDoorUnlockSystemEnum
string
DeployRobotAction
objectnull
2 properties
IntegrationEnum
string
RuleFilterType
object
Optional filters to apply to this lockdown rule.
2 properties
Pose
object
2 properties
DiagnosticActivityEnum
string
AMSirenSettingsType
object
4 properties 2 required
VisionLLMRuleTriggerType
objectnull
1 property
AccessControlledDoorStateEnumType
string
CustomLLMActionType
object
5 properties
RuleTriggerTypeEnum
string
CreateAlarmActionType
object
11 properties
RemoteDoorUnlockActionType
object
3 properties
AuditActionEnum
string
SimpleDeviceActivityEventType
objectnull
1 property
AlertMonitoringRulesEventTypeEnum
string
AlertMonitoringRuleTriggerType
objectnull
1 property
BaseRuleTriggerType
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhombus-systems-rules-webservice-api-openapi.yml Raw ↑

Other APIs Rhombus Systems publishes across the network.

Rhombus Console WebSocket API
Rhombus Systems Access Control Integrations Webservice API
Rhombus Systems Access Control Webservice API
Rhombus Systems Alarm Monitoring Keypad Webservice API
Rhombus Systems Alert Monitoring Webservice API
Rhombus Systems AudioGateway Webservice API
Rhombus Systems AudioPlayback Webservice API
Rhombus Systems Badge Reader Webservice API
Rhombus Systems BLE Webservice API
Rhombus Systems Button Webservice API
Rhombus Systems Camera Webservice API
Rhombus Systems ClaimKey Webservice API
Where this information came from

This is an independent, third-party profile of Rhombus Systems Rules Webservice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.