Skip to content
Developers
Get API KeyGet API Key(opens in a new tab)

Webhook Integrations

Get webhook integration

Get webhook integration

POST/api/integrations/webhooks/getWebhookIntegration

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

Base request object for integration operations.

Response

200 OK

application/json · object

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
orgIntegrationV2object
Show child attributes
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

One of:

Show Aperio variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Avigilon Alta variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

alertUnauthorizedFacesboolean | null
apiTokenstring | null
badgeAuthDisablesAlarmMonitoringboolean | null
badgeFaceVerificationModeenum<string>

Available options: OFF, SHADOW, SUPERVISED, AUTO

createAccessAnomalyAlertsboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

doorToCameraMapobject | null
doorsValidatedboolean | null
emailstring | null
eventToWebhookIdMapobject | null
eventToWebhookMapobject | null
Show child attributes
orgIdinteger<int32> | null
webhookIdinteger<int32> | null
identifyFacesFromBadgeboolean | null
indexFacesboolean | null
misconfiguredDoorsstring[] | null
passwordstring | null
refreshTokenstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
tokenValidboolean | null
webhookIdinteger<int32> | null
Show Boulevard variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

accessWindowAfterMinutesinteger<int32> | null
accessWindowBeforeMinutesinteger<int32> | null
apiTokenstring | null
boulevardBusinessIdstring | null
boulevardLocationToRhombusLocationMapobject | null
refreshTokenstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

tokenValidboolean | null
Show Brivo variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

accessTokenstring | null
alertUnauthorizedFacesboolean | null
apiKeystring | null
apiTokenstring | null
badgeAuthDisablesAlarmMonitoringboolean | null
badgeFaceVerificationModeenum<string>

Available options: OFF, SHADOW, SUPERVISED, AUTO

clientIdstring | null
clientSecretstring | null
createAccessAnomalyAlertsboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

doorsValidatedboolean | null
identifyFacesFromBadgeboolean | null
indexFacesboolean | null
misconfiguredDoorsstring[] | null
passwordstring | null
refreshTokenstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
tokenValidboolean | null
usernamestring | null
versioninteger<int32> | null
webhookIdinteger<int32> | null
Show Butterfly MX variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

alertUnauthorizedFacesboolean | null
apiTokenstring | null
badgeAuthDisablesAlarmMonitoringboolean | null
badgeFaceVerificationModeenum<string>

Available options: OFF, SHADOW, SUPERVISED, AUTO

buildingWebhookIdMapobject | null

A HashMap of <ButterflyMx Building Id, Webhook Id>.

createAccessAnomalyAlertsboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

doorsValidatedboolean | null
identifyFacesFromBadgeboolean | null
indexFacesboolean | null
misconfiguredDoorsstring[] | null
panelInfoMapobject | null

A HashMap of <Panel Id, ButterflymxPanelInfoType>.

Show child attributes
assignedCameraListstring<RUUID>[] | null

The list of Rhombus Camera RUUIDs.

buildingIdinteger<int32> | null

The ButterflyMx Building Id.

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

panelNamestring | null

The ButterflyMx Panel Name.

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"

refreshTokenstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
tokenValidboolean | null
Show Device Integration variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceSettingsMapobject | null
Show child attributes
latitudenumber<double> | null
longitudenumber<double> | null
namestring | null
Show Dice variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Envoy variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

alertUnauthorizedFacesboolean | null
apiTokenstring | null
badgeAuthDisablesAlarmMonitoringboolean | null
badgeFaceVerificationModeenum<string>

Available options: OFF, SHADOW, SUPERVISED, AUTO

createAccessAnomalyAlertsboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

doorsValidatedboolean | null
envoyIntegrationInstalledboolean | null
envoyUserSettingsMapobject | null
Show child attributes
guestsEnabledboolean | null
packagesEnabledboolean | null
identifyFacesFromBadgeboolean | null
indexFacesboolean | null
locationInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
locationNamestring | null
misconfiguredDoorsstring[] | null
refreshTokenstring | null
saveClipsboolean | null
tokenValidboolean | null
Show Flic variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

apiKeystring | null
apiSecretstring | null
associatedLocationsstring<RUUID>[] | null
moduleUploadedboolean | null
webhookIdstring | null
webhookTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Genea variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

alertUnauthorizedFacesboolean | null
apiTokenstring | null
badgeAuthDisablesAlarmMonitoringboolean | null
badgeFaceVerificationModeenum<string>

Available options: OFF, SHADOW, SUPERVISED, AUTO

createAccessAnomalyAlertsboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

doorsValidatedboolean | null
identifyFacesFromBadgeboolean | null
indexFacesboolean | null
misconfiguredDoorsstring[] | null
refreshTokenstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
tokenValidboolean | null
webhookSignatureSecretstring | null
webhookUuidstring | null
Show Google variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

