People Protect Quickstart
This quickstart gets a People Protect integration through the basic server flow: authenticate, register a customer, create a live-location callout, and open callout tracking for the customer.
Authenticate
First, exchange your client ID and client secret for a secure bearer token. Include this token in the header of all subsequent API calls.
- Reference: Exchange credentials for a token
Register a customer with a subscription
Create the customer profile representing the protected user, and activate a
subscription in the same call — live callouts require the customer to have an
active subscription, so creating one without a subscription leaves the
customer unable to request help. Store the returned customerId; you need it
for subscriptions and callouts.
- Reference: Create a customer
Get valid subscriptionTypeId values for your customer source from
List subscription types.
Create a callout at the customer's current location
When the user requests assistance, create a callout for that customer using
their current latitude and longitude. Use the customerId returned in the
previous step as the path parameter.
- Reference: Create a customer callout
If the customer already has an active callout, this call returns the existing callout rather than creating another one.
Open the live tracking URL
The callout response always includes a hosted tracking link in its url
field. Redirect the customer’s browser to it or load it inside an in-app
WebView so the user can track the response.
- Guide: Callout tracking
Verify and close the callout
Read the callout back to confirm its state. Note that the read endpoint
returns a richer, nested shape than the creation response — incident and
dispatch detail live under incidentInformation[].
Staging callouts are never closed automatically. To drive your callout
through dispatch, arrival, completion, and closure, open the
Responder Simulator in the AURA portal
(switch to Staging mode), enter your calloutId, and step through the flow.
The simulator does not emit webhook events — poll the callout to observe
its state changes.
- Reference: Get a callout
