Abra GraphQL APIs
/Other
//
alarmUpdated
Download GraphQL schema
Home
Users
Fire
Water
Access
Energy
Misc
Other
Arguments
command
I
Return type
Hubcommand
String!,non-null
devices
errors
Subscription sample
subscription hubScanFoundDevices($commandId: ID!) {
hubScanFoundDevices(commandId: $commandId) {
commandId
devices {
hubDeviceId
deviceName
deviceManufacturerName
deviceImageSmallUrl
serialNumber
}
errors {
message
path
}
}
}Variables
{ "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "commandId": "Example String", "devices": [ { "hubDeviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceName": "Example String", "deviceManufacturerName": "Example String", "deviceImageSmallUrl": "Example String", "serialNumber": "Example String" } ], "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
command
I
Return type
HubSubscription sample
subscription hubKeepDevicesFinished($commandId: ID!) {
hubKeepDevicesFinished(commandId: $commandId) {
commandId
deviceIds
errors {
message
path
}
}
}Variables
{ "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "commandId": "Example String", "deviceIds": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ], "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
email
String!,non-nullrequired
Return type
Useremail
String!,non-null
account
Subscription sample
subscription userMyAccountEmailVerified($email: String!) {
userMyAccountEmailVerified(email: $email) {
email
account {
id
email
emailVerified
phoneNumber {
countryCode
nationalNumber
}
firstName
lastName
avatar {
url
urlSmall
urlMedium
urlLarge
uploadUrl
}
avatarV2(
# Arguments Here
) {
url {
original
small
medium
large
}
uploadUrl
}
roles
}
}
}Variables
{ "email": "Example String" }
Response sample
{ "data": { "email": "Example String", "account": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String", "emailVerified": true, "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "firstName": "Example String", "lastName": "Example String", "avatar": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String", "uploadUrl": "Example String" }, "avatarV2": { "url": { "original": "Example String", "small": "Example String", "medium": "Example String", "large": "Example String" }, "uploadUrl": "Example String" }, "roles": [ "INSTALLER" ] } } }
Arguments
email
String!,non-nullrequired
Return type
Useremail
String!,non-null
account
Subscription sample
subscription userMyAccountAvatarUploaded($email: String!) {
userMyAccountAvatarUploaded(email: $email) {
email
account {
id
email
emailVerified
phoneNumber {
countryCode
nationalNumber
}
firstName
lastName
avatar {
url
urlSmall
urlMedium
urlLarge
uploadUrl
}
avatarV2(
# Arguments Here
) {
url {
original
small
medium
large
}
uploadUrl
}
roles
}
}
}Variables
{ "email": "Example String" }
Response sample
{ "data": { "email": "Example String", "account": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String", "emailVerified": true, "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "firstName": "Example String", "lastName": "Example String", "avatar": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String", "uploadUrl": "Example String" }, "avatarV2": { "url": { "original": "Example String", "small": "Example String", "medium": "Example String", "large": "Example String" }, "uploadUrl": "Example String" }, "roles": [ "INSTALLER" ] } } }
Arguments
user
I
Return type
Useruser
I
subscription
tokens
Int!,non-null
tokens
Int!,non-null
Subscription sample
subscription userSubscriptionUpdated($userId: ID!) {
userSubscriptionUpdated(userId: $userId) {
userId
subscriptionType
tokensTotal
tokensAvailable
}
}Variables
{ "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "subscriptionType": "ALARM_STATION", "tokensTotal": 40, "tokensAvailable": 40 } }
Arguments
home
I
alarm
I
Return type
AlarmSubscription sample
subscription alarmUpdated($homeId: ID!, $alarmId: ID) {
alarmUpdated(homeId: $homeId, alarmId: $alarmId) {
homeId
alarmId
alarm {
id
state
triggeredAt
snoozeExpiresAt
areas {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
image {
__typename
# ...DeviceTemplateImageFragment
}
imageWithBg {
__typename
# ...DeviceTemplateImageFragment
}
instructions {
__typename
# ...DeviceTemplateInstructionsFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
notificationLifecycle {
id
notifications {
reason
}
}
alarmStationNotificationLifecycle {
deviceEvents {
deviceId
events {
triggeredAt
eventType
status
}
}
}
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "alarmId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "alarmId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "alarm": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "state": "ALARM", "triggeredAt": "Example String", "snoozeExpiresAt": "Example String", "areas": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "__typename": "DeviceManufacturer" }, "image": { "__typename": "DeviceTemplateImage" }, "imageWithBg": { "__typename": "DeviceTemplateImage" }, "instructions": { "__typename": "DeviceTemplateInstructions" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] } ], "notificationLifecycle": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "notifications": [ { "reason": "Example String" } ] }, "alarmStationNotificationLifecycle": { "deviceEvents": [ { "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "events": [ { "triggeredAt": "Example String", "eventType": "ACTIVATED", "status": "DELIVERED" } ] } ] } } } }
Arguments
project
I
Return type
Projectproject
I
project
Subscription sample
subscription projectUpdated($projectId: ID!) {
projectUpdated(projectId: $projectId) {
projectId
project {
id
installerId
status
avatar(
# Arguments Here
) {
url {
original
small
medium
large
}
uploadUrl
}
buildingType
buildingYear
buildingSize
locationInfo {
country
city
postalCode
street
streetNumber
unitNumber
geoLocation {
latitude
longitude
}
apartmentNumber
associationId
}
constructionType
description {
projectNumber
orderReferenceNumber
buildingTitle
}
hubs {
area {
areaName
areaType
}
}
devices {
area {
areaName
areaType
}
deviceType
}
}
}
}Variables
{ "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "project": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "installerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "status": "FINISHED", "avatar": { "url": { "original": "Example String", "small": "Example String", "medium": "Example String", "large": "Example String" }, "uploadUrl": "Example String" }, "buildingType": "APARTMENT", "buildingYear": 40, "buildingSize": 40, "locationInfo": { "country": "Example String", "city": "Example String", "postalCode": "Example String", "street": "Example String", "streetNumber": "Example String", "unitNumber": "Example String", "geoLocation": { "latitude": 40, "longitude": 40 }, "apartmentNumber": "Example String", "associationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }, "constructionType": "CONCRETE", "description": { "projectNumber": "Example String", "orderReferenceNumber": "Example String", "buildingTitle": "Example String" }, "hubs": [ { "area": { "areaName": "Example String", "areaType": "BATHROOM" } } ], "devices": [ { "area": { "areaName": "Example String", "areaType": "BATHROOM" }, "deviceType": "AIR_QUALITY_SENSOR" } ] } } }
Arguments
home
I
Return type
Homehome
I
avatar
Subscription sample
subscription homeAvatarUpdated($homeId: ID!) {
homeAvatarUpdated(homeId: $homeId) {
homeId
avatar {
url
urlSmall
urlMedium
urlLarge
uploadUrl
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "avatar": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String", "uploadUrl": "Example String" } } }
Arguments
party
I
home
I
Return type
UpdatedSubscription sample
subscription homeUpdated($partyId: ID, $homeId: ID) {
homeUpdated(partyId: $partyId, homeId: $homeId) {
partyId
homeId
action
deviceId
device {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
url
urlSmall
urlMedium
urlLarge
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
id
name
logo {
url
urlSmall
urlMedium
urlLarge
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
configuration {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
help {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
connectionAssetUrl
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
__typename
# ...DeviceManufacturerLogoFragment
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
__typename
# ...DeviceManufacturerFragment
}
image {
__typename
# ...DeviceTemplateImageFragment
}
imageWithBg {
__typename
# ...DeviceTemplateImageFragment
}
instructions {
__typename
# ...DeviceTemplateInstructionsFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
variant
version
downloadUrl
}
relayConfiguration {
supportedDeviceTypes
endDeviceType
}
ioModuleConfiguration {
supportedConfigurations
configuration
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
id
description
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
}
}Variables
{ "partyId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "partyId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "action": "ADDED", "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "device": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "imageWithBg": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "instructions": { "installation": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "configuration": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "help": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "connectionAssetUrl": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "serialNumber": "Example String", "imei": "Example String", "macAddress": "Example String", "ipAddress": "Example String", "roomPlacement": "Example String", "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "__typename": "DeviceManufacturerLogo" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "__typename": "DeviceManufacturer" }, "image": { "__typename": "DeviceTemplateImage" }, "imageWithBg": { "__typename": "DeviceTemplateImage" }, "instructions": { "__typename": "DeviceTemplateInstructions" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "variant": "ROUTER", "version": "Example String", "downloadUrl": "Example String" } ], "relayConfiguration": { "supportedDeviceTypes": [ "AIR_QUALITY_SENSOR" ], "endDeviceType": "AIR_QUALITY_SENSOR" }, "ioModuleConfiguration": { "supportedConfigurations": [ "BMS" ], "configuration": "BMS" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "accessPolicies": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "id": 40, "description": "Example String" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } } }
Arguments
user
I
Return type
UserSubscription sample
subscription userUpdated($userId: ID!) {
userUpdated(userId: $userId) {
userId
action
demandResponse {
eligible
enrolled
}
}
}Variables
{ "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "action": "ADDED", "demandResponse": { "eligible": true, "enrolled": true } } }