allowUserStorageboolean | null
apiTokenstring | null
defaultAlertFolderIdstring | null
defaultAlertFolderNamestring | null
defaultFolderIdstring | null
defaultFolderNamestring | null
refreshTokenstring | null
saveAllAlertsboolean | null
saveClipsboolean | null
tokenValidboolean | null
userSettingsMapobject | null
Show child attributes
defaultAlertFolderIdstring | null
defaultAlertFolderNamestring | null
defaultFolderIdstring | null
defaultFolderNamestring | null
refreshTokenstring | null
saveAllAlertsboolean | null
saveClipsboolean | null
tokenValidboolean | null
Show Guest Management variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

locationSettingsMapobject | null
Show child attributes
associatedCamerasstring<RUUID>[] | null
printBadgeboolean | null
Show Honeywell Elements variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

alertUnauthorizedFacesboolean | null
apiKeystring | null
apiTokenstring | null
badgeAuthDisablesAlarmMonitoringboolean | null
badgeFaceVerificationModeenum<string>

Available options: OFF, SHADOW, SUPERVISED, AUTO

baseUrlstring | null
createAccessAnomalyAlertsboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

doorsValidatedboolean | null
identifyFacesFromBadgeboolean | null
indexFacesboolean | null
misconfiguredDoorsstring[] | null
refreshTokenstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
siteIdstring | null
tokenValidboolean | null
Show Informacast variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

apiTokenstring | null
locationSiteMapobject | null
Show child attributes
idstring | null
namestring | null
refreshTokenstring | null
tokenValidboolean | null
Show Inner Range variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

apiTokenstring | null
consoleToSettingsMapobject | null
Show child attributes
apiKeystring | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

readerIdsstring[] | null
remoteUnlockboolean | 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"

skyTunnelSNstring | null
tokenValidboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

readerIdsstring[] | null
remoteUnlockboolean | 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"

refreshTokenstring | null
skyTunnelSNstring | null
tokenValidboolean | null
Show Kisi variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

apiSecretKeystring | null
defaultOptionsobject | null
Show child attributes
alertUnauthorizedFacesboolean | null
badgeAuthDisablesAlarmMonitoringboolean | null
createSeekPointsboolean | null
defaultOptionsEnabledboolean | null
identifyFacesFromBadgeboolean | null
saveClipsboolean | null
doorsValidatedboolean | null
placeToSettingsMapobject | null
Show child attributes
alertUnauthorizedFacesboolean | null
badgeAuthDisablesAlarmMonitoringboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

identifyFacesFromBadgeboolean | null
misconfiguredDoorsinteger<int32>[] | null
placeIdinteger<int32> | null
placeNamestring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
webhookIdinteger<int32> | null
Show Lumeo variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Microsoft Teams variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

adminConsentboolean | null
allowUserNotificationsboolean | null
microsoftTeamSettingsMapobject | null
Show child attributes
botInstallationIdstring | null
channelIdstring | null
installingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

sendChannelNotificationsboolean | null
microsoftTeamsUserSettingsMapobject | null
Show child attributes
botInstallationIdstring | null
chatIdstring | null
refreshTokenstring | null
sendUserNotificationsboolean | null
teamIdsstring[] | null
userIdstring | null
tenantIdstring | null
Show Nine One One Cellular variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bearerTokenstring | null
saveClipsboolean | null
securityZoneMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
isParentZoneboolean | null
securityZoneNamestring | null
zoneAddressstring | null
zoneIdstring | null
zoneParentIdstring | null
triggerNotificationboolean | null
webhookTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

zonesValidatedboolean | null
Show Omnialert variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

associatedCamerasstring<RUUID>[] | null
saveClipsboolean | null
triggerNotificationboolean | null
webhookTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Open AI variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

apiTokenstring | null
baseUrlstring | null

The base url for any OpenAI Chat Completions compliant API. For example, to use Gemini models, set this to 'https://generativelanguage.googleapis.com/v1beta/openai/'. If left blank, we will try to use OpenAI models.

defaultModelstring | null

The model identifier to use as a default model. This is provider specific and typically found on model card pages. For example, set to 'gemini-2.0-flash' to use the Gemini 2.0 Flash model. Currently we require a model with vision capabilities for this integration.

refreshTokenstring | null
tokenValidboolean | null
Show Opentech Alliance variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

apiKeystring | null
apiSecretstring | null
facilityToSettingsMapobject | null
Show child attributes
alertUnauthorizedFacesboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
actionGroupIdstring | null
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

identifyFacesFromBadgeboolean | null
saveClipsboolean | null
Show Pimloc variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

baseAPIUrlenum<string>

Available options: US, EU

clientIdstring | null
clientSecretstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

validCredentialsboolean | null
Show Place Os variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

alertUnauthorizedFacesboolean | null
apiTokenstring | null
apiUrlstring | null
badgeAuthDisablesAlarmMonitoringboolean | null
badgeFaceVerificationModeenum<string>

