Event

Get alert monitoring threat case

POST/api/event/getAlertMonitoringThreatCase

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 read 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 retrieving a specific alert monitoring threat case.

uuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/event/getAlertMonitoringThreatCase' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }'

import requests

url = "https://api2.rhombussystems.com/api/event/getAlertMonitoringThreatCase"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "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/event/getAlertMonitoringThreatCase', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "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 = """
            {
              "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/event/getAlertMonitoringThreatCase"))
            .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>",
  "threatCase": {
    "alertGroupingKeys": {
      "<key>": "<string>"
    },
    "alertGroupingStrategy": "ALARM_RULES",
    "associatedDeviceUuids": {
      "<key>": 0
    },
    "createdAtMillis": 0,
    "deleted": false,
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "locationName": "<string>",
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "noonlightAlarmId": "<string>",
    "noonlightVerificationId": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "policyAlertComponentCompositeUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "policyAlertDeviceUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "policyAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "policyAlertUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "promptTheme": "THREAT",
    "promptTitle": "<string>",
    "sharedClipGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "sirenSettings": {
      "audioGateways": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "durationSeconds": 0,
      "playCount": 0
    },
    "status": "INITIATED",
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "submissionTimestampMs": 0,
    "submitDelayExpireTimestampMs": 0,
    "timelineEventList": [
      {
        "alertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "message": "<string>",
        "noonlightVerificationId": "<string>",
        "reviewerName": "<string>",
        "reviewerPinUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "reviewerType": "USER",
        "threatCaseStatus": "INITIATED",
        "timestampSec": 0,
        "type": "ALERT",
        "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "verificationHistory": {
      "alertIndex": 0,
      "currentVerification": {
        "alertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "clipVerificationId": "<string>",
        "failedAsClip": false,
        "failedAsStream": false,
        "initiatedAsClip": true,
        "sentAsClip": true,
        "sentAsClipAtMs": 0,
        "sentAsWindowedStream": true,
        "sentAsWindowedStreamAtMs": 0,
        "streamVerificationId": "<string>",
        "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
      },
      "verificationRecords": [
        {
          "alertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "clipVerificationId": "<string>",
          "failedAsClip": false,
          "failedAsStream": false,
          "initiatedAsClip": true,
          "sentAsClip": true,
          "sentAsClipAtMs": 0,
          "sentAsWindowedStream": true,
          "sentAsWindowedStreamAtMs": 0,
          "streamVerificationId": "<string>",
          "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
        }
      ]
    },
    "verificationMode": "EXTERNAL"
  }
}

Response

200 OK

application/json · object

Response object containing a specific alert monitoring threat case.

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

threatCaseobject

List of threat cases matching the request criteria

Show child attributes

alertGroupingKeysobject | null

alertGroupingStrategyenum<string>

Available options: ALARM_RULES, POLICY, CUSTOM_EVENTS, DOORBELL, MULTIPURPOSE_BUTTON

associatedDeviceUuidsobject | null

createdAtMillisinteger<int64> | null

deletedboolean | null

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

locationNamestring | null

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

noonlightAlarmIdstring | null

noonlightVerificationIdstring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

policyAlertComponentCompositeUuidsstring<RUUID>[] | null

policyAlertDeviceUuidsstring<RUUID>[] | null

policyAlertUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

policyAlertUuidsstring<RUUID>[] | null

promptThemeenum<string>

Available options: THREAT, HUMAN

promptTitlestring | null

sharedClipGroupUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

sirenSettingsobject

Show child attributes

audioGatewaysstring<RUUID>[] | nullrequired

UUIDs of audio gateways used to play this siren.

clipUuidstring<RUUID> | nullrequired

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

durationSecondsinteger<int32> | null

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

playCountinteger<int32> | null

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

statusenum<string>

Available options: INITIATED, REQUESTED, FOLLOW_ON, ESCALATED, PSAP_CONTACTED, VERIFIED, DISMISSED, CANCELLED, UNVERIFIABLE, TIMEOUT, ERROR, CLOSED

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

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"

submissionTimestampMsinteger<int64> | null

submitDelayExpireTimestampMsinteger<int64> | null

timelineEventListobject[] | null

Show child attributes

alertUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

messagestring | null

noonlightVerificationIdstring | null

reviewerNamestring | null

Reviewer name at the time the action was taken. For a shared PIN, this is the PIN name. For a user, including a user acting through their own PIN, this is the user's name. The value is null for actions not taken by a reviewer or for events recorded before the name was stored.

reviewerPinUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

reviewerTypeenum<string>

Type of reviewer who performed an action on a threat case.

Available options: USER, SHARED_PIN, MONITORING_SERVICE, UNKNOWN

threatCaseStatusenum<string>

Available options: INITIATED, REQUESTED, FOLLOW_ON, ESCALATED, PSAP_CONTACTED, VERIFIED, DISMISSED, CANCELLED, UNVERIFIABLE, TIMEOUT, ERROR, CLOSED

timestampSecinteger<int64> | null

typeenum<string>

Available options: ALERT, DELAYED_ALERT, USER, SERVICE_PROVIDER, ERROR, PANIC_BUTTON, ACCESS_CONTROL_INTEGRATION, ALARM_INTEGRATION, UNKNOWN

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

verificationHistoryobject

Show child attributes

alertIndexinteger<int32> | null

currentVerificationobject

Show child attributes

alertUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

clipVerificationIdstring | null

failedAsClipboolean | null

failedAsStreamboolean | null

initiatedAsClipboolean | null

sentAsClipboolean | null

sentAsClipAtMsinteger<int64> | null

sentAsWindowedStreamboolean | null

sentAsWindowedStreamAtMsinteger<int64> | null

streamVerificationIdstring | null

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

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"

verificationRecordsobject[] | null

Show child attributes

alertUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

clipVerificationIdstring | null

failedAsClipboolean | null

failedAsStreamboolean | null

initiatedAsClipboolean | null

sentAsClipboolean | null

sentAsClipAtMsinteger<int64> | null

sentAsWindowedStreamboolean | null

sentAsWindowedStreamAtMsinteger<int64> | null

streamVerificationIdstring | null

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

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"

verificationModeenum<string>

Available options: EXTERNAL, INTERNAL

warningMsgstring | null

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.