Skip to content

Commit b937a9d

Browse files
authored
Merge pull request mendix#7487 from mendix/db-webhooks
Move Webhooks doc
2 parents ebe201c + ad2152f commit b937a9d

File tree

5 files changed

+11
-144
lines changed

5 files changed

+11
-144
lines changed

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

Lines changed: 0 additions & 97 deletions
This file was deleted.

content/en/docs/developerportal/deploy/general/_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@ The subjects covered in the *General* section are as follows:
1919
* [Licensing Apps](/developerportal/deploy/licensing-apps-outside-mxcloud/)
2020
* [Secure Outgoing Connections from your Application](/developerportal/deploy/securing-outgoing-connections-from-your-application/)
2121
* [Two-Factor Authentication](/developerportal/deploy/two-factor-authentication/)
22-
* [Version Downgrade Prevented](/developerportal/deploy/version-downgrade-prevention/)
22+
* [Version Downgrade Protection](/developerportal/deploy/version-downgrade-prevention/)
2323
* [Iframes and Running Apps](/developerportal/deploy/running-in-iframe/)
24+
* [Deployment Location](/developerportal/deploy/deployment-location/)
25+
* [Webhooks](/developerportal/deploy/webhooks/)
2426

2527
## 2 Building Your Model
2628

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Webhooks"
33
linktitle: "Webhooks"
44
url: /developerportal/deploy/webhooks/
55
weight: 75
6-
description: "Creating a webhook to trigger actions from Mendix Cloud"
7-
tags: ["Mendix Cloud", "Webhooks", "CI/CD", "Pipeline"]
6+
description: "Creating a webhook to trigger actions from Mendix Cloud and Mendix for Private Cloud."
7+
tags: ["Mendix Cloud", "Mendix for Private Cloud", "Webhooks", "CI/CD", "Pipeline"]
88
---
99

1010
## 1 Introduction
@@ -21,8 +21,6 @@ The webhooks contain a retry mechanism if an error response is received from the
2121

