Skip to content

Commit f569b02

Browse files
r-brownr-brown
committed
Update Notifications in wiki
1 parent 5b44b2f commit f569b02

File tree

1 file changed

+102
-138
lines changed

1 file changed

+102
-138
lines changed

‎docs/notifications.md

Lines changed: 102 additions & 138 deletions
Original file line numberDiff line numberDiff line change
@@ -54,69 +54,44 @@ Notification payload can be configured to include specific data related to the e
5454

5555
The standard payload structure includes the following fields:
5656

57-
- **Event**: `${event}` - full event object
58-
- **Data**: `${event.data}` - event-specific data
59-
- **Name**: `${event.name}` - event name; can be one of the following: `LICENSEE_CREATED`, `LICENSE_CREATED`, `WARNING_LEVEL_CHANGED`
60-
- **Timestamp**: `${event.timestamp}` - timestamp of the event
57+
- **Notification**: `{$}` - full notification data
58+
- **Timestamp**: `{$.timestamp}` - timestamp of the notification
59+
- **Origin**: `{$.origin}` - can be one of the following: `Notification`
60+
- **Entities**: `{$.entities}` - notification-specific data
61+
- **Name**: `{$.entities.Event[0].name}` - notification name; can be one of the following: `LICENSEE_CREATED`, `LICENSE_CREATED`, `WARNING_LEVEL_CHANGED`
6162

62-
Below are examples of the payload structure (`event.data` element) for different events:
63+
Below are examples of the payload structure (`{$}` element) for different notification types:
6364

