You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/webhooks-sprints.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,22 +9,24 @@ weight: 75
9
9
## 1 Introduction
10
10
11
11
{{% 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*.
13
15
{{% /alert %}}
14
16
15
17
{{% 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/).
17
19
{{% /alert %}}
18
20
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.
20
22
21
23
Every POST payload contains the following delivery information as part of the header:
22
24
23
25
*`MxAPI-Projects-EventCategory` – the types of event subscribed to (for example, Sprints)
24
26
*`MxAPI-Projects-Delivery` – a random UUID
25
27
*`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)
26
28
* 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)
28
30
*`MxAPI-Webhooks-Version-Expiry` – the expiry date for this version (empty if it is the latest version)
29
31
*`User-Agent` – `Mx-Platform`
30
32
@@ -36,7 +38,7 @@ The required event category subscription is **Sprints**.
36
38
37
39
## 3 Stories
38
40
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.
40
42
41
43
The required event category subscription is **Stories**.
Copy file name to clipboardExpand all lines: content/en/docs/developerportal/deploy/mendix-cloud-deploy/webhooks.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ The webhooks contain a retry mechanism if an error response is received from the
25
25
{{% alert color="info" %}}
26
26
Webhooks are only available for licensed Mendix apps which are deployed to the Mendix Cloud.
27
27
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).
Copy file name to clipboardExpand all lines: content/en/docs/releasenotes/developer-portal/_index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ To see the current status of the Mendix Developer Portal and Control Center, see
26
26
27
27
#### Deprecations
28
28
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/).
30
30
31
31
### March 9th, 2023
32
32
@@ -963,7 +963,7 @@ In Portfolio Management, you can do the following
963
963
964
964
#### Webhooks Available
965
965
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.
0 commit comments