For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesWhite-labelAPI Reference
GuidesWhite-labelAPI Reference
  • Get started
    • Introduction
    • Quickstart
    • Authentication
  • Core concepts
    • Callout lifecycle
    • Customers & customer sources
    • Subscriptions & coverage
  • Integration patterns
    • Overview
    • Personal Safety
    • Fixed Locations
    • IoT Devices
  • AURA-hosted
    • Customer signup
    • Web Dispatch
    • Subscription management
    • Webhooks
    • Go-live
LogoLogo
On this page
  • Before you start
  • Linking a device
  • Sending device events
  • Examples
  • Payment
Integration patterns

Device & payment gateway

Was this page helpful?
Previous

Customer signup

Next
Built with

Connect physical IoT devices (panic buttons, wearables, trackers) to AURA so a device press can raise and manage callouts. AURA normalises each device’s native messages into AURA actions using a device template, so you don’t have to map hardware protocols yourself.

Before you start

Device onboarding is collaborative — AURA registers your device offering first and gives you the identifiers you’ll send on every event:

  • deviceId — the device serial number.
  • device_type_id — identifies the device model, and selects the template AURA uses to interpret its messages.
  • deviceSupplier — the device brand.

You’ll also need your clientId / clientSecret to authenticate. There is no endpoint that lists device_type_ids — AURA provides the ones registered to you. To get set up, contact your AURA integration team.

Linking a device

Link a device to a customer so it can act on their behalf, then manage that link over time:

  • Link a device — POST /v2/devices
  • Update a linked device — PUT /v2/devices
  • Unlink a device — DELETE /v2/devices/{deviceId}

Sending device events

Every other interaction — raising a callout, updating location, cancelling, or reporting battery/health — flows through a single endpoint: Send a device event (POST /v2/deviceEvent). AURA applies the device’s template (by device_type_id) to interpret the incoming message and map it to an AURA action:

ActionMeaning
New calloutRaise a callout from the device’s location
Location updateUpdate an active callout’s location
Cancel calloutCancel the device’s active callout
Battery / healthRecord a battery level or heartbeat

The exact message-to-action mapping is defined by your device template and agreed during onboarding. For structured devices, a message_type selects the action; for devices that emit binary/hex payloads, the template parses the raw message.

Examples

Raise a callout:

1{
2 "location": { "latitude": -26.0919, "longitude": 28.084, "accuracy": 70 },
3 "device_id": 26217939,
4 "device_type_id": 5,
5 "message_type": 1
6}

Update the callout location:

1{
2 "latitude": -26.1016, "longitude": 28.0719, "accuracy": 70,
3 "device_id": 26217939, "device_type_id": 4, "message_type": 2
4}

Cancel the callout:

1{ "device_id": 26217939, "device_type_id": 4, "message_type": 3 }

Report a battery / health update:

1{ "battery": 70, "deviceId": 13, "device_type_id": 4, "message_type": 4 }

See the reference for more cases, including raw/templated device formats.

Payment

Taking payment in-app is specific to white-label apps — see Payment gateway. Subscriptions (however they’re paid for) gate live callouts; see Subscriptions & coverage.