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 Doorbell Camera Webservice API

The Doorbell Camera Webservice API from Rhombus Systems — 10 operation(s) for doorbell camera webservice.

Rhombus Systems Doorbell Camera 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 Doorbell Camera 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 135 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 135 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 Doorbell Camera 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.

Doorbell Camera Webservice 10
POST
/api/doorbellcamera/calibrateFloorplanProjection
Generate the homography to project detections onto a floorplan
doorbellCameraCalibrateFloorplanProjection 1 param body → 200
POST
/api/doorbellcamera/createRuleForDoorbellCamera
Create rule for a doorbell camera
createRuleForDoorbellCamera 1 param body → 200
POST
/api/doorbellcamera/createSharedLiveVideoStream
Share an live video stream for a doorbell camera
createDoorbellCameraSharedLiveVideoStream 1 param body → 200
POST
/api/doorbellcamera/delete
Remove the doorbell camera from the organization
deleteDoorbellCamera 1 param body → 200
POST
/api/doorbellcamera/deleteRuleForDoorbellCamera
Delete rule for a doorbell camera
deleteRuleForDoorbellCamera 1 param body → 200
POST
/api/doorbellcamera/findComponentEventsForDoorbellCamera
Retrieve all component events relevant to the specified Doorbell Camera
findComponentEventsForDoorbellCamera 1 param body → 200
POST
/api/doorbellcamera/findComponentSeekPointsForDoorbellCamera
Retrieve all component seekpoints relevant to the specified Doorbell Camera
findComponentSeekPointsForDoorbellCamera 1 param body → 200
POST
/api/doorbellcamera/findSharedLiveVideoStreams
Get list of all shared live streams for doorbell camera
findDoorbellCameraSharedLiveVideoStreams 1 param body → 200
POST
/api/doorbellcamera/getDoorbellCameraRulesForOrg
Get rules for all doorbell cameras in an org
getDoorbellCameraRulesForOrg 1 param body → 200
POST
/api/doorbellcamera/getRulesForDoorbellCamera
Get all rules for a doorbell camera
getRulesForDoorbellCamera 1 param body → 200

Schemas 135

The contract defines 135 schemas that model the data the API accepts and returns. The most detailed are ClipBoundingBoxType (25 properties), Camera_SharedLiveVideoStreamWS (22 properties), RuleActionType (21 properties), ComponentSeekPointType (14 properties). Each schema is shown below with its type and property counts.

