1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
# `register event listener` - [Devices API](../README.md#devices-api)
The `register event listener` method of the devices API notifies a registered
listener upon device specific events. It uses HTTP long polling in send the
event to this listener in real time, so upon receiving an event, the
connection has to be reestablished by the client to receive further events.
## HTTP Request
`GET /api/devices/<device_token>/events`
## Query Parameters
| Parameter | Desciption | Example |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `device_token` | The token of the device which performed the request. (Optional) Lets the server know the registered device is still active. | `device_token=7dafeec0-c351-11e9-84c5-3d1ede2e7d2e` |
## Response Payload
```json
{
"type": "<String>",
"data": "<Any>"
}
```
- **type** defines what type of event has been triggered.
- **data** contains the event specific payload.
## Event Types
### Start session
See [device specific events](./event-types.md#device-specific)
## Example
**Request:**
`GET /api/devices/1d9f5d30-830f-11ea-8dcb-0021ccd76152/events`
**Response:**
```json
{
"type": "start_session",
"data": {
"session_token": "974c84e0-c35d-11e9-8f8d-47bb5bb0037d"
}
}
```
|