2222
{{% alert color="info" %}}
2323
Webhooks are only available for licensed Mendix apps that are deployed to Mendix Cloud or Mendix for Private Cloud.
24-
25-
They are set up and work independently of the deprecated [webhooks for Sprints and Stories](/developerportal/collaborate/general-settings/#webhooks).
2624
{{% /alert %}}
2725

2826
## 2 Configuring a Webhook{#setting-up}
@@ -58,7 +56,7 @@ If you select **Edit Webhook** from **More Options** ({{% icon name="three-dots-
5856

5957
## 3 Webhook Headers
6058

61-
Every `POST`` payload contains the following delivery information as part of the header:
59+
Every `POST` payload contains the following delivery information as part of the header:
6260

6361
* **connection**`close`, indicating that there is no further information for the HTTP request
6462
* **content-length** – the size of the HTTP request in bytes (for example, `475`)

content/en/docs/developerportal/general/settings/_index.md

Lines changed: 4 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ aliases:
1717

1818
The **Settings** page presents an overview of your app.
1919

20-
On the top of page, you can see the image of the app, the app name, and the company that owns the app. You can also find the **Watch** / **Stop Watching** toggle which enables or disables notifications for this app.
20+
On the top of the page, you can see the image of the app, the app name, and the company that owns the app. You can also find the **Watch** / **Stop Watching** toggle, which enables or disables notifications for this app.
2121

2222
{{< figure src="/attachments/developerportal/general/settings/general-information.png" >}}
2323

@@ -153,43 +153,7 @@ If you manage your projects in Jira, you can connect your apps in the Developer
153153

154154
{{< figure src="/attachments/developerportal/general/settings/story-switcher.png" width="700" >}}
155155

156-
## 7 Webhooks {#webhooks}
157-
158-
{{% alert color="warning" %}}
159-
This tab is for webhooks for stories and Sprints, and it is deprecated. This tab will be removed and these webhooks will be discontinued later in 2023. It is no longer possible to add new webhook configurations for stories and Sprints to your apps, but existing configurations will remain active and can still be edited.
160-
{{% /alert %}}
161-
162-
{{% alert color="info" %}}
163-
You can also set webhooks for your app to trigger endpoints when changes are made to deployment packages or models held in the Git Team Server. For details, see [Webhooks](/developerportal/deploy/webhooks/).
164-
{{% /alert %}}
165-
166-
{{% alert color="info" %}}
167-
This tab is only visible if you already have webhooks for stories and Sprints created, you are a **Scrum Master**, and you have **Mendix Stories** turned on in the [Project Management](#project-management) tab.
168-
{{% /alert %}}
169-
170-
Open the **Webhooks** tab to manage your app's webhooks for stories and Sprints. A webhook enables the Developer Portal to talk to another website and post updated Developer Portal content (for example, Sprint updates and new stories) to that website. For example, if you want to follow the changes in your app, you can create a service with a certain [URL](#url) that keeps track of the data, and then changes in the app in the Developer Portal are sent to that URL.
171-
172-
{{< figure src="/attachments/developerportal/general/settings/webhooks-list.png" width="800" >}}
173-
174-
After clicking **New Webhook** to create a new webhook for stories and sprints, fill in the following details:
175-
176-
* **Name** – the name of the webhook for stories and Sprints
177-
* <a id="url"></a>**URL** – the URL to which the webhook for stories and Sprints will connect
178-
* **Secret** – the secret used by the Developer Portal to sign the data payload in order to identify the source of the data to the receiving URL (this appears when creating and editing a webhook for stories and Sprints, but it will not be displayed on the **Webhooks settings** page)
179-
* **Version** – the version of the webhooks feature to be used
180-
* **Events** – what types of data will be sent via the webhook for stories and Sprints (you must select at least one; this appears when creating and editing a webhook for stories and Sprints, but it will not be displayed on the **Webhooks settings** page)
181-
* **Sprints**
182-
* **Stories**
183-
184-
To edit the above details for an existing webhook for stories and Sprints, click **Edit**.
185-
186-
To delete an existing webhook for stories and Sprints, click **Delete**.
187-
188-
{{% alert color="info" %}}
189-
For details on the technical configuration of webhooks for stories and sprints, see [Webhooks for Stories and Sprints](/apidocs-mxsdk/apidocs/webhooks-sprints/) in the *API Documentation*.
190-
{{% /alert %}}
191-
192-
## 8 History {#history}
156+
## 7 History {#history}
193157

194158
{{% alert color="info" %}}
195159
Only users with the **App Settings** permission can view the history.
@@ -201,7 +165,7 @@ The **History** tab presents the collaboration actions for the app. On this page
201165

202166
When you select a history item and click **Show item**, the details of the story, Sprint, or [feedback item](/developerportal/app-insights/feedback/) will be presented.
203167

204-
## 9 Story Archive {#story-archive}
168+
## 8 Story Archive {#story-archive}
205169

206170
Once you have switched from Mendix Stories to Epics or Jira, Mendix archives any work you may have had in Mendix Stories. You can review your work on this tab, and download it if necessary.
207171

@@ -211,7 +175,7 @@ Mendix will keep this data until October 1, 2024. Until then, you will be able t
211175

212176
{{< figure src="/attachments/developerportal/general/settings/story-archive.png" width="700" >}}
213177

214-
## 10 Read More
178+
## 9 Read More
215179

216180
* [Leave and Delete an App](/developerportal/general/leave-delete-app/)
217181
* [Manage Deep Links](/developerportal/general/manage-deeplinks/)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@ We have made the following improvements to the **Access Management** page in Por
462462

463463
#### Deprecations
464464

465-
* 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/).
465+
* We have deprecated **General Settings** > **Webhooks** for stories and Sprints. You can now set webhooks for building and deploying your app. These are described in [Webhooks](/developerportal/deploy/webhooks/).
466466

467467
### March 9, 2023
468468

0 commit comments

Comments
 (0)