Skip to content

Commit 52a52bd

Browse files
committed
FInish update to webhook naming
1 parent e1b2478 commit 52a52bd

3 files changed

Lines changed: 10 additions & 8 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/webhooks-sprints.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,24 @@ weight: 75
99
## 1 Introduction
1010

1111
{{% alert color="warning" %}}
12-
The webhook payloads described in this document are for app Sprints and stories. These webhooks were enabled via **General Settings** > **Webhooks** or via your app. These webhooks have been deprecated. For more information, see the deprecation note in [Webhooks](/developerportal/collaborate/general-settings/#webhooks).
12+
The webhook payloads described in this document are for app stories and Sprints. These webhooks were enabled via **General Settings** > **Webhooks** or via your app.
13+
14+
The webhooks for stories and Sprints have been deprecated. For more information, see the deprecation note in the [Webhooks](/developerportal/collaborate/general-settings/#webhooks) section of *General Settings*.
1315
{{% /alert %}}
1416

1517
{{% alert color="info" %}}
16-
You can now set deployment webhooks for your app. These are described in [Webhooks](/developerportal/deploy/webhooks/).
18+
You can also set deployment webhooks for your app. These are described in [Webhooks](/developerportal/deploy/webhooks/).
1719
{{% /alert %}}
1820

19-
Webhooks allow you to build or set up Mendix Platform connectors that subscribe to certain events on the Developer Portal. When one of those events is triggered, Mendix sends an HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external application to keep it up-to-date with the changes happening in the Developer Portal.
21+
Webhooks for stories and Sprints allow you to build or set up Mendix Platform connectors that subscribe to certain events on the Developer Portal. When one of those events is triggered, Mendix sends an HTTP POST payload to the webhook's configured URL. Webhooks for stories and Sprints can be used to update an external application to keep it up-to-date with the changes happening in the Developer Portal.
2022

2123
Every POST payload contains the following delivery information as part of the header:
2224

2325
* `MxAPI-Projects-EventCategory` – the types of event subscribed to (for example, Sprints)
2426
* `MxAPI-Projects-Delivery` – a random UUID
2527
* `MxAPI-Signature` – the HMAC hex digest (asymmetric hash using the *HMAC_SHA256* hash algorithm) of the response body, which is calculated using the hash (the hashes secret provided in the webhooks setting using the *SHA-256* hash algorithm with the length as 50)
2628
* For example, `(gNh407kBD1wkpHfwIrjWcTMjw4rKxIKX0s5b48FYOys=)`
27-
* `MxAPI-Webhooks-Version` – the version of the webhooks payload (for example, 1)
29+
* `MxAPI-Webhooks-Version` – the version of the webhooks for stories and Sprints payload (for example, 1)
2830
* `MxAPI-Webhooks-Version-Expiry` – the expiry date for this version (empty if it is the latest version)
2931
* `User-Agent``Mx-Platform`
3032

@@ -36,7 +38,7 @@ The required event category subscription is **Sprints**.
3638

3739
## 3 Stories
3840

39-
Webhooks event are generated when a [story](/developerportal/collaborate/stories/) is created or updated.
41+
Webhooks for stories and Sprints event are generated when a [story](/developerportal/collaborate/stories/) is created or updated.
4042

4143
The required event category subscription is **Stories**.
4244

content/en/docs/developerportal/deploy/mendix-cloud-deploy/webhooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The webhooks contain a retry mechanism if an error response is received from the
2525
{{% alert color="info" %}}
2626
Webhooks are only available for licensed Mendix apps which are deployed to the Mendix Cloud.
2727

28-
They are set up and work independently of the [webhooks used for Sprints and stories](/developerportal/collaborate/general-settings/#webhooks), which are deprecated.
28+
They are set up and work independently of the deprecated [webhooks for Sprints and Stories](/developerportal/collaborate/general-settings/#webhooks).
2929
{{% /alert %}}
3030

3131
## 2 Configuring a Webhook{#setting-up}

content/en/docs/releasenotes/developer-portal/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To see the current status of the Mendix Developer Portal and Control Center, see
2626

2727
#### Deprecations
2828

29-
* We have deprecated **General Settings** > **Webhooks** for app Sprints and stories. For more information, see the deprecation note in [Webhooks](/developerportal/collaborate/general-settings/#webhooks). You can now set webhooks for your app. These are described in [Webhooks](/developerportal/deploy/webhooks/).
29+
* We have deprecated **General Settings** > **Webhooks** for stories and Sprints. For more information, see the deprecation note in the [Webhooks](/developerportal/collaborate/general-settings/#webhooks) section of *General Settings*. You can now set webhooks for building and deploying your app. These are described in [Webhooks](/developerportal/deploy/webhooks/).
3030

3131
### March 9th, 2023
3232

@@ -963,7 +963,7 @@ In Portfolio Management, you can do the following
963963

964964
#### Webhooks Available
965965

966-
* We have added the ability to create webhooks for your apps. These webhooks can be configured to send information when Sprints change and/or stories change.
966+
* We have added the ability to create webhooks for stories and Sprints for your apps. These webhooks can be configured to send information when Sprints change and/or stories change.
967967

968968
### April 5th, 2019
969969

0 commit comments

Comments
 (0)