Awell Health Developer Hub
Developer Hub

Payload

  • json
01{
02 "activity": {
03 "id": "<ACTIVITY_ID>",
04 "stream_id": "<PATHWAY_ID>",
05 "date": "<CREATION_DATE>", // In ISO8601 format
06 "subject": {
07 "type": "awell",
08 "name": "Awell"
09 },
10 "action": "<ACTION>",
11 "object": {
12 "id": "<OBJECT_ID>",
13 "type": "<OBJECT_TYPE>",
14 "name": "<OBJECT_NAME>"
15 },
16 "indirect_object": {
17 "id": "<OBJECT_ID>",
18 "type": "<OBJECT_TYPE>",
19 "name": "<OBJECT_NAME>"
20 },
21 "status": "active",
22 "track": {
23 "id": "<TRACK_ID>",
24 "title": "<TRACK_TITLE>"
25 },
26 "label": {
27 "color": "<COLOR_NAME>", // green, yellow etc.
28 "id": "<COLOR_ID>",
29 "text": "<COLOR_TEXT>"
30 },
31 "sub_activities": [
32 {
33 "id": "<SUB_ACTIVITY_ID>",
34 "subject": {
35 "type": "awell",
36 "name": "Awell"
37 },
38 "action": "activate",
39 "date": "SUB_ACTIVITY_ACTION_DATE>" // In ISO8601 format
40 }
41 ],
42 "isUserActivity": true,
43 "context": {
44 "action_id": "<ACTION_ID>",
45 "instance_id": "<ACTIVITY_ID>",
46 "pathway_id": "<PATHWAY_ID>",
47 "step_id": "<STEP_ID>",
48 "track_id": "<TRACK_ID>"
49 }
50 },
51 "pathway": {
52 "id": "<PATHWAY_ID>",
53 "pathway_definition_id": "<PATHWAY_DEFINITION_ID>",
54 "patient_id": "<PATIENT_ID>",
55 "start_date": "<PATHWAY_START_DATE>" // In ISO8601 format
56 },
57 "event_type": "activity.created"
58}