Skip to content

Commit 6a1c3f5

Browse files
eshanrnheshanrnh
authored
Merge pull request #7137 from uniquelau/master
Update webhook reference documentation to fix incorrectly cased properties
2 parents bce2db1 + eebf809 commit 6a1c3f5

File tree

6 files changed

+48
-36
lines changed
  • 14/umbraco-cms
  • 15/umbraco-cms
  • 16/umbraco-cms

6 files changed

+48
-36
lines changed

‎14/umbraco-cms/fundamentals/setup/upgrading/version-specific/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,10 @@ The deprecated version, `Microsoft.Data.SQlite`, has been removed and will requi
223223

224224
```
225225

226+
* **Webhook payload property casing has changed**
227+
228+
Following changes to serialization, property names in the payload now use camelCase instead of PascalCase. For example, the 'CreateDate' property is now 'createDate'.
229+
226230
**In-depth and further breaking changes for Umbraco 14 can be found on the** [**CMS GitHub**](https://github.com/umbraco/Umbraco-CMS/pulls?q=is%3Apr+base%3Av14%2Fdev+label%3Acategory%2Fbreaking) **repository and on** [**Our Website**](https://our.umbraco.com/download/releases/1400)**.**
227231

228232
</details>

‎14/umbraco-cms/reference/webhooks/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,27 +52,27 @@ For example, the `Content Published` event sends the specific content that trigg
5252

5353
```json
5454
{
55-
"Name": "Root",
56-
"CreateDate": "2023-12-11T12:02:38.9979314",
57-
"UpdateDate": "2023-12-11T12:02:38.9979314",
58-
"Route": {
59-
"Path": "/",
60-
"StartItem": {
61-
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
62-
"Path": "root"
55+
"name": "Root",
56+
"createDate": "2023-12-11T12:02:38.9979314",
57+
"updateDate": "2023-12-11T12:02:38.9979314",
58+
"route": {
59+
"path": "/",
60+
"startItem": {
61+
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
62+
"path": "root"
6363
}
6464
},
65-
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
66-
"ContentType": "root",
67-
"Properties": {}
65+
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
66+
"contentType": "root",
67+
"properties": {}
6868
}
6969
```
7070

7171
However, the `Content deleted` does not send the entire content as JSON, instead, it sends the `Id` of the content:
7272

7373
```json
7474
{
75-
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135"
75+
"id": "c1922956-7855-4fa0-8f2c-7af149a92135"
7676
}
7777
```
7878

‎15/umbraco-cms/fundamentals/setup/upgrading/version-specific/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,10 @@ The deprecated version, `Microsoft.Data.SQlite`, has been removed and will requi
272272

273273
```
274274

275+
* **Webhook payload property casing has changed**
276+
277+
Following changes to serialization, property names in the payload now use camelCase instead of PascalCase. For example, the 'CreateDate' property is now 'createDate'.
278+
275279
**In-depth and further breaking changes for Umbraco 14 can be found on the** [**CMS GitHub**](https://github.com/umbraco/Umbraco-CMS/pulls?q=is%3Apr+base%3Av14%2Fdev+label%3Acategory%2Fbreaking) **repository and on** [**Our Website**](https://our.umbraco.com/download/releases/1400)**.**
276280

277281
</details>

‎15/umbraco-cms/reference/webhooks/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,27 +56,27 @@ Each webhook event sends a JSON payload. For example, the `Content Published` ev
5656

5757
```json
5858
{
59-
"Name": "Root",
60-
"CreateDate": "2023-12-11T12:02:38.9979314",
61-
"UpdateDate": "2023-12-11T12:02:38.9979314",
62-
"Route": {
63-
"Path": "/",
64-
"StartItem": {
65-
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
66-
"Path": "root"
59+
"name": "Root",
60+
"createDate": "2023-12-11T12:02:38.9979314",
61+
"updateDate": "2023-12-11T12:02:38.9979314",
62+
"route": {
63+
"path": "/",
64+
"startItem": {
65+
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
66+
"path": "root"
6767
}
6868
},
69-
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
70-
"ContentType": "root",
71-
"Properties": {}
69+
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
70+
"contentType": "root",
71+
"properties": {}
7272
}
7373
```
7474

7575
The `Content Deleted` event sends only the content ID:
7676

7777
```json
7878
{
79-
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135"
79+
"id": "c1922956-7855-4fa0-8f2c-7af149a92135"
8080
}
8181
```
8282

‎16/umbraco-cms/fundamentals/setup/upgrading/version-specific/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,10 @@ The deprecated version, `Microsoft.Data.SQlite`, has been removed and will requi
308308

309309
```
310310

311+
* **Webhook payload property casing has changed**
312+
313+
Following changes to serialization, property names in the payload now use camelCase instead of PascalCase. For example, the 'CreateDate' property is now 'createDate'.
314+
311315
**In-depth and further breaking changes for Umbraco 14 can be found on the** [**CMS GitHub**](https://github.com/umbraco/Umbraco-CMS/pulls?q=is%3Apr+base%3Av14%2Fdev+label%3Acategory%2Fbreaking) **repository and on** [**Our Website**](https://our.umbraco.com/download/releases/1400)**.**
312316

313317
</details>

‎16/umbraco-cms/reference/webhooks/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,27 +56,27 @@ Each webhook event sends a JSON payload. For example, the `Content Published` ev
5656

5757
```json
5858
{
59-
"Name": "Root",
60-
"CreateDate": "2023-12-11T12:02:38.9979314",
61-
"UpdateDate": "2023-12-11T12:02:38.9979314",
62-
"Route": {
63-
"Path": "/",
64-
"StartItem": {
65-
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
66-
"Path": "root"
59+
"name": "Root",
60+
"createDate": "2023-12-11T12:02:38.9979314",
61+
"updateDate": "2023-12-11T12:02:38.9979314",
62+
"route": {
63+
"path": "/",
64+
"startItem": {
65+
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
66+
"path": "root"
6767
}
6868
},
69-
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
70-
"ContentType": "root",
71-
"Properties": {}
69+
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
70+
"contentType": "root",
71+
"properties": {}
7272
}
7373
```
7474

7575
The `Content Deleted` event sends only the content ID:
7676

7777
```json
7878
{
79-
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135"
79+
"id": "c1922956-7855-4fa0-8f2c-7af149a92135"
8080
}
8181
```
8282

0 commit comments

Comments
 (0)