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 Button Webservice API

The Button Webservice API from Rhombus Systems — 8 operation(s) for button webservice.

Rhombus Systems Button 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 Button Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 8 paths, and defines 73 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.

8 operations 8 paths 73 schemas 8 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 Button 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 8

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

Button Webservice 8
POST
/api/button/createRuleForButton
Create rule for button
createRuleForButton 1 param body → 200
POST
/api/button/deleteRuleForButton
Delete rule for button
deleteRuleForButton 1 param body → 200
POST
/api/button/getButtonPressEventsForSensor
Get button press events for sensor
getButtonPressEventsForSensor 1 param body → 200
POST
/api/button/getButtonRulesForOrg
Get button rules for organization
getButtonRulesForOrg 1 param body → 200
POST
/api/button/getMinimalButtonStateList
Get minimal button state list
getMinimalButtonStateList 1 param body → 200
POST
/api/button/getRulesForButton
Get rules for button
getRulesForButton 1 param body → 200
POST
/api/button/updateConfig
Update button config
updateButtonConfig 1 param body → 200
POST
/api/button/updateDetails
Update button details
updateButtonDetails 1 param body → 200

Schemas 73

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

ThirdPartyStrobeSirenActionType
object
12 properties
ConnectAudioDeviceToPhoneNumberActionType
object
5 properties
SupervisionStateEnumType
string
WebhookActionType
object
8 properties
RemoteDoorUnlockSystemEnum
string
ConnectAudioDeviceToMobileAppActionType
object
4 properties
Common_devices_UpdateDeviceDetailsWSResponse
object
3 properties
Button_GetButtonRulesForOrgWSResponse
object
Response containing rules for all buttons in an organization.
4 properties
Button_ButtonHealthDetailsEnum
string
Detailed health status for button sensors.
ThirdPartyAudioPlaybackActionType
object
7 properties
Button_CreateRuleForButtonWSRequest
object
Request to create a rule for a button sensor.
1 property
PointType
object
2 properties
Button_DeleteRuleForButtonWSResponse
object
Response from deleting a rule for a button sensor.
3 properties
RobotActionTypeEnum
string
DeployRobotAction
objectnull
2 properties
Button_UpdateButtonDetailsWSRequest
object
Request to update button sensor details.
11 properties
ReportLookbackUnitEnum
string
RobotAction
object
2 properties
ActivityEventData
object
4 properties
ButtonEventType
objectnull
10 properties
IntegrationEnum
string
Button_GetButtonPressEventsForSensorWSResponse
object
Response containing button press events for a sensor.
4 properties
Button_GetButtonRulesForOrgWSRequest
object
Request to get rules for all buttons in an organization.
RuleFilterType
object
Optional filters to apply to this lockdown rule.
2 properties
Button_GetRulesForButtonWSRequest
object
Request to get rules for a button sensor.
1 property
AccessStateOverrideExpirationStrategyEnum
string
Pose
object
2 properties
IntegrationCommandActionType
object
3 properties
ChangeComponentCompositeAccessStateActionType
object
8 properties
Device_config_userconfig_IExternalUpdateableButtonUserConfig
object
Configuration update for the button sensor
5 properties
AMSirenSettingsType
object
4 properties 2 required
ReportLookbackTypeEnum
string
EnableDisableAudioRecordActionType
object
2 properties
TriggerComponentRelayActionType
object
7 properties
Button_GetMinimalButtonStatesWSRequest
object
Request to get minimal state information for all button sensors.
IntegrationNotificationActionType
object
3 properties
DeviceTypeEnum
string
NoOpAction
objectnull
2 properties
AccessControlledDoorStateEnumType
string
EmergencyContact
object
2 properties 2 required
Button_ExternalButtonRuleType
object
External button rule configuration.
6 properties
Button_GetButtonPressEventsForSensorWSRequest
object
Request to get button press events for a specific sensor.
4 properties
CustomLLMActionType
object
5 properties
Button_GetRulesForButtonWSResponse
object
Response containing rules for a button sensor.
4 properties
Button_DeleteRuleForButtonWSRequest
object
Request to delete a rule for a button sensor.
2 properties
SensorValType
object
3 properties
CreateAlarmActionType
object
11 properties
Button_ButtonHealthEnum
string
Health status for button sensors.
CreateAlarmTriggerTypeEnum
string
RemoteDoorUnlockActionType
object
3 properties
ClipBoundingBoxType
object
25 properties
ComponentRelayOutputTypeEnum
string
ButtonModeEnum
string
Optional button mode configuration
Button_UpdateButtonConfigWSRequest
object
Request to update button sensor configuration.
1 property
HardwareVariationEnum
string
ActivityEnum
string
CancelLoopingAudioPlaybackActionType
object
2 properties
Button_GetMinimalButtonStatesWSResponse
object
Response containing minimal state information for all button sensors.
4 properties
RuleActionType
object
The action to take when this lockdown rule is triggered.
21 properties
FootageSeekPointColorEnum
string
ToastOrderIdType
object
5 properties
ActivateLocationLockdownActionType
object
2 properties
Common_devices_UpdateConfigWSResponse
object
Response indicating the result of updating device configuration.
3 properties
CustomRuleAction
object
2 properties
ToastCheckInfo
object
1 property
ButtonPressEnum
string
NavigationTypeEnum
string
Button_MinimalButtonStateType
object
Minimal state information for a button sensor.
21 properties
ComponentEventEnumType
string
Limits results to only contain the specified type of events, if applicable
GenericRelayStateEnumType
string
AudioPlaybackActionType
object
4 properties
Button_CreateRuleForButtonWSResponse
object
Response from creating a rule for a button sensor.
4 properties
EmailAuditLogExportActionType
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhombus-systems-button-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 Camera Webservice API
Rhombus Systems ClaimKey Webservice API
Rhombus Systems Climate Webservice API
Where this information came from

This is an independent, third-party profile of Rhombus Systems Button 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.