Available options: OFF, SHADOW, SUPERVISED, AUTO

createAccessAnomalyAlertsboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

doorsValidatedboolean | null
identifyFacesFromBadgeboolean | null
indexFacesboolean | null
misconfiguredDoorsstring[] | null
refreshTokenstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
tokenValidboolean | null
triggerNotificationboolean | null
webhookSignatureSecretstring | null
Show Pro Data Key variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

alertUnauthorizedFacesboolean | null
apiTokenstring | null
badgeAuthDisablesAlarmMonitoringboolean | null
badgeFaceVerificationModeenum<string>

Available options: OFF, SHADOW, SUPERVISED, AUTO

createAccessAnomalyAlertsboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

doorsValidatedboolean | null
identifyFacesFromBadgeboolean | null
indexFacesboolean | null
misconfiguredDoorsstring[] | null
organizationIdstring | null
refreshTokenstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
systemIdstring | null
tokenValidboolean | null
webhookIdstring | null
webhookSignatureSecretstring | null
Show Raptor variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

apiTokenstring | null
clientIdstring | null
clientSecretstring | null
clientUidstring | null
refreshTokenstring | null
tokenValidboolean | null
Show Shelly variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

canSendDiagnosticNotificationsboolean | null
diagnosticQuietPeriodSecsinteger<int32> | null
shellyDeviceMapobject | null
Show child attributes
canSendCommandsenum<string>

Available options: AUTHORIZED, UNAUTHORIZED, UNKNOWN

channelsstring[] | null
deviceTypeenum<string>

Available options: RELAY, LIGHT, ROLLER, INPUT

hostUrlstring | null
isOnlineboolean | null
temperaturenumber<double> | null
timestampMsinteger<int64> | null
voltagenumber<double> | null
thirdPartyDeviceToLocationMapobject | null
webhookTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Toast variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

currentToastRestaurantGuidstring | null
restaurantSettingsMapobject | null
Show child attributes
locationNamestring | null

The location name of the restaurant from Toast

restaurantNamestring | null

The name of the restaurant from Toast, e.g. COFFEE CAN

serviceAreaSettingsMapobject | null

Collection of service area settings for this restaurant

Show child attributes
assignedCameraListstring<RUUID>[] | null

A list of camera uuids from Rhombus that are assigned to the PoS device

posNamestring | null

The name of the point of sale device

Show Webhooks variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

activityWebhooksobject | null
activityWebhooksV2object | null
Show child attributes
webhookDisabledboolean | null
webhookSecretstring | null
diagnosticWebhooksobject | null
diagnosticWebhooksV2object | null
Show child attributes
webhookDisabledboolean | null
webhookSecretstring | null
Show Zapier variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

zapierWebhooksobject | null
Show child attributes
backoffSecinteger<int32> | null
doorStateenum<string>

Door state for door sensor webhooks

Available options: OPEN, CLOSED, AJAR

humidityLowerThresholdnumber<float> | null
humidityUpperThresholdnumber<float> | null
tempLowerThresholdnumber<float> | null
tempUpperThresholdnumber<float> | null
urlstring | nullrequired
uuidsstring<RUUID>[] | null
zapEnumenum<string>required

Zapier integration type

Available options: BUTTON_EVENTS, DOOR_SENSOR_EVENTS, ENVIRONMENTAL_SENSOR_EVENTS, RULE_EVENTS

Show Par POS variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

accessTokenstring | null
locationTokenMapobject | null
serverUrlstring | null
Show Honeywell On Guard variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deploymentToSettingsMapobject | null
Show child attributes
alertUnauthorizedFacesboolean | null
badgeAuthDisablesAlarmMonitoringboolean | null
badgeFaceVerificationModeenum<string>

Available options: OFF, SHADOW, SUPERVISED, AUTO

createAccessAnomalyAlertsboolean | null
createSeekPointsboolean | null
displayNamestring | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

doorsValidatedboolean | null
identifyFacesFromBadgeboolean | null
misconfiguredDoorsstring[] | null
presharedSecretstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
Show Honeywell Net Box variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

alertUnauthorizedFacesboolean | null
apiTokenstring | null
badgeAuthDisablesAlarmMonitoringboolean | null
badgeFaceVerificationModeenum<string>

Available options: OFF, SHADOW, SUPERVISED, AUTO

baseUrlstring | null
createAccessAnomalyAlertsboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | 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"

doorsValidatedboolean | null
identifyFacesFromBadgeboolean | null
indexFacesboolean | null
misconfiguredDoorsstring[] | null
refreshTokenstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
tokenValidboolean | null
Show Signature Api variant
enabledboolean | null
integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationAuditMapobject | null
Show child attributes
enabledTimestampMsinteger<int64> | null
integrationAuditEventenum<string>

Available options: UPDATE, DELETE

userstring | null
userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

apiTokenstring | null
refreshTokenstring | null
tokenValidboolean | null
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.