Skip to content

Commit e1b2478

Browse files
committed
Rename Webhooks and Deployment Webhooks
1 parent 21c71c2 commit e1b2478

7 files changed

Lines changed: 23 additions & 22 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/build-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The Build API only works for apps which are deployed to the Mendix Cloud.
1515

1616
The Build API allows you to manage deployment packages and create new deployment packages using our build server. You will need the information from the [Teamserver API](/apidocs-mxsdk/apidocs/team-server-api/) as input for these API calls. You will also need to provide authentication for each call; this is described in [Authentication](/apidocs-mxsdk/apidocs/authentication/).
1717

18-
You can use deployment webhooks to trigger CI/CD pipelines which use this API. These are described in [Mendix Deployment Webhooks](/developerportal/deploy/webhooks/).
18+
You can use webhooks to trigger CI/CD pipelines which use this API. These are described in [Webhooks](/developerportal/deploy/webhooks/).
1919

2020
The image below provides a domain model representation of the concepts discussed below and how these are related:
2121

content/en/docs/apidocs-mxsdk/apidocs/deploy-api/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Deploy API only works for apps which are deployed to the Mendix Cloud.
1616

1717
The Deploy API allows you to manage application environments in the Mendix Cloud. You can retrieve the status of, and start and stop, applications. You can also configure new model versions and deploy them to application environments. To create and manage deployment packages you also need the [Build API](/apidocs-mxsdk/apidocs/build-api/). For backup-related actions refer to [Backups API](/apidocs-mxsdk/apidocs/backups-api/).
1818

19-
You can use deployment webhooks to trigger CI/CD pipelines which use this API. These are described in [Mendix Deployment Webhooks](/developerportal/deploy/webhooks/).
19+
You can use webhooks to trigger CI/CD pipelines which use this API. These are described in [Webhooks](/developerportal/deploy/webhooks/).
2020

2121
This image provides a domain model representation of the concepts discussed below and how these are related:
2222

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: "Webhooks"
2+
title: "Webhooks for Stories and Sprints"
3+
linktitle: "Webhooks for Stories/Sprints"
34
url: /apidocs-mxsdk/apidocs/webhooks-sprints/
45
category: "API Documentation"
56
weight: 75
@@ -12,7 +13,7 @@ The webhook payloads described in this document are for app Sprints and stories.
1213
{{% /alert %}}
1314

1415
{{% alert color="info" %}}
15-
You can now set deployment webhooks for your app. These are described in [Mendix Deployment Webhooks](/developerportal/deploy/webhooks/).
16+
You can now set deployment webhooks for your app. These are described in [Webhooks](/developerportal/deploy/webhooks/).
1617
{{% /alert %}}
1718

1819
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.

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -153,37 +153,37 @@ It is possible to migrate all or part of your content from [Stories](/developerp
153153
## 7 Webhooks {#webhooks}
154154

155155
{{% alert color="warning" %}}
156-
This tab is for webhooks for app Sprints and stories, 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 app Sprints and stories to your apps, but existing configurations will remain active and can still be edited.
156+
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.
157157
{{% /alert %}}
158158

159159
{{% alert color="info" %}}
160-
You can now set deployment webhooks for your app. For details, see [Mendix Deployment Webhooks](/developerportal/deploy/webhooks/).
160+
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/).
161161
{{% /alert %}}
162162

