> 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/boomi.md).

# Boomi

Connect to the Boomi Enterprise Platform API to run integration processes, check run history and status, monitor Runtimes, and deploy packaged components between environments.

### Connectors

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

| Connector | Authentication |
| --------- | -------------- |
| Boomi     | API Token      |

#### Boomi

Connect to the Boomi Enterprise Platform API to run integration processes, check run history and status, monitor Runtimes, and deploy packaged components between environments.

**Set up in Boomi**

1. Prepare the Boomi account or service that the workflow will access. Grant access to the required resources and operations.
2. **Account ID:** Your Boomi account ID, e.g. 'boomi\_user-123AZU'. Find it under Settings > Account, on the Account Information tab.
3. **API Token:** Create a Boomi Enterprise Platform API token for this user. The setup path differs by Boomi doc page: try Settings > Account Information and Setup > Boomi Enterprise Platform API Tokens, or Settings > User Information > Platform API Tokens. The token requires the API Access privilege and is shown once at creation.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Boomi**.
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        | Optional / as applicable | Enter US for a US account or GB for an EU/GB account.                                                                                                                                                                                                                                                                                                                                                                                                            |
| Account ID    | Yes                      | Your Boomi account ID, e.g. 'boomi\_user-123AZU'. Find it under Settings > Account, on the Account Information tab.                                                                                                                                                                                                                                                                                                                                              |
| Email         | Yes                      | The email address of the Boomi user that owns the API token below.                                                                                                                                                                                                                                                                                                                                                                                               |
| API Token     | Yes                      | Create a Boomi Enterprise Platform API token for this user. The setup path differs by Boomi doc page: try Settings > Account Information and Setup > Boomi Enterprise Platform API Tokens, or Settings > User Information > Platform API Tokens. The token requires the API Access privilege and is shown once at creation. [Provider instructions](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Platform_API_and_Partner_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 **Boomi** 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

#### Execute Process

Start a Boomi integration process on a specific Runtime and get back a request ID for this submission.

**Inputs**

| Field                | Type            | Required | Description                                                                                                                                              |
| -------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Process              | select (string) | Yes      | The integration process to run. Pick it from the list of processes in your Boomi account. Options load from the selected connection.                     |
| Runtime              | select (string) | Yes      | The Runtime (Atom, Molecule, or Cloud) that should execute the process. Offline Runtimes cannot run anything. Options load from the selected connection. |
| Show advanced fields | boolean         | No       | Reveal optional process properties to pass into the run. Default: false.                                                                                 |
| Process properties   | textarea        | No       | Optional dynamic values to pass into the process, one per line as name=value. Any other non-blank line is rejected before the run starts.                |

**Outputs**

| Field      | Type   | Description                                                                                     |
| ---------- | ------ | ----------------------------------------------------------------------------------------------- |
| Request ID | string | Boomi's identifier for this run request. Pass it to Query Execution Records to follow this run. |
| Record URL | string | Authenticated Boomi API URL for this run's record.                                              |
| Process ID | string | The process that was started.                                                                   |
| Runtime ID | string | The Runtime the process was submitted to.                                                       |

#### Query Execution Records

Look up recent process runs and see whether they succeeded, how many documents they moved, and any error message.

**Inputs**

| Field                 | Type            | Required | Description                                                                                                                                                                        |
| --------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| From                  | datetime        | No       | Only return runs that started at or after this time. Defaults to 7 days ago.                                                                                                       |
| To                    | datetime        | No       | Only return runs that started at or before this time. Defaults to now.                                                                                                             |
| Process               | select (string) | No       | Limit results to a single process. Leave empty for all processes. Options load from the selected connection.                                                                       |
| Runtime               | select (string) | No       | Limit results to runs executed on one Runtime. Leave empty for all Runtimes. Options load from the selected connection.                                                            |
| Status                | select (string) | No       | Show only runs in this state, for example only failures. Available values: ABORTED, ABORTED\_RECOVERING, COMPLETE, COMPLETE\_WARN, DISCARDED, ENQUEUED, ERROR, INPROCESS, STARTED. |
| Show advanced filters | boolean         | No       | Show the request ID and execution ID lookups and the continuation cursor. Default: false.                                                                                          |
| Request ID            | string          | No       | Follow one run started by Execute Process, using the request ID it returned.                                                                                                       |
| Execution ID          | string          | No       | Look up one specific run by its execution ID.                                                                                                                                      |
| Maximum results       | integer         | No       | How many runs to return at most. Minimum: 1. Default: 100.                                                                                                                         |
| Cursor                | string          | No       | Continue from where a previous run of this action stopped.                                                                                                                         |

**Outputs**

| Field             | Type          | Description                                                                       |
| ----------------- | ------------- | --------------------------------------------------------------------------------- |
| Execution records | object\_array | The matching process runs.                                                        |
| Next cursor       | string        | Token for fetching the next page, empty when there are no more results.           |
| Returned count    | integer       | How many runs were returned by this call.                                         |
| Pending           | boolean       | True when a request ID was given and Boomi has not created that run's record yet. |

#### Get Execution Count

Report how many process runs succeeded and failed per day, for capacity and licence usage tracking.

**Inputs**

| Field                | Type            | Required | Description                                                                                                                       |
| -------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| From date            | date            | No       | First day to include. Defaults to 30 days ago.                                                                                    |
| To date              | date            | No       | Last day to include. Defaults to today.                                                                                           |
| Runtime              | select (string) | No       | Limit counts to one Runtime. Leave empty to count across all Runtimes. Options load from the selected connection.                 |
| Environment          | select (string) | No       | Limit counts to one environment, such as Production. Leave empty for all environments. Options load from the selected connection. |
| Maximum rows         | integer         | No       | How many daily rows to return at most. Minimum: 1. Default: 100.                                                                  |
| Show advanced fields | boolean         | No       | Reveal the continuation cursor field. Default: false.                                                                             |
| Cursor               | string          | No       | Continue from where a previous run of this action stopped.                                                                        |

**Outputs**

| Field              | Type          | Description                                                             |
| ------------------ | ------------- | ----------------------------------------------------------------------- |
| Daily counts       | object\_array | One row per day per Runtime, with successes and failures.               |
| Total successes    | integer       | Successful runs summed across every row returned.                       |
| Total failures     | integer       | Failed runs summed across every row returned.                           |
| Totals are partial | boolean       | True when more count rows remain beyond this call's limit.              |
| Next cursor        | string        | Token for fetching the next page, empty when there are no more results. |

#### List Atoms (Runtimes)

See every Boomi Runtime in the account and whether it is online, so you can spot a dead one or pick a target to run a process on.

**Inputs**

| Field                 | Type            | Required | Description                                                                                                           |
| --------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
| Status                | select (string) | No       | Show only Runtimes in this state, for example only offline ones. Available values: ONLINE, OFFLINE, WARNING, UNKNOWN. |
| Show advanced filters | boolean         | No       | Show the Runtime type filter and continuation cursor. Default: false.                                                 |
| Type                  | select (string) | No       | Show only one kind of Runtime. Available values: ATOM, MOLECULE, CLOUD.                                               |
| Name contains         | string          | No       | Only show Runtimes whose name matches this text.                                                                      |
| Maximum results       | integer         | No       | How many Runtimes to return at most. Minimum: 1. Default: 100.                                                        |
| Cursor                | string          | No       | Continue from where a previous run of this action stopped.                                                            |

**Outputs**

| Field          | Type          | Description                                                             |
| -------------- | ------------- | ----------------------------------------------------------------------- |
| Runtimes       | object\_array | The matching Runtimes.                                                  |
| Next cursor    | string        | Token for fetching the next page, empty when there are no more results. |
| Returned count | integer       | How many Runtimes were returned by this call.                           |

#### List Processes

Find Boomi processes and their ids before running one.

**Inputs**

| Field                | Type    | Required | Description                                                     |
| -------------------- | ------- | -------- | --------------------------------------------------------------- |
| Name contains        | string  | No       | Only show processes whose name contains this text.              |
| Maximum results      | integer | No       | How many processes to return at most. Minimum: 1. Default: 100. |
| Show advanced fields | boolean | No       | Reveal the continuation cursor. Default: false.                 |
| Cursor               | string  | No       | Continue from a previous result.                                |

**Outputs**

| Field          | Type          | Description                                |
| -------------- | ------------- | ------------------------------------------ |
| Processes      | object\_array | The matching processes.                    |
| Next cursor    | string        | Token for the next page, if one remains.   |
| Returned count | integer       | Number of processes returned by this call. |

#### List Environments

Find Boomi environments such as Test and Production.

**Inputs**

| Field                | Type    | Required | Description                                                        |
| -------------------- | ------- | -------- | ------------------------------------------------------------------ |
| Name contains        | string  | No       | Only show environments whose name contains this text.              |
| Maximum results      | integer | No       | How many environments to return at most. Minimum: 1. Default: 100. |
| Show advanced fields | boolean | No       | Reveal the continuation cursor. Default: false.                    |
| Cursor               | string  | No       | Continue from a previous result.                                   |

**Outputs**

| Field          | Type          | Description                                   |
| -------------- | ------------- | --------------------------------------------- |
| Environments   | object\_array | The matching environments.                    |
| Next cursor    | string        | Token for the next page, if one remains.      |
| Returned count | integer       | Number of environments returned by this call. |

#### Deploy Process Package

Promote a packaged process into a Boomi environment, for example moving a tested integration into Production.

**Inputs**

| Field            | Type            | Required | Description                                                                                                                                            |
| ---------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Environment      | select (string) | Yes      | The environment to deploy into, such as Production or Test. Options load from the selected connection.                                                 |
| Process          | select (string) | No       | The process you want to deploy. Pick it by name, then choose which packaged version below. Options load from the selected connection.                  |
| Packaged version | select (string) | Yes      | Which packaged version of that process to deploy. Options load from the selected connection.                                                           |
| Listener state   | select (string) | No       | Leave unset to keep a redeployed listener's current state. New listeners start Running; choose Paused to stage one. Available values: RUNNING, PAUSED. |
| Notes            | string          | No       | An optional note recorded with the deployment, such as a change ticket reference.                                                                      |

**Outputs**

| Field              | Type     | Description                                               |
| ------------------ | -------- | --------------------------------------------------------- |
| Deployment ID      | string   | Boomi's identifier for this deployment.                   |
| Package ID         | string   | The packaged component that was deployed.                 |
| Environment ID     | string   | The environment it was deployed into.                     |
| Active             | boolean  | Whether the deployment is currently the active one.       |
| Deployed at        | datetime | When the deployment happened.                             |
| Deployment warning | string   | Boomi's message about this successful deployment, if any. |

### 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/boomi.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.
