> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/matillion.md).

# Matillion

Connect to Matillion Data Productivity Cloud to orchestrate data pipelines from your AI workflows: list projects and published pipelines, start a pipeline run, poll its status, and cancel a run that is stuck.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Matillion | Credentials    |

#### Matillion

Connect to Matillion Data Productivity Cloud with an API credential to run published pipelines and track their executions. Create the credential in Matillion under Profile and Account, then API credentials. A credential that is not an account admin also needs Viewer on the project and Operator on the environment, which is enough for everything here because the API can only run published pipelines.

**Set up in Matillion**

1. Prepare the Matillion account or service that the workflow will access. Grant access to the required resources and operations.
2. **Client ID:** The Client ID of a Matillion API credential, created in Matillion under Profile and Account, then API credentials. Only users with the Manage API Credentials permission can create one.
3. **Client Secret:** The Client Secret shown when the API credential was created. Matillion shows it once and never again, so a lost secret means creating a new credential. If the credential's Account Role is not an account admin, it also needs Viewer on the project and Operator on the environment you want to use.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Matillion**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                                                                                                                                                                                    |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Region        | Yes      | The region your Matillion account is hosted in: 'eu1' (Europe), 'us1' (United States) or 'au1' (Australia). Matillion requires the account and the endpoint to be in the same region, and a mismatch shows up as a permission error rather than a routing error, so pick carefully.                                                                                                              |
| Client ID     | Yes      | The Client ID of a Matillion API credential, created in Matillion under Profile and Account, then API credentials. Only users with the Manage API Credentials permission can create one. [Provider instructions](https://docs.maia.ai/docs/api-reference/maia-api-authentication).                                                                                                               |
| Client Secret | Yes      | The Client Secret shown when the API credential was created. Matillion shows it once and never again, so a lost secret means creating a new credential. If the credential's Account Role is not an account admin, it also needs Viewer on the project and Operator on the environment you want to use. [Provider instructions](https://docs.maia.ai/docs/api-reference/maia-api-authentication). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Matillion** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Projects

List the Matillion projects this connection can see.

**Required permissions:** `pipeline-execution`.

**Inputs**

| Field       | Type    | Required | Description                                                                  |
| ----------- | ------- | -------- | ---------------------------------------------------------------------------- |
| Max results | integer | No       | Maximum number of projects to return. Minimum: 1. Maximum: 200. Default: 25. |
| Start page  | integer | No       | Continue a previous listing from where it stopped. Minimum: 0.               |

**Outputs**

| Field          | Type          | Description                                     |
| -------------- | ------------- | ----------------------------------------------- |
| Projects       | object\_array | The projects found.                             |
| Next page      | number        | Pass back as Start page to fetch more projects. |
| Total projects | number        | How many projects exist in total.               |

#### List Pipelines

List the published pipelines available in a project, for one environment or across the project's environments.

**Required permissions:** `pipeline-execution`.

**Inputs**

| Field       | Type            | Required | Description                                                                                                                                 |
| ----------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| Project     | select (string) | Yes      | The Matillion project to list pipelines from. Options load from the selected connection.                                                    |
| Environment | select (string) | No       | The environment to list pipelines for. Leave empty to cover the project's first 10 environments. Options load from the selected connection. |
| Max results | integer         | No       | Maximum number of pipelines to return. Minimum: 1. Maximum: 200. Default: 25.                                                               |
| Start page  | integer         | No       | Continue a previous listing from where it stopped. Minimum: 0.                                                                              |

**Outputs**

| Field                     | Type          | Description                                                                                                   |
| ------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------- |
| Pipelines                 | object\_array | The published pipelines found.                                                                                |
| Environments              | object\_array | The project's environments, when no environment was given.                                                    |
| Next page                 | number        | Pass back as Start page to fetch more pipelines.                                                              |
| Environments fully listed | string\_array | The environments whose published pipelines were all listed.                                                   |
| Truncated                 | boolean       | Whether more pipelines or environments exist than were listed, including environments that could not be read. |
| Total pipelines           | number        | How many published pipelines exist in total.                                                                  |

#### Run Pipeline

Start a published Matillion pipeline on demand.

**Required permissions:** `pipeline-execution`.

**Inputs**

| Field            | Type            | Required | Description                                                                                                           |
| ---------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
| Project          | select (string) | Yes      | The Matillion project that owns the pipeline. Options load from the selected connection.                              |
| Environment      | select (string) | Yes      | The environment to run the pipeline in. Options load from the selected connection.                                    |
| Pipeline         | select (string) | Yes      | The published pipeline to run. Renaming it in Matillion breaks this field. Options load from the selected connection. |
| Version          | select (string) | No       | Run a specific published version instead of the latest. Options load from the selected connection.                    |
| Execution tag    | string          | No       | Prevent two runs sharing this tag from overlapping in the same environment.                                           |
| Agent            | select (string) | No       | Run on a specific Matillion agent instead of the environment default. Options load from the selected connection.      |
| Scalar variables | object          | No       | Override the pipeline's scalar variables for this run only.                                                           |
| Grid variables   | object          | No       | Override the pipeline's grid variables for this run only.                                                             |

**Outputs**

| Field                 | Type   | Description                         |
| --------------------- | ------ | ----------------------------------- |
| Pipeline execution ID | string | The id of the run that was started. |

#### Get Pipeline Execution Status

Check whether a Matillion pipeline run finished, and whether it succeeded.

**Required permissions:** `pipeline-execution`.

**Inputs**

| Field                 | Type            | Required | Description                                                                |
| --------------------- | --------------- | -------- | -------------------------------------------------------------------------- |
| Project               | select (string) | Yes      | The project the run belongs to. Options load from the selected connection. |
| Pipeline execution ID | string          | Yes      | The run to check, as returned when the pipeline was started.               |

**Outputs**

| Field                 | Type    | Description                                                  |
| --------------------- | ------- | ------------------------------------------------------------ |
| Status                | string  | The run status reported by Matillion.                        |
| Finished              | boolean | True once the run is no longer in progress.                  |
| Succeeded             | boolean | True only when the run completed successfully.               |
| Pipeline execution ID | string  | The run this status describes.                               |
| Message               | string  | Matillion's message for the run, usually the failure reason. |
| Pipeline              | string  | Which pipeline this run executed.                            |
| Environment           | string  | Which environment this run used.                             |
| Pipeline type         | string  | The kind of pipeline that ran.                               |
| Started at            | string  | When the run started.                                        |
| Finished at           | string  | When the run finished, if it has.                            |
| Triggered by          | string  | What started the run.                                        |
| Schedule ID           | string  | The schedule that started the run, if any.                   |
| Started by            | string  | The Matillion user who started the run, when a person did.   |

#### Cancel Pipeline Execution

Cancel a Matillion pipeline run that is stuck or was started by mistake.

**Required permissions:** `pipeline-execution`.

**Inputs**

| Field                 | Type            | Required | Description                                                                                    |
| --------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------- |
| Project               | select (string) | Yes      | The project the run belongs to. Options load from the selected connection.                     |
| Pipeline execution ID | string          | Yes      | The run to stop. Stopping a run cannot be undone.                                              |
| Force termination     | boolean         | No       | Hard-cancel the run immediately. Turn off to request Matillion's normal cancel. Default: true. |

**Outputs**

| Field                 | Type    | Description                                               |
| --------------------- | ------- | --------------------------------------------------------- |
| Pipeline execution ID | string  | The run that was asked to stop.                           |
| Termination requested | boolean | True when Matillion accepted the request to stop the run. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/matillion.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
