# Webhook
Source: [https://docs.qualcomm.com/doc/80-70215-1/topic/webhook.html](https://docs.qualcomm.com/doc/80-70215-1/topic/webhook.html)
The Qualcomm Aware platform offers webhook to send notifications to an external service
or application. Users can create a webhook by navigating to the Aware service portal's
Menu → Manage → Notifications. This process requires users to supply a *HTTPS API endpoint* and an *API Key* from which users wish to receive the data from
the Aware platform. Also, note that the webhook is only outbound traffic from Aware to
*HTTPS API endpoint*, and users cannot perform create or modify operations
through that interface.
- Set up the webhook by providing the *URL, API\_KEY* with an appropriate
header key name.
- Once set up is done, the Aware platform will start sending telemetry, alerts,
and configuration update payload data at the provided URL.
- The payload definitions can be found under webhookmock APIs [here](https://playground.na-rpb.demo.aware.qualcomm.com/public/swagger-ui/index.html?urls.primaryName=notification#/webhookmock).
## Webhook payload schema
The following table contains the types of messages, along with sample payload
structures.
Table : Webhook messages and example payload structures
| Message type | Webhook payload structure | Sample output |
| --- | --- | --- |
| Telemetry | {
"messageType": "deviceTelemetryReport",
"messageSequenceID": 491,
"webhookSequenceId": 1121,
"results": [
Telemetry*
]
}Copy to clipboard
\**Telemetry* is an Object; the schema definition is
available at [API docs](https://playground.na-rpb.demo.aware.qualcomm.com/public/swagger-ui/index.html?urls.primaryName=notification#/webhookmock/telemetry). | {
"messageType": "deviceTelemetryReport",
"messageSequenceId": 491,
"webhookSequenceId": 1121,
"results": [
{
"serialNumber": "TRK000010001",
"serviceState": "READY",
"serverReceivedTimeStamp": 1697458482853,
"deviceReportingTimeStamp": 1697458478399,
"deviceReportId": 143,
"productType": "QTS110",
"location": {
"latitude": 17.439508,
"longitude": 78.376718,
"timeStamp": 1697458478699,
"locationTechType": "WIFI",
"radioAccessTechnology": "GSM",
"operatorName": "Telefonica Spain",
"horizontalUncertainty": 70,
"altitude": 500,
"altitudeUncertainty": 0
},
"temperature": [{
"val": 24.6,
"timeStamp": 1697458456993
}],
"pressure": [{
"val": 943,
"timeStamp": 1697458456993
}],
"humidity": [{
"val": 41.5,
"timeStamp": 1697458456993
}],
"tilt": [{
"val": 5,
"timeStamp": 1697458456993
}],
"light": [{
"val": 209.5,
"timeStamp": 1697458456993
}],
"batteryStatus": {
"batteryPercentage": 97,
"batteryVoltage": 4146
}
}
]
}Copy to clipboard |
| Alert | {
"messageType": "alert",
"messageSequenceID": 498,
"webhookSequenceId": 1239,
"results": [
AlertDataDto*
]
}Copy to clipboard
\**AlertDataDto* is an Object; the schema definition is
available at [API docs](https://playground.na-rpb.demo.aware.qualcomm.com/public/swagger-ui/index.html?urls.primaryName=notification#/webhookmock/alerts). | {
"messageType": "alert",
"messageSequenceId": 498,
"webhookSequenceId": 1239,
"results": [
{
"serialNumber": "TRK000010001",
"deviceReportId": 123,
"serverReceivedTimeStamp": 1697459370276,
"deviceReportingTimeStamp": 1697459365598,
"shipmentId": 787846,
"productType": "QTS110",
"location": {
"latitude": 17.42983,
"longitude": 78.38109,
"timeStamp": 1697459365598,
"locationTechType": "WIFI",
"radioAccessTechnology": "GSM",
"operatorName": "Telefonica Spain",
"horizontalUncertainty": 35,
"altitude": 500,
"altitudeUncertainty": 0
},
"alertDetails": {
"eventTrigger": "Humidity",
"eventType": "BreachCleared",
"val": 36.6,
"threshold": 95.334654,
"timeStamp": 1697459356878,
"message": "Humidity is 36.6, Breach Cleared",
"duration": 899885,
"previousServiceState": "ShipmentInProgress",
"newServiceState": "ShipmentInProgress"
}
}
]
}Copy to clipboard |
| ConfigAck | {
"messageType": "configAckDetails",
"messageSequenceID": 499,
"webhookSequenceId": 1242,
"results": [
ConfigUpdateDetailsDto*
]
}Copy to clipboard
\**ConfigUpdateDetailsDto* is an Object; the schema
definition is available at [API docs](https://playground.na-rpb.demo.aware.qualcomm.com/public/swagger-ui/index.html?urls.primaryName=notification#/webhookmock/configurationUpdate). | {
"messageType": "configAckDetails",
"messageSequenceId": 499,
"webhookSequenceId": 1242,
"results": [
{
"serialNumber": "TRK000010001",
"serverReceivedTimeStamp": 1697457992231,
"shipmentId": "ca2757d6-543b-4b7f-ace3-5ba172d1d6de",
"productType": "QTS110",
"message": "Configuration was updated successfully",
"devicePropertyConfiguration": {
"temperature": {
"minValue": -20,
"maxValue": 60,
"breachPersistenceTimeLimit": 5,
"isEnabled": true
},
"pressure": {
"minValue": 260,
"maxValue": 1260,
"breachPersistenceTimeLimit": 10,
"isEnabled": true
},
"humidity": {
"minValue": 0,
"maxValue": 100,
"breachPersistenceTimeLimit": 5,
"isEnabled": true
},
"tilt": {
"maxValue": 180,
"isEnabled": true
},
"light": {
"isEnabled": true
},
"fall": {
"isEnabled": true
},
"location": {
"isEnabled": true,
"priority": {
"level1": "GNSS",
"level2": "WIFI",
"level3": "CELL"
}
}
}
}
]
}Copy to clipboard |
Users may also choose which events are of interest to receive over the Webhook (Menu > Manage > Notifications page). By default, all are selected.
Last Published: Jun 05, 2026
[Previous Topic
Aware APIs](https://docs.qualcomm.com/bundle/publicresource/80-70215-1/topics/aware-apis.md) [Next Topic
Subtenancy Feature](https://docs.qualcomm.com/bundle/publicresource/80-70215-1/topics/subtenancy-feature.md)