Skip to content
Abra GraphQL APIs
/
Other
/
/
hubTemplates

GraphQL Overview

Download GraphQL schema
schema.graphql
Home

Queries

Overview

Mutations

Overview
Users

Queries

Overview

Mutations

Overview
Fire

Queries

Overview

Mutations

Overview
Water

Queries

Overview

Mutations

Overview
Access

Queries

Overview

Mutations

Overview
Energy

Queries

Overview

Mutations

Overview
Misc

Queries

Overview

Mutations

Overview
Other

Queries

Overview

homeMembers

(homeId)
HomeMemberCollection

Arguments

homeId
ID!,non-nullrequired

Return type

HomeMemberCollection
homeMembers
[HomeMember!]!,non-null
Query sample
query homeMembers($homeId: ID!) {
  homeMembers(homeId: $homeId) {
    homeMembers {
      id 
      firstName 
      lastName 
      phoneNumber {
        countryCode 
        nationalNumber 
      }
      account {
        id 
        email 
        avatar {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
          uploadUrl 
        }
      }
      isEmergencyContact 
      isAlarmStationContact 
    }
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "homeMembers": [
      {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "firstName": "Example String",
        "lastName": "Example String",
        "phoneNumber": {
          "countryCode": "Example String",
          "nationalNumber": "Example String"
        },
        "account": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "email": "Example String",
          "avatar": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String",
            "uploadUrl": "Example String"
          }
        },
        "isEmergencyContact": true,
        "isAlarmStationContact": true
      }
    ]
  }
}

hubIdentifyByMacAddress

(macAddress)
HubIdentifyPayload

Arguments

macAddress
String!,non-nullrequired

Return type

