Use cases

Smart Home Security

Smart Home Security integrations are for alarm-panel manufacturers, OEM alarm providers, connected-home platforms, and app-led security products that want to embed AURA response into their own customer experience.

This pattern is a hybrid of customer onboarding, subscriptions, Fixed Locations, and hosted signup. Use it when the protected customer, their property, and their alarm service need to be connected before a real response can be requested. It usually fits products where the customer monitors their own alarm state and requests AURA dispatch directly from your app or portal, rather than an operator requesting dispatch from a third-party monitoring solution.

When to use this

  • Your product protects homes, small businesses, or managed properties.
  • Customers subscribe to an alarm response add-on from inside your product.
  • Each customer is linked to one or more Fixed Locations.
  • Your app or portal should embed AURA-hosted signup instead of rebuilding the full onboarding and payment flow.
  • Customers can monitor alarm activity and request AURA dispatch directly in your product.
  • Alarm events from your platform may become AURA callouts for the matching Fixed Location.

If operators in an alarm receiving centre or monitoring platform request dispatch on the customer’s behalf, see Monitoring Platforms. If your product only creates live user-location alerts, see People Protect.

Onboard the customer

Use an AURA-hosted signup session when you want the customer to complete profile, payment, subscription, and optional Fixed Location setup without your product owning every form and payment step.

Create a signup session from your backend, then open the returned URL in your app, portal, or browser flow. After AURA redirects to your returnUrl, retrieve the signup session and store the returned identifiers in your own system.

See Embedded flows for the shared embedding pattern and sample starter project.

Reference: Create a signup session, Retrieve a signup session.

Before exposing alarm response to the customer, confirm that the customer has an active subscription and a Fixed Location that matches the protected property.

Store these identifiers against your own customer, premises, panel, or account record:

  • AURA customerId.
  • AURA subscription id or the current active subscription from lookup.
  • AURA Fixed Location id.
  • Your externalReferenceId for the Fixed Location.
  • Your alarm account, panel, or property identifier.

Reference: List customer subscriptions, Create a fixed location, List fixed locations.

Create an alarm response

When your alarm platform determines that AURA response is needed, resolve the alarm event to the customer’s Fixed Location and create a Fixed Location callout. Store the returned callout id against your alarm event so your backend can cancel, poll, annotate, or attach final reports later.

Reference: Create a fixed-location callout.

Keep the product in sync

Use webhooks for lifecycle updates so your product can show dispatch progress, arrival, cancellation, and closure without polling as the primary mechanism. Keep polling as a fallback for active incidents if your webhook endpoint is not available.

Reference: Webhooks, Get a callout, Read callout events.

Cancellation

False alarms, customer resets, or operator decisions should cancel the AURA callout from your trusted backend.

Reference: Cancel a callout.

Go-live checklist

  • Decide whether signup is fully embedded, opened in browser, or started from an account-management portal.
  • Store AURA identifiers against your customer and property records.
  • Confirm every customer can only request response after subscription activation.
  • Confirm every alarm event resolves to the correct Fixed Location externalReferenceId.
  • Test failed, cancelled, and completed signup outcomes.
  • Test alarm response creation, cancellation, and webhooks.
  • Define how your product handles moved properties, cancelled subscriptions, and deleted Fixed Locations.

In the API Reference

  • Customer sessions
    • create and retrieve hosted signup sessions.
  • Customers - store and update protected customer profiles.
  • Subscriptions - confirm or manage response entitlement.
  • Fixed Locations - manage protected properties and create Fixed Location callouts.
  • Callouts - cancel, annotate, inspect, and report on callouts.
  • Webhooks - receive lifecycle updates.