Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions content/en/docs/deployment/general/mendix-pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,41 @@ Check out a branch. To configure this step, use the drop-down menu to select the

Build a deployment package based on the latest major, minor, or patch version of the branch you checked out. The highest version is incremented based on the increment settings specified in this step.

##### GET Request

Use the **GET request** step to retrieve data from an external API and use the response to inform or control the next steps in the pipeline.

The **GET request** step has the following configuration fields:

| Field | Required? | Description |
| --- | :---: | --- |
| **Request URL** | Yes | Base endpoint to call (for example, `https://api.com/1/app`). |
| **Additional URL path** | No | Path appended to the Request URL (for example, `$GET Request.Result1 or 123` ). |
| **Header 1–5 Key / Value** | No | Up to five request headers. You can reference pipeline variables in header values (for example, set `Authorization` to `$API_Key`). |
| **Success Condition (in jQuery)** | No | Defines success of the API output. Set a jq expression that must evaluate to `true` (for example, `.Result == "Success"`). If empty, the step passes by default. |
| **Failure Condition (in jQuery)** | No | Defines failure of the API output. If empty, the step passes if the success condition is met; otherwise the step keeps polling until maximum wait time is reached. |
| **Result 1–3 (parsing logic to extract output in jQuery)** | No | jq expressions to extract values from the response and store them as step outputs (for example, `.JobId`). |
| **Initial Delay (seconds)** | Yes | Delay before the first call. Range must be between 0 and 10800. |
| **Polling Interval (seconds)** | Yes | Time between retries. Range must be between 5 and 300. |
| **Maximum Wait Time (seconds)** | Yes | Total time to wait before timing out. Range must be between 0 and 10800. |

{{% alert color="info" %}}
To learn more about jq, refer to the [jQuery manual](https://jqlang.org/manual).
{{% /alert %}}

##### POST Request

Use the **POST request** step to send structured data to an external API to trigger an action or update a system. The POST request step has the following configuration fields:

| Field | Required? | Description |
| --- | :---: | --- |
| **Request URL** | Yes | Base endpoint to call (for example, `https://api.com/1/apps`). |
| **Additional URL path** | No | Path appended to the Request URL (for example, `$POST Request.Result1 or 123`). |
| **Header 1–5 Key / Value** | No | Up to five request headers. You can reference pipeline variables in header values (for example, `x-api-key: $API_Key`). |
| **Request body (JSON)** | No | JSON payload to send. Default: `{}`. |
| **Success condition (in jQuery)** | No | Defines success of the API output. Set a jq expression that must evaluate to `true` (for example, `.Result == "Success"`). If empty, the step passes by default. |
| **Result 1–3 (parsing logic to extract output in jQuery)** | No | jq expressions to extract values from the response and store them as step outputs (for example, `.JobId`). |

##### Maia Best Practice Recommender{##recommender}

Evaluate the results of the [Maia Best Practice Recommender](/refguide/best-practice-recommender/) within your Mendix Pipeline. You can configure this step to fail the Mendix Pipeline if errors, warnings, deprecations, and/or recommendations are detected.
Expand Down
6 changes: 6 additions & 0 deletions content/en/docs/releasenotes/deployment/mendix-pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ To see the current status of the Mendix Pipelines, see [Mendix Status](https://s

## 2026

### March 12, 2026

#### New Features

* We have added two new steps, [GET request](/developerportal/deploy/mendix-pipelines/#get-request) and [POST request](/developerportal/deploy/mendix-pipelines/#post-request), to Mendix Pipelines. These new steps allow Mendix Pipelines to retrieve and send structured data to external APIs.

### February 26, 2026

#### New Features
Expand Down