SupervisionStateEnumType
string
AperioActivatorStateEvent
objectnull
10 properties
ConnectAudioDeviceToMobileAppActionType
object
4 properties
UserEventOriginator
objectnull
1 property
Common_devices_CalibrateFloorplanProjectionWSRequest
object
Request to calibrate floorplan projection for a device.
3 properties
Doorbellcamera_FindComponentEventsForDoorbellCameraWSResponse
object
Response object containing component events for a doorbell camera.
4 properties
DoorLockdownStateEventReference
objectnull
5 properties
PointType
object
2 properties
Doorbellcamera_CreateSharedLiveVideoStreamWSRequest
object
Request object for creating a shared live video stream for a doorbell camera.
9 properties 3 required
AperioKeyCylinderStateEvent
objectnull
10 properties
CredentialEntry
objectnull
4 properties
AccessControlAuthorizationResultEnumType
string
DoorPositionIndicatorStateChangeEventType
objectnull
10 properties
StreamTypeEnum
string
CredentialSourceEnumType
string
ComponentEventType
object
List of component events for the doorbell camera
10 properties
AccessStateOverrideExpirationStrategyEnum
string
ChangeComponentCompositeAccessStateActionType
object
8 properties
LocationLockdownStateEnumType
string
ReportLookbackTypeEnum
string
EnableDisableAudioRecordActionType
object
2 properties
WaveToUnlockIntentExpiredEvent
objectnull
10 properties
IntegrationNotificationActionType
object
3 properties
NoOpAction
objectnull
2 properties
Doorbellcamera_DeleteRuleForDoorbellCameraWSRequest
object
Request object for deleting a rule for a doorbell camera.
2 properties
SensorValType
object
3 properties
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
FirstInSourceEnum
string
CustomRuleAction
object
2 properties
BaseEventOriginator
object
1 property
Doorbellcamera_DeleteDoorbellCameraWSRequest
object
Request object for removing a doorbell camera from the organization.
2 properties 2 required
Doorbellcamera_ExternalDoorbellCameraComponentRuleType
object
External representation of a doorbell camera component rule.
7 properties
GenericRelayStateEnumType
string
AudioPlaybackActionType
object
4 properties
Doorbellcamera_GetRulesForDoorbellCameraWSRequest
object
Request object for retrieving all rules for a doorbell camera.
1 property
GuestPassEventOriginator
objectnull
1 property
DeviceServiceEventOriginator
objectnull
1 property
DoorReaderStateChangeEventType
objectnull
10 properties
CredentialReceivedEventType
objectnull
10 properties
RequestToExitStateChangeEventType
objectnull
10 properties
Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSResponse
object
Response object containing component seekpoints for a doorbell camera.
4 properties
ReportLookbackUnitEnum
string
ActivityEventData
object
4 properties
Doorbellcamera_DeleteRuleForDoorbellCameraWSResponse
object
Response object for deleting a rule for a doorbell camera.
3 properties
AccessStateSourceEnum
string
PanicButtonEventType
objectnull
10 properties
AccessControlUnitDoorFirstInStateEvent
objectnull
10 properties
SupportAuthorityEventOriginator
objectnull
1 property
RuleEventOriginator
objectnull
1 property
CredentialEntryBleWave
objectnull
4 properties
Doorbellcamera_CreateRuleForDoorbellCameraWSRequest
object
Request object for creating a rule for a doorbell camera.
1 property
TriggerComponentRelayActionType
object
7 properties
Doorbellcamera_CreateRuleForDoorbellCameraWSResponse
object
Response object for creating a rule for a doorbell camera.
4 properties
DeviceTypeEnum
string
AccessControlUnitLocationLockdownStateEventType
objectnull
10 properties
DoorPositionIndicatorStateEnumType
string
GenericInputStateChangeEventType
objectnull
10 properties
DoorRelayStateEnumType
string
FirstInFirmwareStatusEnum
string
Common_devices_CalibrateFloorplanProjectionWSResponse
object
Response containing the calibrated floorplan projection homography.
1 property
IntercomTalkStateEnumType
string
Whether the operator started or ended talking
Doorbellcamera_GetDoorbellCameraRulesForOrgWSRequest
object
Request object for retrieving rules for all doorbell cameras in an organization.
AccessControlUnitBatteryStateChangeEventType
objectnull
10 properties
NavigationTypeEnum
string
LockdownPlanScopeEnumType
string
ComponentEventEnumType
string
Limits results to only contain the specified type of events, if applicable
ButtonPressEnum
string
EmailAuditLogExportActionType
object
7 properties
ConnectAudioDeviceToPhoneNumberActionType
object
5 properties
Doorbellcamera_DeleteDoorbellCameraWSResponse
object
Response object for removing a doorbell camera from the organization.
4 properties
IntercomTalkEventType
objectnull
10 properties
Doorbellcamera_GetDoorbellCameraRulesForOrgWSResponse
object
Response object containing rules for all doorbell cameras in an organization.
4 properties
ThirdPartyAudioPlaybackActionType
object
7 properties
DoorStateChangeEvent
objectnull
10 properties
RobotActionTypeEnum
string
AperioDoorHandleStateEvent
objectnull
10 properties
RobotAction
object
2 properties
AperioDoorExtensionStateEvent
objectnull
10 properties
Doorbellcamera_FindComponentEventsForDoorbellCameraWSRequest
object
Request object for retrieving component events for a doorbell camera.
5 properties 2 required
ComponentSeekPointType
object
List of component seekpoints for the doorbell camera
14 properties
IntegrationCommandActionType
object
3 properties
AperioDtcEvent
objectnull
10 properties
DoorScheduleFirstInStateEvent
objectnull
10 properties
DtcInfo
objectnull
5 properties
EmergencyContact
object
2 properties 2 required
LockdownPlanReference
object
3 properties
AccessControlUnitTamperEventType
objectnull
10 properties
ClipBoundingBoxType
object
25 properties
HardwareVariationEnum
string
FootageSeekPointColorEnum
string
Doorbellcamera_FindSharedLiveVideoStreamsWSResponse
object
Response object containing shared live video streams for a doorbell camera.
4 properties
EventOriginatorEnum
string
DoorLockdownStateEnumType
string
AccessControlUnitTamperSourceEnumType
string
ToastCheckInfo
object
1 property
ComponentCompositeEventOriginator
objectnull
1 property
ThirdPartyStrobeSirenActionType
object
12 properties
DoorAuthFirstInStateEvent
objectnull
10 properties
RequestToExitStateEnumType
string
WebhookActionType
object
8 properties
DoorLocationLockdownStateEventType
objectnull
10 properties
DoorFirstInStateChangeEventReference
objectnull
7 properties
RemoteDoorUnlockSystemEnum
string
Doorbellcamera_FindSharedLiveVideoStreamsForWSRequest
object
Request object for finding shared live video streams for a doorbell camera.
1 property
Doorbellcamera_CreateSharedLiveVideoStreamWSResponse
object
Response object for creating a shared live video stream for a doorbell camera.
6 properties
DeployRobotAction
objectnull
2 properties
ButtonEventType
objectnull
10 properties
IntegrationEnum
string
Doorbellcamera_GetRulesForDoorbellCameraWSResponse
object
Response object containing all rules for a doorbell camera.
4 properties
GenericRelayStateChangeEventType
objectnull
10 properties
AperioDoorModeEvent
objectnull
10 properties
RuleFilterType
object
Optional filters to apply to this lockdown rule.
2 properties
Pose
object
2 properties
Camera_SharedLiveVideoStreamWS
object
List of shared live video streams for the doorbell camera
22 properties
AMSirenSettingsType
object
4 properties 2 required
DoorReaderStateEnumType
string
GenericInputStateEnumType
string
AuthDecisionSourceEnum
string
DoorRelayStateChangeEventType
objectnull
10 properties
WebResponseStatusEnum
string
Status of the unregister operation
AccessControlledDoorStateEnumType
string
CustomLLMActionType
object
5 properties
DoorReaderStateChangeReasonEnumType
string
CreateAlarmActionType
object
11 properties
RemoteDoorUnlockActionType
object
3 properties
DoorbellEventType
objectnull
10 properties
AccessControlAuthenticationResultEnumType
string
ApiTokenEventOriginator
objectnull
1 property
Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSRequest
object
Request object for retrieving component seekpoints for a doorbell camera.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhombus-systems-doorbell-camera-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 Doorbell Camera 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.