6465
<div>LICENSEE_CREATED</div>
6566
{: .code-example .ml-5 .code-header }
6667
```json
6768
{
68-
...
69-
"items": {
70-
"item": [
69+
"timestamp": "2024-09-19T04:29:47.445Z",
70+
"origin": "Notification",
71+
"entities": {
72+
"Event": [
7173
{
72-
"property": [
73-
{
74-
"value": "IADGNSGZG",
75-
"name": "number"
76-
},
77-
{
78-
"value": "true",
79-
"name": "active"
80-
},
81-
{
82-
"value": "PQMW7JWWN",
83-
"name": "productNumber"
84-
},
85-
{
86-
"value": "Customer 04",
87-
"name": "name"
88-
},
89-
{
90-
"value": "{\"RED\":[],\"YELLOW\":[],\"GREEN\":[]}",
91-
"name": "warningLevel"
92-
},
93-
...
94-
],
95-
"type": "Licensee"
96-
},
97-
{
98-
"property": [
99-
{
100-
"value": "PQMW7JWWN",
101-
"name": "number"
102-
},
103-
{
104-
"value": "true",
105-
"name": "active"
106-
},
107-
{
108-
"value": "Pricing Table demo product",
109-
"name": "name"
110-
},
111-
...
112-
],
113-
...
114-
"type": "Product"
74+
"name": "LICENSEE_CREATED"
11575
}
11676
],
117-
...
118-
},
119-
...
77+
"Licensee": [
78+
{
79+
"number": "IKWUYQ9GR",
80+
"active": true,
81+
"licenseeSecret": "",
82+
"warningLevelSummary": {
83+
"RED": [],
84+
"YELLOW": [],
85+
"GREEN": []
86+
},
87+
"name": "Customer Uno",
88+
"markedForTransfer": "false",
89+
"products": [
90+
"PEP4ZQ6MV"
91+
]
92+
}
93+
]
94+
}
12095
}
12196
```
12297
{: .ml-5 }
@@ -126,40 +101,30 @@ Below are examples of the payload structure (`event.data` element) for different
126101
{: .code-example .ml-5 .code-header }
127102
```json
128103
{
129-
...
130-
"items": {
131-
"item": [
104+
"timestamp": "2024-09-19T04:30:26.006Z",
105+
"origin": "Notification",
106+
"entities": {
107+
"Event": [
132108
{
133-
"property": [
134-
{
135-
"value": "L76HEM5M6",
136-
"name": "number"
137-
},
138-
{
139-
"value": "true",
140-
"name": "active"
141-
},
142-
{
143-
"value": "License 01",
144-
"name": "name"
145-
},
146-
{
147-
"value": "IADGNSGZG",
148-
"name": "licenseeNumber"
149-
},
150-
{
151-
"value": "E9FSDF2RX",
152-
"name": "licenseTemplateNumber"
153-
},
154-
...
155-
],
156-
"list": [],
157-
"type": "License"
109+
"name": "LICENSE_CREATED"
158110
}
159111
],
160-
...
161-
},
162-
...
112+
"License": [
113+
{
114+
"number": "LN2TD47QY",
115+
"active": true,
116+
"currency": "EUR",
117+
"price": 0,
118+
"hidden": false,
119+
"gracePeriod": "false",
120+
"timeVolumePeriod": "MONTH",
121+
"timeVolume": "3",
122+
"startDate": "2024-09-19T04:30:26.004Z",
123+
"licensee": "IKWUYQ9GR",
124+
"licenseTemplate": "E27NV3IQD"
125+
}
126+
]
127+
}
163128
}
164129
```
165130
{: .ml-5 }
@@ -169,64 +134,63 @@ Below are examples of the payload structure (`event.data` element) for different
169134
{: .code-example .ml-5 .code-header }
170135
```json
171136
{
172-
...
173-
"items": {
174-
"item": [
137+
"timestamp": "2024-09-19T04:30:57.709Z",
138+
"origin": "Notification",
139+
"entities": {
140+
"Event": [
175141
{
176-
"property": [
177-
{
178-
"value": "N123456",
179-
"name": "number"
180-
},
181-
{
182-
"value": "true",
183-
"name": "active"
184-
},
185-
{
186-
"value": "P5URES4FZ",
187-
"name": "productNumber"
188-
},
189-
{
190-
"value": "Customer 04",
191-
"name": "name"
192-
},
193-
{
194-
"value": "{\"RED\":[],\"YELLOW\":[],\"GREEN\":[\"MQWTGNYMI\",\"MT2VNWASP\"]}",
195-
"name": "warningLevel"
196-
}
197-
...
198-
],
199-
"list": [],
200-
"type": "Licensee"
201-
},
142+
"name": "WARNING_LEVEL_CHANGED"
143+
}
144+
],
145+
"Licensee": [
202146
{
203-
"property": [
204-
{
205-
"value": "true",
206-
"name": "valid"
207-
},
208-
{
209-
"value": "Features",
210-
"name": "productModuleName"
211-
},
212-
{
213-
"value": "GREEN",
214-
"name": "warningLevel"
215-
},
216-
{
217-
"value": "MultiFeature",
218-
"name": "licensingModel"
219-
},
220-
{
221-
"value": "MT2VNWASP",
222-
"name": "productModuleNumber"
223-
}
147+
"number": "IKWUYQ9GR",
148+
"active": true,
149+
"licenseeSecret": "",
150+
"warningLevelSummary": {
151+
"RED": [
152+
"MW53JJ3RY",
153+
"MCJZGAMXS"
154+
],
155+
"YELLOW": [],
156+
"GREEN": [
157+
"MVEMJ5P9D"
158+
]
159+
},
160+
"name": "Customer Uno",
161+
"markedForTransfer": "false",
162+
"products": [
163+
"PEP4ZQ6MV"
224164
],
225-
...
226-
"type": "ProductModuleValidation"
165+
"licenses": [
166+
"LN2TD47QY"
167+
]
227168
}
228169
],
229-
...
170+
"ProductModuleValidation": [
171+
{
172+
"productModuleNumber": "MW53JJ3RY",
173+
"valid": "false",
174+
"productModuleName": "Subscription",
175+
"warningLevel": "RED",
176+
"licensingModel": "Subscription"
177+
},
178+
{
179+
"productModuleNumber": "MCJZGAMXS",
180+
"valid": "false",
181+
"productModuleName": "Maintenance",
182+
"warningLevel": "RED",
183+
"licensingModel": "Subscription"
184+
},
185+
{
186+
"productModuleNumber": "MVEMJ5P9D",
187+
"valid": "true",
188+
"expires": "2024-12-19T04:30:26.004Z",
189+
"productModuleName": "Support",
190+
"warningLevel": "GREEN",
191+
"licensingModel": "Subscription"
192+
}
193+
]
230194
}
231195
}
232196
```

0 commit comments

Comments
 (0)