Skip to content

Commit 3703972

Browse files
authored
Update notifications.md
1 parent bdeeb63 commit 3703972

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

docs/notifications.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Manage your NetLicensing Notifications from the *"Settings / Notifications"* sec
4242
- **Events**: One or more events that will trigger the notification. Options include:
4343
- **Create Customer**: Triggered when a new customer is created.
4444
- **Create License**: Triggered when a new license is created.
45+
- **Payment Transaction Processed**: Triggered on NetLicensing Shop transaction status change.
4546
- **Change Warning Level**: Triggered on customer's [warning level](warning-level) changes (e.g., from `GREEN` to `YELLOW` or `YELLOW` to `RED`).
4647
- **Type**: The type of notification. Currently, only `WEBHOOK` is supported.
4748
- **Endpoint**: The URL where an HTTP POST request with the specified payload will be sent. **Note:** The endpoint must use the secured HTTPS protocol with a public SSL/TLS certificate.
@@ -58,7 +59,7 @@ The standard payload structure includes the following fields:
5859
- **Timestamp**: `{$.timestamp}` - timestamp of the notification
5960
- **Origin**: `{$.origin}` - can be one of the following: `Notification`
6061
- **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`
62+
- **Name**: `{$.entities.Event[0].name}` - notification name; can be one of the following: `LICENSEE_CREATED`, `LICENSE_CREATED`, `WARNING_LEVEL_CHANGED`, `PAYMENT_TRANSACTION_PROCESSED`
6263

6364
Below are examples of the payload structure (`{$}` element) for different notification types:
6465

@@ -129,6 +130,53 @@ Below are examples of the payload structure (`{$}` element) for different notifi
129130
```
130131
{: .ml-5 }
131132

133+
<div>PAYMENT_TRANSACTION_PROCESSED</div>
134+
{: .code-example .ml-5 .code-header }
135+
```json
136+
{
137+
"timestamp": "2025-03-24T13:31:14.532Z",
138+
"origin": "Notification",
139+
"entities": {
140+
"Event": [
141+
{
142+
"name": "PAYMENT_TRANSACTION_PROCESSED"
143+
}
144+
],
145+
"Transaction": [
146+
{
147+
"number": "TET7WUW3Y",
148+
"active": true,
149+
"source": "SHOP",
150+
"status": "CLOSED",
151+
"price": 10,
152+
"discount": 0,
153+
"currency": "EUR",
154+
"inUse": true,
155+
"datecreated": "2025-03-24T13:31:14.531Z",
156+
"dateclosed": "2025-03-24T13:31:14.531Z",
157+
"vatMode": "GROSS",
158+
"totalExcludingVat": "0.00",
159+
"isSubjectToVat": "false",
160+
"isReverseCharge": "false",
161+
"subTotal": "0.00",
162+
"vatPercent": "0",
163+
"vatAmount": "0.00",
164+
"consentTimestamp": "2025-03-24T13:31:13.162Z",
165+
"consentTermsOfServiceURL": "https://en.wikipedia.org/wiki/North_Pole#terms",
166+
"paymentMethodNumber": "NULL",
167+
"vendorCountryCode": "DE",
168+
"countryCode": "BW",
169+
"paymentMethod": "STRIPE",
170+
"consentPrivacyPolicyURL": "https://en.wikipedia.org/wiki/North_Pole#privacy",
171+
"licenses": [
172+
"LQZ2GAKTZ"
173+
]
174+
}
175+
]
176+
}
177+
}
178+
```
179+
{: .ml-5 }
132180

133181
<div>WARNING_LEVEL_CHANGED</div>
134182
{: .code-example .ml-5 .code-header }

0 commit comments

Comments
 (0)