163163
{{% alert color="info" %}}
164-
This tab is only visible if you already have webhooks created, you are a **Scrum Master**, and you have **Mendix Stories** turned on in the [Project Management](#project-management) tab.
164+
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.
165165
{{% /alert %}}
166166

167-
Open the **Webhooks** tab to manage your app's webhooks. 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.
167+
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.
168168

169169
{{< figure src="/attachments/developerportal/collaborate/general-settings/webhooks-list.png" width="800" >}}
170170

171-
After clicking **New Webhook** to create a new webhook, fill in the following details:
171+
After clicking **New Webhook** to create a new webhook for stories and sprints, fill in the following details:
172172

173-
* **Name** – the name of the webhook
174-
* <a id="url"></a>**URL** – the URL to which the webhook will connect
175-
* **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, but it will not be displayed on the **Webhooks settings** page)
173+
* **Name** – the name of the webhook for stories and Sprints
174+
* <a id="url"></a>**URL** – the URL to which the webhook for stories and Sprints will connect
175+
* **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)
176176
* **Version** – the version of the webhooks feature to be used
177-
* **Events** – what types of data will be sent via the webhook (you must select at least one; this appears when creating and editing a webhook, but it will not be displayed on the **Webhooks settings** page)
177+
* **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)
178178
* [Sprints](/developerportal/collaborate/stories/#story-actions)
179179
* [Stories](/developerportal/collaborate/stories/)
180180

181-
To edit the above details for an existing webhook, click **Edit**.
181+
To edit the above details for an existing webhook for stories and Sprints, click **Edit**.
182182

183-
To delete an existing webhook, click **Delete**.
183+
To delete an existing webhook for stories and Sprints, click **Delete**.
184184

185185
{{% alert color="info" %}}
186-
For details on the technical configuration of webhooks, see [Webhooks](/apidocs-mxsdk/apidocs/webhooks-sprints/) in the *API Documentation*.
186+
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*.
187187
{{% /alert %}}
188188

189189
## 8 History {#history}

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Mendix Deployment Webhooks"
3-
linktitle: "Deployment Webhooks"
2+
title: "Webhooks"
3+
linktitle: "Webhooks"
44
url: /developerportal/deploy/webhooks/
55
weight: 75
66
description: "Creating a Webhook to trigger actions from the Mendix cloud"
@@ -13,7 +13,7 @@ This feature is in Beta. For more information on Beta products, see [Beta Releas
1313

1414
## 1 Introduction
1515

16-
Mendix deployment webhooks allow you to send information about your licensed Mendix app deployed to the Mendix Cloud to an external app or workflow. This can be used, for example, to trigger an automated CI/CD workflow when a new change is committed to the Team Server.
16+
Webhooks allow you to send information about your licensed Mendix app deployed to the Mendix Cloud to an external app or workflow. This can be used, for example, to trigger an automated CI/CD workflow when a new change is committed to the Team Server.
1717

1818
Mendix provides webhooks to send project information when the following events happen to your app:
1919

@@ -23,7 +23,7 @@ Mendix provides webhooks to send project information when the following events h
2323
The webhooks contain a retry mechanism if an error response is received from the endpoint to ensure that the trigger reaches the endpoint.
2424

2525
{{% alert color="info" %}}
26-
Mendix deployment webhooks are only available for licensed Mendix apps which are deployed to the Mendix Cloud.
26+
Webhooks are only available for licensed Mendix apps which are deployed to the Mendix Cloud.
2727

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

content/en/docs/releasenotes/deployment/mendix-cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For information on the current status of deployment to Mendix Cloud and any plan
2121

2222
#### Improvements
2323

24-
* We have added webhooks which can trigger endpoints when changes are committed to a Team Server Git repository, or a new deployment package is available for deployment to the Mendix Cloud. See [Mendix Deployment Webhooks](/developerportal/deploy/webhooks/) for more information.
24+
* We have added webhooks which can trigger endpoints when changes are committed to a Team Server Git repository, or a new deployment package is available for deployment to the Mendix Cloud. See [Webhooks](/developerportal/deploy/webhooks/) for more information.
2525

2626
{{% alert color="info" %}}This feature is currently in a [Beta Release](/releasenotes/beta-features/).{{% /alert %}}
2727

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

Lines changed: 1 addition & 1 deletion
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 deployment webhooks for your app. These are described in [Mendix Deployment Webhooks](/developerportal/deploy/webhooks/).
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/).
3030

3131
### March 9th, 2023
3232

0 commit comments

Comments
 (0)