First Alert App Integration Guide

FIRST ALERT APP INTEGRATION GUIDE

This guide covers:

  • Application setup for First Alert
  • API Differences and Products Supported
  • Changes necessary for Event Hub Events

 

APPLICATION SETUP FOR FIRST ALERT

There are a few options to onboard First Alert users:

  • Directing users to an application selection screen (to pick First Alert or Resideo app)
  • You also have the ability to direct users to a First Alert or Resideo app login experience
  • Creating a separate Application/API Key for First Alert (also requires an additional marketing setup)

Directing users to an application selection screen

  • When directing the user to "oauth2/authorize" add "&appSelect=1" to the request. The result will be this screen:

You also have the ability to direct users to a First Alert or Resideo app login experience

  • When directing the user to "oauth2/authorize" add "&subSystemId=1" or "&subSystemId=5" to the request. "5" being First Alert.

Creating a separate Application/API Key for First Alert

  • To do this, create a new application in the developer portal and ask Resideo to change it to be First Alert dedicated

 

API DIFFERENCES AND PRODUCTS SUPPORTED

The following products currently work in the First Alert app:

  • T5/T6/T9/T10
  • L1 Leak Detector
  • L5 Shutoff Valve
  • VX1 Doorbell

API Backwards Compatibility

  • The API endpoints work with either First Alert Tokens/UserIds or Resideo Tokens/UserIds
  • API contracts should be completely backwards compatible aside from the change in UserId, LocationId, DeviceId formats
  • UserId, LocationId, and DeviceId formats have changed
    • Current Resideo app values:
      • LocationId: 12345 (int)
      • UserId: 5020385 (int)
      • DeviceId: "LCC-B82CA060D386" (string)
    • First Alert values:
      • LocationId: "302000011002" (bigint)
      • UserId: "301000001002" (bigint)
      • DeviceId: "cbfa2b27-c316-ef11-a9cd-6045bdbabfc1" (uuid)

Changes necessary for Event Hub Events

  • Decision on your part is required for how First Alert users authorize (app selection, dedicated link on your page, etc)
  • Your platform must support the new DeviceId, UserId, LocationId formats
  • Event Hub events should remain the same, aside from:
    • Subsystem in the Event Properties/Headers will be "Ds"
    • FrontendId will be the UUID
    • BackendId will be the MACID
  • Testing to ensure the event and API payloads are matching aside from the ID format changes
  • Example Event Hub event format: