Skip to content

Update webhook reference documentation to fix incorrectly cased properties #7137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 4, 2025
Merged

Update webhook reference documentation to fix incorrectly cased properties #7137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e746605
fix: update webhook payload casing
uniquelau Jun 3, 2025
eebf809
docs: add breaking change bullet point for webhook payload serializat…
uniquelau Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions 14/umbraco-cms/fundamentals/setup/upgrading/version-specific/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,10 @@ The deprecated version, `Microsoft.Data.SQlite`, has been removed and will requi

```

* **Webhook payload property casing has changed**

Following changes to serialization, property names in the payload now use camelCase instead of PascalCase. For example, the 'CreateDate' property is now 'createDate'.

**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)**.**

</details>
Expand Down
24 changes: 12 additions & 12 deletions 14/umbraco-cms/reference/webhooks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,27 +52,27 @@ For example, the `Content Published` event sends the specific content that trigg

```json
{
"Name": "Root",
"CreateDate": "2023-12-11T12:02:38.9979314",
"UpdateDate": "2023-12-11T12:02:38.9979314",
"Route": {
"Path": "/",
"StartItem": {
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"Path": "root"
"name": "Root",
"createDate": "2023-12-11T12:02:38.9979314",
"updateDate": "2023-12-11T12:02:38.9979314",
"route": {
"path": "/",
"startItem": {
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"path": "root"
}
},
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"ContentType": "root",
"Properties": {}
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"contentType": "root",
"properties": {}
}
```

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

```json
{
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135"
"id": "c1922956-7855-4fa0-8f2c-7af149a92135"
}
```

Expand Down
4 changes: 4 additions & 0 deletions 15/umbraco-cms/fundamentals/setup/upgrading/version-specific/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,10 @@ The deprecated version, `Microsoft.Data.SQlite`, has been removed and will requi

```

* **Webhook payload property casing has changed**

Following changes to serialization, property names in the payload now use camelCase instead of PascalCase. For example, the 'CreateDate' property is now 'createDate'.

**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)**.**

</details>
Expand Down
24 changes: 12 additions & 12 deletions 15/umbraco-cms/reference/webhooks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,27 +56,27 @@ Each webhook event sends a JSON payload. For example, the `Content Published` ev

```json
{
"Name": "Root",
"CreateDate": "2023-12-11T12:02:38.9979314",
"UpdateDate": "2023-12-11T12:02:38.9979314",
"Route": {
"Path": "/",
"StartItem": {
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"Path": "root"
"name": "Root",
"createDate": "2023-12-11T12:02:38.9979314",
"updateDate": "2023-12-11T12:02:38.9979314",
"route": {
"path": "/",
"startItem": {
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"path": "root"
}
},
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"ContentType": "root",
"Properties": {}
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"contentType": "root",
"properties": {}
}
```

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

```json
{
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135"
"id": "c1922956-7855-4fa0-8f2c-7af149a92135"
}
```

Expand Down
4 changes: 4 additions & 0 deletions 16/umbraco-cms/fundamentals/setup/upgrading/version-specific/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,10 @@ The deprecated version, `Microsoft.Data.SQlite`, has been removed and will requi

```

* **Webhook payload property casing has changed**

Following changes to serialization, property names in the payload now use camelCase instead of PascalCase. For example, the 'CreateDate' property is now 'createDate'.

**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)**.**

</details>
Expand Down
24 changes: 12 additions & 12 deletions 16/umbraco-cms/reference/webhooks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,27 +56,27 @@ Each webhook event sends a JSON payload. For example, the `Content Published` ev

```json
{
"Name": "Root",
"CreateDate": "2023-12-11T12:02:38.9979314",
"UpdateDate": "2023-12-11T12:02:38.9979314",
"Route": {
"Path": "/",
"StartItem": {
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"Path": "root"
"name": "Root",
"createDate": "2023-12-11T12:02:38.9979314",
"updateDate": "2023-12-11T12:02:38.9979314",
"route": {
"path": "/",
"startItem": {
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"path": "root"
}
},
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"ContentType": "root",
"Properties": {}
"id": "c1922956-7855-4fa0-8f2c-7af149a92135",
"contentType": "root",
"properties": {}
}
```

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

```json
{
"Id": "c1922956-7855-4fa0-8f2c-7af149a92135"
"id": "c1922956-7855-4fa0-8f2c-7af149a92135"
}
```

Expand Down