HubIdentifyPayload
hubInfo
HubInfo
errors
[HubIdentifyError!]!,non-null
Query sample
query hubIdentifyByMacAddress($macAddress: String!) {
  hubIdentifyByMacAddress(macAddress: $macAddress) {
    hubInfo {
      id 
      firmwareVersion 
      serialNumber 
      registered 
      homeToClaim 
      homeId 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "macAddress": "Example String"
}
Response sample
{
  "data": {
    "hubInfo": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "firmwareVersion": "Example String",
      "serialNumber": "Example String",
      "registered": true,
      "homeToClaim": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

hubIdentifyBySerialNumber

(serialNumber)
HubIdentifyPayload

Arguments

serialNumber
String!,non-nullrequired

Return type

HubIdentifyPayload
hubInfo
HubInfo
errors
[HubIdentifyError!]!,non-null
Query sample
query hubIdentifyBySerialNumber($serialNumber: String!) {
  hubIdentifyBySerialNumber(serialNumber: $serialNumber) {
    hubInfo {
      id 
      firmwareVersion 
      serialNumber 
      registered 
      homeToClaim 
      homeId 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "serialNumber": "Example String"
}
Response sample
{
  "data": {
    "hubInfo": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "firmwareVersion": "Example String",
      "serialNumber": "Example String",
      "registered": true,
      "homeToClaim": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

hubIdentifyByQrCode

(qrCode)
HubIdentifyPayload

Arguments

qrCode
String!,non-nullrequired

Return type

HubIdentifyPayload
hubInfo
HubInfo
errors
[HubIdentifyError!]!,non-null
Query sample
query hubIdentifyByQrCode($qrCode: String!) {
  hubIdentifyByQrCode(qrCode: $qrCode) {
    hubInfo {
      id 
      firmwareVersion 
      serialNumber 
      registered 
      homeToClaim 
      homeId 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "qrCode": "Example String"
}
Response sample
{
  "data": {
    "hubInfo": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "firmwareVersion": "Example String",
      "serialNumber": "Example String",
      "registered": true,
      "homeToClaim": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
    },
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

hubGetDppPayload

(...args)
HubGetDppPayload!,non-null

Arguments

hubId
String!,non-nullrequired
homeKitSetupPayload
String!,non-nullrequired

Return type

HubGetDppPayload!
dppPayload
String
errors
[HubGetDppError!]!,non-null
Query sample
query hubGetDppPayload($hubId: String!, $homeKitSetupPayload: String!) {
  hubGetDppPayload(hubId: $hubId, homeKitSetupPayload: $homeKitSetupPayload) {
    dppPayload 
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "hubId": "Example String",
  "homeKitSetupPayload": "Example String"
}
Response sample
{
  "data": {
    "dppPayload": "Example String",
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

hubTemplates

[HubTemplate!]!,non-null

Return type

[HubTemplate!]!
id
ID!,non-null
name
String!,non-null
hubAssetUrl
String!,non-null
hubWithBgAssetUrl
String!,non-null
hubQrCodeAssetUrl
String!,non-null
hubConnectionAssetUrl
String!,non-null
hubSearchAssetUrl
String!,non-null
waterLeakDetectorAssetUrl
String!,non-null
waterLeakDetectorInstructionsAssetUrl
String!,non-null
waterLeakDetectorHelpAssetUrl
String!,non-null
waterSensorTapeAssetUrl
String!,non-null
waterSensorTapeInstructionsAssetUrl
String!,non-null
waterLeakSystemPressHubButtonAssetUrl
String!,non-null
sintefLogoAssetUrl
String!,non-null
Query sample
query hubTemplates {
  hubTemplates {
    id 
    name 
    hubAssetUrl 
    hubWithBgAssetUrl 
    hubQrCodeAssetUrl 
    hubConnectionAssetUrl 
    hubSearchAssetUrl 
    waterLeakDetectorAssetUrl 
    waterLeakDetectorInstructionsAssetUrl 
    waterLeakDetectorHelpAssetUrl 
    waterSensorTapeAssetUrl 
    waterSensorTapeInstructionsAssetUrl 
    waterLeakSystemPressHubButtonAssetUrl 
    sintefLogoAssetUrl 
  }
}
Response sample
{
  "data": [
    {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "name": "Example String",
      "hubAssetUrl": "Example String",
      "hubWithBgAssetUrl": "Example String",
      "hubQrCodeAssetUrl": "Example String",
      "hubConnectionAssetUrl": "Example String",
      "hubSearchAssetUrl": "Example String",
      "waterLeakDetectorAssetUrl": "Example String",
      "waterLeakDetectorInstructionsAssetUrl": "Example String",
      "waterLeakDetectorHelpAssetUrl": "Example String",
      "waterSensorTapeAssetUrl": "Example String",
      "waterSensorTapeInstructionsAssetUrl": "Example String",
      "waterLeakSystemPressHubButtonAssetUrl": "Example String",
      "sintefLogoAssetUrl": "Example String"
    }
  ]
}

userMyAccount

Account

Return type

Account
id
ID!,non-null
email
String!,non-null
emailVerified
Boolean!,non-null
phoneNumber
PhoneNumber
firstName
String
lastName
String
avatar
Avatardeprecated
Deprecation reason

use avatarV2

avatarV2
ImageInfo
uploadFile
roles
[Role!]!,non-null
Query sample
query userMyAccount {
  userMyAccount {
    id 
    email 
    emailVerified 
    phoneNumber {
      countryCode 
      nationalNumber 
    }
    firstName 
    lastName 
    avatar {
      url 
      urlSmall 
      urlMedium 
      urlLarge 
      uploadUrl 
    }
    avatarV2(
      # Arguments Here
    ) {
      url {
        original 
        small 
        medium 
        large 
      }
      uploadUrl 
    }
    roles 
  }
}
Response sample
{
  "data": {
    "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"
    ]
  }
}

userPreferences

AccountPreferences

Return type

AccountPreferences
alarmPreferences
AlarmPreferences!,non-null
notificationPreferences
NotificationPreferences!,non-null
generalPreferences
GeneralPreferences!,non-null
Query sample
query userPreferences {
  userPreferences {
    alarmPreferences {
      securityShowArmConfirmationModal 
    }
    notificationPreferences {
      notificationsEnabled 
    }
    generalPreferences {
      betaVersion 
      experimentalVersion 
    }
  }
}
Response sample
{
  "data": {
    "alarmPreferences": {
      "securityShowArmConfirmationModal": true
    },
    "notificationPreferences": {
      "notificationsEnabled": true
    },
    "generalPreferences": {
      "betaVersion": true,
      "experimentalVersion": true
    }
  }
}

notificationsInbox

InboxNotificationCollection

Return type

InboxNotificationCollection
notifications
[InboxNotification!]!,non-null
Query sample
query notificationsInbox {
  notificationsInbox {
    notifications {
      id 
      message {
        title 
        body 
      }
      deepLink 
      receivedAt 
      read 
      context {
        kind 
        source 
      }
    }
  }
}
Response sample
{
  "data": {
    "notifications": [
      {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "message": {
          "title": "Example String",
          "body": "Example String"
        },
        "deepLink": "Example String",
        "receivedAt": "Example String",
        "read": true,
        "context": {
          "kind": "UNSPECIFIED",
          "source": "UNSPECIFIED"
        }
      }
    ]
  }
}

insuranceCompanies

(homeId)
InsuranceCompanyCollection

Arguments

homeId
ID!,non-nullrequired

Return type

InsuranceCompanyCollection
insuranceCompanies
[InsuranceCompany!]!,non-null
Query sample
query insuranceCompanies($homeId: ID!) {
  insuranceCompanies(homeId: $homeId) {
    insuranceCompanies {
      id 
      name 
    }
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "insuranceCompanies": [
      {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String"
      }
    ]
  }
}

userAccount

(userId)
Account

Arguments

userId
ID!,non-nullrequired

Return type

Account
id
ID!,non-null
email
String!,non-null
emailVerified
Boolean!,non-null
phoneNumber
PhoneNumber
firstName
String
lastName
String
avatar
Avatardeprecated
Deprecation reason

use avatarV2

avatarV2
ImageInfo
uploadFile
roles
[Role!]!,non-null
Query sample
query userAccount($userId: ID!) {
  userAccount(userId: $userId) {
    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
{
  "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "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"
    ]
  }
}

Mutations

Overview

Subscriptions

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview