Rhombus Systems Event Webservice API
The Event Webservice API from Rhombus Systems — 42 operation(s) for event webservice.
Rhombus Systems Event 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 Event Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 42 operations across 42 paths, and defines 143 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.
42 operations
42 paths
143 schemas
42 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Rhombus Systems Event 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 42
Across 42 paths, the API surfaces 42 operations — 42 POST. Each is listed below with its method, path, parameters, and response codes.
Event Webservice 42
POST
/api/event/createSharedClipGroupV3
Share multiple clips in a single page
POST
/api/event/deleteAlertMonitoringThreatCase
Delete alert monitoring threat case
POST
/api/event/deleteAlertMonitoringThreatCaseByStatus
Delete alert monitoring threat case by status
POST
/api/event/deleteSavedClip
Delete all types of saved clips (splices in progress, completed splices, saved alerts)
POST
/api/event/deleteSharedClipGroupV2
Delete a shared clip page
POST
/api/event/dismissAllPolicyAlertsForDevice
Dismiss all policy alerts for each specified device(s)
POST
/api/event/dismissAllPolicyAlertsV2
Dismiss all policy alerts in organization
POST
/api/event/dismissPolicyAlertV2
Dismiss a policy alert
POST
/api/event/dismissPolicyAlertsV2
Dismiss multiple policy alerts
POST
/api/event/getAlertMonitoringThreatCase
Get alert monitoring threat case
POST
/api/event/getAlertMonitoringThreatCases
Get alert monitoring threat cases
POST
/api/event/getClipWithProgress
Get a specified saved clip with current progress
POST
/api/event/getClipsWithProgress
Get list of saved clips in organization, with current progress
POST
/api/event/getExpiringClipsForOrg
Get list of expiring saved clips in organization
POST
/api/event/getMotionGrid
Get motion data for specified camera
POST
/api/event/getMotionHeatMap
Get aggregated motion heatmap for specified time period and camera
POST
/api/event/getPolicyAlert
Get information about a policy alert
POST
/api/event/getPolicyAlertCount
Get count of policy alerts
POST
/api/event/getPolicyAlertDetails
Get detailed information about policy alert, including seekpoints and bounding boxes
POST
/api/event/getPolicyAlertGroupsForDevice
Get recent policy alerts for device, grouped by time
POST
/api/event/getPolicyAlertGroupsForLocation
Get recent policy alerts for a location, grouped by time
POST
/api/event/getPolicyAlertGroupsV2deprecated
Get recent policy alerts for organization, grouped by time
POST
/api/event/getPolicyAlertV2deprecated
Get information about a policy alert
POST
/api/event/getPolicyAlerts
Get recent policy alerts for organization
POST
/api/event/getPolicyAlertsV2deprecated
Get recent policy alerts for organization
POST
/api/event/getSavedClipCount
Get a count of saved clips in an organization
POST
/api/event/getSavedClipDetails
Get detailed information about a saved clip, including seekpoints and bounding boxes
POST
/api/event/getSavedClipsdeprecated
Use /getSavedClipsV2 instead
POST
/api/event/getSavedClipsByExternalTransactionId
Get list of saved clips matching the external transaction id
POST
/api/event/getSavedClipsV2
Get list of saved clips in organization
POST
/api/event/getSharedClipGroupDetails
Get detailed information about a shared clip page, including seekpoints and bounding boxes
POST
/api/event/getSharedClipGroupsV2
Get list of shared clip pages in organization
POST
/api/event/getSplicedClipsInProgressdeprecated
Get spliced clips in progress
POST
/api/event/getUnhealthyDeviceAlerts
Get list of unhealthy devices in organization
POST
/api/event/muteNotificationsForDevice
Mute notifications from a device for specified number of seconds
POST
/api/event/reportBadPolicyAlert
Report a bad policy event (AI false positive) and send information for feedback
POST
/api/event/savePolicyAlertV2
Save a policy alert as a saved clip
POST
/api/event/searchMotionGrid
Search motion grid for motion events occuring in specified grid cells
POST
/api/event/searchMotionGridWithActivities
Search motion grid for motion events occuring in specified grid cells
POST
/api/event/unSavePolicyAlertV2deprecated
Unsave policy alert and remove associated saved clip
POST
/api/event/updateSavedClip
Selectively update a saved clip
POST
/api/event/updateSharedClipGroupV2
Update shared clip page title, description, password, or expiration time
Schemas 143
The contract defines 143 schemas that model the data the API accepts and returns. The most detailed are Event_SavedClipWithProgressType (38 properties), SplicedClipType (37 properties), SavedClipWithDetailsType (37 properties), PolicyAlertWithDetailsType (35 properties). Each schema is shown below with its type and property counts.
Event_GetSavedClipsWSRequest
object
Request object for retrieving saved clips (deprecated).
ClipSeekPointV2Type
object
List of seek points for the clip
20 properties
Event_DeleteSharedClipGroupWSResponse
object
Response object for deleting a shared clip group.
3 properties
Event_GetSharedClipGroupsV2WSRequest
object
Request object for retrieving shared clip groups with date filtering.
2 properties
Event_DeleteSharedClipGroupWSRequest
object
Request object for deleting a shared clip group.
1 property
Resolution
object
2 properties
PointType
object
2 properties
Event_DeleteAlertMonitoringThreatCaseByStatusWSRequest
object
Request object for deleting alert monitoring threat cases by status.
1 property
ThreatCaseTimelineEventTypeEnum
string
Event_GetPolicyAlertDetailsWSRequest
object
Request object for retrieving detailed information about a policy alert.
1 property
Event_GetPolicyAlertCountWSRequest
object
Request object for retrieving the count of policy alerts.
1 property
Event_GetPolicyAlertsV2WSRequest
object
Request object for retrieving policy alerts V2 with filtering and pagination options.
7 properties
ApiClientTypeEnum
string
Event_GetPolicyAlertsWSResponse
objectnull
Response object containing a list of policy alerts.
4 properties
Event_GetPolicyAlertGroupsForLocationWSResponse
object
Response object containing policy alert groups for a specific location.
4 properties
CheckCondition
objectnull
2 properties
Event_GetSharedClipGroupDetailsWSRequest
object
Request object for retrieving detailed information about a shared clip group.
1 property
OPERATOREnum
string
SharedClipV2Type
object
8 properties
Event_GetClipsWithProgressWSResponse
object
Response object containing clips with progress information.
5 properties
SensorValType
object
3 properties
CameraMountingDirectionEnum
string
ThreatCaseStatusEnum
string
Event_GetPolicyAlertGroupsV2WSResponse
object
Response object containing policy alert groups V2.
4 properties
Event_GetSavedClipCountWSResponse
object
Response object containing the count of saved clips.
5 properties
Event_GetAlertMonitoringThreatCaseWSResponse
object
Response object containing a specific alert monitoring threat case.
4 properties
Event_DismissAllPolicyAlertsWSResponse
object
Response object for dismissing all policy alerts.
3 properties
Event_MuteNotificationsForDevicetWSRequest
object
Request object for muting notifications for a specific device.
2 properties
ActivityEnum
string
ToastOrderIdType
object
5 properties
Event_SearchMotionGridWithActivitiesWSRequest
object
Request object for searching motion grid data with activity information.
4 properties
4 required
Event_GetSavedClipsWSResponse
object
Response object containing saved clips (deprecated).
4 properties
Event_SearchMotionGridWSResponse
object
Response object containing motion grid search results.
4 properties
Event_DeleteAlertMonitoringThreatCaseWSRequest
object
Request object for deleting alert monitoring threat cases.
1 property
VerificationRecord
object
11 properties
Event_GetPolicyAlertCountWSResponse
object
Response object containing the count of policy alerts.
4 properties
Event_GetPolicyAlertsWSRequest
object
Request object for retrieving policy alerts with filtering and pagination options.
8 properties
SplicedClipType
object
List of spliced clips currently in progress
37 properties
DwellEventType
objectnull
14 properties
Event_DismissPolicyAlertsWSRequest
object
Request object for dismissing multiple policy alerts.
1 property
Event_SearchMotionGridWithActivitiesWSResponse_MotionGridActivity
object
Motion grid activity information for a specific timestamp.
3 properties
Event_GetPolicyAlertWSResponse
object
Response object containing a specific policy alert.
4 properties
Event_GetSavedClipDetailsWSRequest
object
Request object for retrieving detailed information about a saved clip.
1 property
Event_GetUnhealthyDeviceAlertsWSResponse
object
Response object containing unhealthy device alerts.
4 properties
Event_ReportBadPolicyAlertWSResponse
object
Response object for reporting a bad policy alert.
3 properties
Event_GetSplicedClipsInProgressWSRequest
object
Request object for retrieving spliced clips in progress (deprecated).
Event_UpdateSavedClipWSResponse
object
Response object for updating a saved clip.
3 properties
Event_GetAlertMonitoringThreatCasesWSRequest
object
Request object for retrieving alert monitoring threat cases with filtering and pagination options.
11 properties
TimeInterval
object
2 properties
AspectRatio
object
2 properties
Event_SavedClipWithProgressType
object
Saved clip with progress information for processing operations.
38 properties
Event_RuuidWrapper
object
Wrapper object containing UUIDs for alerts and events.
2 properties
Event_DismissAllPolicyAlertsForDeviceWSResponse
object
Response object for dismissing all policy alerts for specific devices.
3 properties
MetaDataLocationType
object
1 property
DewarpedView
object
5 properties
Event_DismissPolicyAlertWSResponse
object
Response object for dismissing a policy alert.
3 properties
DeviceTypeEnum
string
CroppedPermyriadRect
object
4 properties
PolicyAlertWithDetailsType
object
Detailed information about the policy alert
35 properties
BasePolicyAlertType
object
The requested policy alert
25 properties
PolicyAlertEnumType
string
PolicyEventPipelineEnum
string
Event_GetSharedClipGroupsV2WSResponse
object
Response object containing shared clip groups with date filtering.
4 properties
PromptTypeEnum
string
SavedClipWithDetailsType
object
Detailed information about the saved clip
37 properties
Event_GetClipWithProgressWSRequest
object
Request object for retrieving a specific clip with progress information.
1 property
1 required
Event_GetPolicyAlertGroupsForDeviceWSRequest
object
Request object for retrieving policy alert groups for a specific device.
4 properties
Event_GetPolicyAlertDetailsWSResponse
object
Response object containing detailed information about a policy alert.
4 properties
Event_GetPolicyAlertWSRequest
object
Request object for retrieving a specific policy alert.
1 property
Event_GetAlertMonitoringThreatCaseWSRequest
object
Request object for retrieving a specific alert monitoring threat case.
1 property
Event_SearchMotionGridWithActivitiesWSResponse_ActivityWithId
object
Activity information with object ID.
2 properties
VerificationHistory
object
3 properties
ClipAccessSettings
object
Visibility setting for the clip
3 properties
ThreatCaseVerificationModeEnum
string
Event_GetClipWithProgressWSResponse
object
Response object containing a specific clip with progress information.
4 properties
PolicyEventVehicleType
objectnull
6 properties
AlertMonitoringThreatCaseType
object
List of threat cases matching the request criteria
27 properties
Event_GetPolicyAlertV2WSRequest
object
Request object for retrieving a specific policy alert V2.
1 property
Event_GetPolicyAlertV2WSResponse
object
Response object containing a specific policy alert V2.
4 properties
Event_GetMotionGridWSResponse
object
Response object containing motion grid data for a device.
4 properties
Event_GetSplicedClipsInProgressWSResponse
object
Response object containing spliced clips in progress (deprecated).
4 properties
Event_SavePolicyAlertWSRequest
object
Request object for saving a policy alert as a clip.
4 properties
Event_GetPolicyAlertGroupsForLocationWSRequest
object
Request object for retrieving policy alert groups for a specific location.
4 properties
Event_SavePolicyAlertWSResponse
object
Response object for saving a policy alert as a clip.
3 properties
Event_DismissPolicyAlertsWSResponse
object
Response object for dismissing multiple policy alerts.
3 properties
Event_DismissPolicyAlertWSRequest
object
Request object for dismissing a policy alert.
1 property
Event_GetSavedClipsByExternalTransactionIdWSRequest
object
Request object for retrieving saved clips by external transaction ID.
1 property
Event_CreateSharedClipGroupWSResponse
object
Response object for creating a shared clip group.
5 properties
SharedClipWithDetailsType
object
11 properties
Event_UpdateSharedClipGroupWSRequest
object
Request object for updating a shared clip group.
5 properties
PolicyEventFaceType
objectnull
7 properties
ClipBoundingBoxType
object
25 properties
HardwareVariationEnum
string
ClipStatusEnum
string
Event_GetAlertMonitoringThreatCasesWSResponse
object
Response object containing alert monitoring threat cases with pagination information.
5 properties
FootageSeekPointColorEnum
string
EventOriginatorEnum
string
ToastCheckInfo
object
1 property
SharedClipGroupWithDetailsType
object
Detailed information about the shared clip group
7 properties
NoonlightPromptThemeEnum
string
AccessControlledDoorPolicyAlertType
objectnull
25 properties
Event_SearchMotionGridWSRequest
object
Request object for searching motion grid data.
4 properties
4 required
AlteredView
object
Map of device facet UUIDs to altered view configurations
2 properties
Event_GetSavedClipDetailsWSResponse
object
Response object containing detailed information about a saved clip.
4 properties
Event_GetMotionGridCountsWSResponse
object
Response object containing motion grid counts for a device.
4 properties
Event_UnSavePolicyAlertWSResponse
object
Response object for unsaving a policy alert (deprecated).
3 properties
Event_GetPolicyAlertGroupsForDeviceWSResponse
object
Response object containing policy alert groups for a specific device.
4 properties
AlertGroupingStrategyEnum
string
Event_GetSavedClipsV2WSResponse
object
Response object containing saved clips with pagination.
5 properties
Event_GetPolicyAlertsV2WSResponse
object
Response object containing policy alerts V2 with filtering and pagination options.
5 properties
Event_FrontendCell
object
Represents a cell in the motion grid with column and row coordinates.
2 properties
Event_GetSavedClipsV2WSRequest
object
Request object for retrieving saved clips with pagination.
2 properties
Event_GetSavedClipCountWSRequest
object
Request object for retrieving the count of saved clips with filtering options.
4 properties
Event_GetSavedClipsByExternalTransactionIdWSResponse
object
Response object containing saved clips by external transaction ID.
4 properties
Event_DeleteAlertMonitoringThreatCaseWSResponse
object
Response object for deleting alert monitoring threat cases.
3 properties
PolicyAlertV2Type
objectnull
25 properties
UnHealthyDeviceSymptomEnum
string
Event_GetPolicyAlertGroupsV2WSRequest
object
Request object for retrieving policy alert groups V2 with pagination options.
3 properties
IntegrationEnum
string
Event_UpdateSavedClipWSRequest
object
Request object for updating a saved clip.
4 properties
1 required
Event_UpdateSharedClipGroupWSResponse
object
Response object for updating a shared clip group.
5 properties
Event_SearchMotionGridWithActivitiesWSResponse
object
Response object containing motion grid search results with activity information.
4 properties
Event_GetMotionGridWSRequest
object
Request object for retrieving motion grid data for a device.
3 properties
3 required
AMSirenSettingsType
object
4 properties
2 required
Event_DeleteSavedClipWSResponse
object
Response object for deleting a saved clip.
3 properties
ThreatCaseTimelineEventType
object
7 properties
Event_GetUnhealthyDeviceAlertsWSRequest
object
Request object for retrieving unhealthy device alerts.
Event_DeleteAlertMonitoringThreatCaseByStatusWSResponse
object
Response object for deleting alert monitoring threat cases by status.
3 properties
SharedClipGroupWrapperV2Type
object
List of shared clip groups
8 properties
SplicedClipProgress
object
3 properties
Event_GetClipsWithProgressWSRequest
object
Request object for retrieving clips with progress information and filtering options.
12 properties
1 required
Event_DismissAllPolicyAlertsWSRequest
object
Request object for dismissing all policy alerts.
Event_PolicyAlertGroupV2
object
Group of policy alerts V2 with time range information.
3 properties
Event_ReportBadPolicyAlertWSRequest
object
Request object for reporting a bad policy alert.
1 property
Event_DeleteSavedClipWSRequest
object
Request object for deleting a saved clip.
1 property
UnHealthyDeviceAlertType
object
List of unhealthy device alerts
5 properties
ClipVisibilityEnum
string
Use accessSettings instead
Event_MuteNotificationsForDevicetWSResponse
object
Response object for muting notifications for a specific device.
3 properties
Event_DismissAllPolicyAlertsForDeviceWSRequest
object
Request object for dismissing all policy alerts for specific devices.
1 property
Event_GetSharedClipGroupDetailsWSResponse
object
Response object containing detailed information about a shared clip group.
4 properties
Event_UnSavePolicyAlertWSRequest
object
Request object for unsaving a policy alert (deprecated).
2 properties
Event_CreateSharedClipGroupWSRequest
object
Request object for creating a shared clip group.
4 properties
SavedClipV2Type
object
List of saved clips
35 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Rhombus Systems 12
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
#Event Webservice
Where this information came from
This is an independent, third-party profile of Rhombus Systems Event 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.