> ## Documentation Index
> Fetch the complete documentation index at: https://www.voiceflow.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Boomi integration

> Connect Voiceflow to Boomi to call a deployed integration process and use its returned delivery information in a customer conversation.

## Overview

Voiceflow integrates with Boomi so your AI agent can call a deployed integration process and use its returned delivery information in a customer conversation. Boomi runs the external workflow; Voiceflow calls its approved endpoint and uses the response in the conversation.

### Examples of when to use Boomi

- **[Connect the business service](#connecting-boomi)** — prepare its authorization, schema and test resources.
- **[Return a delivery update](#run-request)** — invoke the configured service and interpret its current result.
- **[Recover a failed request](#maintaining-the-connection)** — inspect execution and downstream state before retrying.

#### Studio

Use an editable test project in [Agent studio](https://creator.voiceflow.com). Your integration developer or administrator prepares the service below, supplies its endpoint and credentials, and gives you a verified test request plus its expected result. Keep provider-side deployment with that owner.

#### Developer

Use a [Voiceflow personal or service key](/docs/api-reference/authentication) with project access, a current [Voiceflow CLI](/docs/cli/install) and the selected test [Environment](/docs/documentation/deploy/environments/overview). You prepare the provider service and create, execute and attach the Voiceflow request separately. The examples use a test project; they can read or change connected systems.

<a id="connecting-boomi"></a>

## Connecting Boomi

Prepare a deployed endpoint and the credentials for its approved operation.

### Prepare the provider service

#### Studio

Ask your Boomi administrator or integration developer to complete the service setup linked below. Obtain all four handoff items before creating the Voiceflow tool:

- The deployed HTTPS endpoint and its exact authentication headers.
- The credential value for the Voiceflow Secret.
- A request schema, response schema and verified test customer/resource.
- A successful test response and a rejected unauthorized request, confirmed in the provider's execution history.

The sample request fields on this page are a recipe contract for your existing workflow. Have the owner map them to that workflow; a provider account alone does not create this endpoint.

#### Developer

### 1. Prepare the listening process

Ask your Boomi integration developer to expose your existing delivery lookup process with a **Web Services Server** connector using **Listen**. This connector requires the applicable Boomi edition. For this recipe, choose **Operation Type: Query** and **Object: Delivery**. Set both **Input Type** and **Output Type** to **Single JSON Object**, select the corresponding JSON profiles, and define request strings `customer_id` and `order_id`. Copy the generated **Simple URL Path**, ending in `/ws/simple/queryDelivery` for this example. The process must verify that the customer may access the order before retrieving delivery details.

### 2. Return one useful JSON document

Map the lookup into one JSON document containing `order_id`, `status` and `estimated_delivery`. End that process path with **Return Documents**, matching the operation's output profile. A standard 200 from the web server without that document does not supply delivery data. Return an explicit business error when the order is unavailable; do not map an empty document to a successful delivery answer.

### 3. Deploy and authorize the runtime

Deploy the process to the intended runtime and confirm its listener in **Manage → Runtime Management → Listeners**. Obtain the HTTPS base URL from **Shared Web Server**, then append the operation's actual simple HTTP path; the example path below is a recipe choice, not a Boomi-wide endpoint.

For this recipe, the runtime administrator uses **API Type: Basic** and **Authentication Type: Basic** on a dedicated test runtime. The username is the Boomi account ID and the password is the generated authentication token. These are web-service credentials, not your Boomi Platform API credentials. Prepare `Basic ` followed by the Base64 encoding of `ACCOUNT_ID:AUTHENTICATION_TOKEN`. Store the complete header value as `boomi_authorization`. Base64 does not encrypt it; use HTTPS.

### 4. Verify the service handoff

The developer supplies the deployed HTTPS endpoint, full authorization value, input/output profiles and a verified test customer/order pair. Confirm the service returns the matching JSON document and rejects another customer's order. If the existing runtime uses Advanced API Services or another authentication type, obtain its actual endpoint and credential contract instead of changing shared server settings to match this recipe.

Provider setup: [Web Services Server operation](https://help.boomi.com/docs/Atomsphere/Integration/Event-based%20integration/r-atm-Web_Services_Server_operation_e74fceaf-877d-45fa-a7b0-7a5ac72719b4), [Shared Web Server authentication](https://help.boomi.com/docs/Atomsphere/Integration/Event-based%20integration/r-atm-Shared_Web_Server_panel_135fde50-19db-488d-bb5c-b9ef43456e75) and [web-service responses](https://help.boomi.com/docs/Atomsphere/Integration/Event-based%20integration/API%20Management/c-atm-Web_service_responses_47363f5b-c545-45b2-bf15-23a70395b808).

### Create the Voiceflow request

#### Studio

### 1. Store the service credential

Open your test project in [Agent studio](https://creator.voiceflow.com), then **More → Secrets**. Create `boomi_authorization` with the credential supplied by the service owner. Creating its default also writes Main's Published value, so keep initial setup in a test project. If the selected Environment has a different Draft credential, set its Draft override too.

### 2. Create a request variable

Open **More → Variables**, create `boomi_request` with an empty default and ask your application developer to populate it with the [prepared request](#run-request). For a Studio Run test, temporarily set its default to the developer's prepared test string in this isolated test project; backend runtime variables do not automatically populate Studio Run. Clear the default after that test.

### 3. Configure the API request

Open **Agent → Global tools → + → API** and name the tool **Check a delivery request**. Choose **POST**, set the owner-supplied endpoint and add the headers below. Set the raw JSON body to `{payload}`.

| Field | Value |
| --- | --- |
| Name | `Check a delivery request` |
| Method | `POST` |
| URL | `https://YOUR_RUNTIME/ws/simple/queryDelivery` |
| Header: Authorization | `{authorization}` |
| Header: Content-Type | `application/json` |
| Raw JSON body | `{payload}` |

Native Boomi API request editor with configured endpoint, headers and raw request body — Configure the deployed Boomi endpoint and its request fields.

### 4. Bind inputs before running

Open the attached tool's inputs. Open `authorization` and set its **Default value** to the Secret `boomi_authorization`, and set `payload`'s **Default value** to `boomi_request`. Keep **Async execution** off so the agent receives this call's response. The provider workflow may still return a pending receipt.

#### Developer

Set `VF_TOKEN`, `PROJECT_ID` and `ENVIRONMENT` for the test project. Set `PROVIDER_CREDENTIAL` to the complete Boomi Basic header value. The service owner supplies `PROVIDER_URL` and the verified test request.

Save this definition as `boomi-tool.json`, replacing the illustrative URL with `PROVIDER_URL`. Braced names declare inputs on this API tool; they are bound to Secrets/variables on its attachment later.

```json
{
  "name": "Check a delivery request",
  "description": "Run the approved Boomi request for the customer verified by the application.",
  "httpMethod": "post",
  "url": "https://YOUR_RUNTIME/ws/simple/queryDelivery",
  "headers": [
    {
      "key": "Authorization",
      "value": "{authorization}"
    },
    {
      "key": "Content-Type",
      "value": "application/json"
    }
  ],
  "body": {
    "type": "raw-input",
    "contentType": "json",
    "content": "{payload}"
  }
}
```

#### API

```sh
jq -n --arg value "$PROVIDER_CREDENTIAL" \
  '{name:"boomi_authorization",visibility:"restricted",defaultValue:$value}' |
curl --fail-with-body --silent --show-error \
  "https://realtime-api.voiceflow.com/v2/stable/secret?projectID=$PROJECT_ID" \
  -H "Authorization: Bearer $VF_TOKEN" -H 'Content-Type: application/json' --data-binary @-

curl --fail-with-body --silent --show-error \
  "https://realtime-api.voiceflow.com/v2/stable/variable?projectID=$PROJECT_ID&environmentAlias=$ENVIRONMENT" \
  -H "Authorization: Bearer $VF_TOKEN" -H 'Content-Type: application/json' \
  -d '{"name":"boomi_request","color":"#515A63","defaultValue":""}'

curl --fail-with-body --silent --show-error \
  "https://realtime-api.voiceflow.com/v2/stable/api-tool?projectID=$PROJECT_ID&environmentAlias=$ENVIRONMENT" \
  -H "Authorization: Bearer $VF_TOKEN" -H 'Content-Type: application/json' \
  --data-binary @boomi-tool.json
```

Save `apiTool.id` as `API_TOOL_ID`, then discover input IDs:

```sh
curl --fail-with-body --silent --show-error \
  "https://realtime-api.voiceflow.com/v2/stable/api-tool-variable?projectID=$PROJECT_ID&environmentAlias=$ENVIRONMENT&apiToolID=$API_TOOL_ID" \
  -H "Authorization: Bearer $VF_TOKEN"

curl --fail-with-body --silent --show-error \
  "https://realtime-api.voiceflow.com/v1/stable/api-tool/$API_TOOL_ID/schema?projectID=$PROJECT_ID&environmentAlias=$ENVIRONMENT" \
  -H "Authorization: Bearer $VF_TOKEN"
```

#### CLI

```sh
jq -n --arg value "$PROVIDER_CREDENTIAL" \
  '{name:"boomi_authorization",visibility:"restricted",defaultValue:$value}' |
vf secret create --project-id "$PROJECT_ID" --output-format json

vf variable create --project-id "$PROJECT_ID" --environment-alias "$ENVIRONMENT" \
  --name boomi_request --color-param '#515A63' --default-value '""' --output-format json

vf api-tool create --project-id "$PROJECT_ID" --environment-alias "$ENVIRONMENT" \
  --output-format json < boomi-tool.json
```

Save `apiTool.id` as `API_TOOL_ID`, then discover input IDs:

```sh
vf api-tool variable list --project-id "$PROJECT_ID" --environment-alias "$ENVIRONMENT" \
  --api-tool-id "$API_TOOL_ID" --output-format json

vf api-tool get-schema --project-id "$PROJECT_ID" --environment-alias "$ENVIRONMENT" \
  --tool-id "$API_TOOL_ID" --output-format json
```

Creating the Secret default also writes Main's Published value. If your selected Environment uses a different credential, set its [Draft override](/docs/documentation/build/data/secrets#publishing-reverting-and-discarding-changes) before testing. Match each `variables[].name` to its `id` for the attachment; resolve `unresolvedReferences` before continuing.

<a id="run-request"></a>

## Check a delivery request

Provide a verified request and use the result from the current call.

Invoke **Check a delivery request** when the customer asks where their order is. The authenticated application supplies the verified identity and prepared request variable before the call; keep those inputs bound to trusted defaults. Use the returned order ID, delivery status and estimated delivery only after confirming they belong to the requested order. For a pending result, explain that work is waiting. For a current failure or missing required fields, say the result could not be confirmed; never reuse an earlier result or automatically repeat an uncertain write.

### Prepare the request

#### Developer

The application developer builds the request from an authenticated customer/resource and the confirmed task. Save this illustrative body as `boomi-request.json`, replacing test identities with values the application has verified:

```json
{
  "customer_id": "verified-customer-123",
  "order_id": "order-test-1042"
}
```

Serialize it with the [literal-safe request encoder](/docs/examples/automation/encode-request.mjs): `node encode-request.mjs boomi-request.json > boomi-payload.txt`. It preserves quotes, newlines and literal text such as `{customer_name}` without treating that text as a Voiceflow variable or Secret. Do not concatenate customer text into quoted JSON placeholders.

#### Studio

Have your developer deliver the encoded string and populate `boomi_request` in the authenticated client's next action **before** this tool runs. They send `variables` on the [runtime action](/docs/api-reference/v4interact/interact-non-stream#streaming-action); creating the variable or session alone does not fill it. For Studio Run, use the temporary test default described above, then clear it. The provider service must enforce customer access and validate the request; tool descriptions do not enforce either.

#### Developer

Read the confirmed body, encode it, and build standalone inputs. This tests the saved request against the selected Environment's Draft; it does not attach the tool or publish the agent.

```sh
node encode-request.mjs boomi-request.json > boomi-payload.txt
jq -n --rawfile payload boomi-payload.txt \
  '{inputs:{authorization:"{boomi_authorization}",payload:$payload}}' > boomi-inputs.json
```

#### API

```sh
curl --fail-with-body --silent --show-error \
  "https://realtime-api.voiceflow.com/v1/stable/api-tool/$API_TOOL_ID/execute?projectID=$PROJECT_ID&environmentAlias=$ENVIRONMENT" \
  -H "Authorization: Bearer $VF_TOKEN" -H 'Content-Type: application/json' \
  --data-binary @boomi-inputs.json
```

#### CLI

```sh
vf api-tool execute --project-id "$PROJECT_ID" --environment-alias "$ENVIRONMENT" \
  --tool-id "$API_TOOL_ID" --output-format json < boomi-inputs.json
```

Require `success: true`, inspect `output.status` and `output.body`, and check the business fields against the service owner's response schema. `truncated: true` means the returned body is incomplete. On timeout or error, inspect provider execution before retrying a write.

### Let the agent use the request

#### Studio

### 1. Describe the trigger and result use

Open the attached **Check a delivery request** tool and set **Trigger** to the condition below. Its input defaults must already point to the Secret and prepared request variable; the model must not collect credentials or choose another customer's identifier.

```markdown
Use Check a delivery request when the customer asks for this service and the application has supplied the verified request. Use the order verified by the application.
Read the current tool result. Report only the returned order status and estimated delivery.
If the response is pending, say the request is pending. If the call fails or the required fields are missing, explain that the result could not be confirmed. Never reuse an earlier result or automatically repeat a write.
```

### 2. Test the conversation

In **Run**, use the verified test request. Ask "Where is my order?" and confirm the intended tool runs with the fixed identity and prepared payload. Inspect the current tool result in Run and compare it with the order in the business system. Also test the rejected-resource case: the agent must not claim success or expose another customer's data.

#### Developer

Save this as `boomi-attachment.json`. Replace `YOUR_API_TOOL_ID` and each input ID with the values discovered above. The payload and credential are defaults, not model-collected inputs.

```json
{
  "type": "api",
  "apiToolID": "YOUR_API_TOOL_ID",
  "target": {
    "global": true
  },
  "description": "Use when the customer asks where their order is, after the application supplies the verified customer and order request. Answer from the current matching order_id, status and estimated_delivery. Explain pending, missing or failed results without reusing an earlier response.",
  "asyncExecution": false,
  "inputVariables": {
    "authorization": {
      "apiToolInputVariableID": "AUTHORIZATION_INPUT_ID",
      "required": false,
      "defaultValue": "{boomi_authorization}"
    },
    "payload": {
      "apiToolInputVariableID": "PAYLOAD_INPUT_ID",
      "required": false,
      "defaultValue": "{boomi_request}"
    }
  }
}
```

#### API

```sh
curl --fail-with-body --silent --show-error \
  "https://realtime-api.voiceflow.com/v2/stable/tool?projectID=$PROJECT_ID&environmentAlias=$ENVIRONMENT" \
  -H "Authorization: Bearer $VF_TOKEN" -H 'Content-Type: application/json' \
  --data-binary @boomi-attachment.json
```

#### CLI

```sh
vf tool create --project-id "$PROJECT_ID" --environment-alias "$ENVIRONMENT" \
  --output-format json < boomi-attachment.json
```

Your authenticated backend supplies the encoded payload as `variables.boomi_request` on the next [runtime action](/docs/api-reference/v4interact/interact-non-stream#streaming-action). Use a test client bound to this project's Draft, ask for the order status and inspect the emitted tool call, current response and agent answer. Verify both the successful and rejected-resource cases. The backend/provider enforces access; the description is model guidance, not an authorization gate.

The attached API tool returns the provider body to the agent. For a Workflow's **Capture response**, paths start at that body: for example `status` rather than standalone `output.body.status`. A missing capture can leave an earlier variable value unchanged; clear result variables before a Workflow call and branch on the current HTTP/business outcome. These Global tool examples use the current result directly.

<a id="maintaining-the-connection"></a>

## Maintaining the connection

Inspect provider execution, update credentials and test the intended deployment.

| Symptom | Check |
| --- | --- |
| 401/403 | Verify the deployed runtime's authentication type and credentials. A Platform API token is not the Basic web-service token. |
| 404 or no listener | Check the runtime, deployment, simple URL path and listener state. |
| 200 with no delivery document | Check the output profile and Return Documents path; a web-server acknowledgment is insufficient. |
| Invalid or multiple documents | Return one JSON document matching the agreed response profile, then inspect the actual body in Voiceflow. |
| Timeout or runtime unavailable | Check process execution in Boomi. For any write variant, inspect downstream state before repeating the request. |

### Replace a credential

### 1. Inspect the original provider execution

Use the request ID and execution time to find the provider run and its downstream record. A timeout can follow a completed side effect; reconcile that state before repeating a write.

### 2. Update the intended credential version

#### Studio

Open the same project and **More → Secrets**, select the provider Secret and update the target Environment's **Draft value** for testing. After validation, explicitly set the Published value for the intended Environment; this changes the credential serving live traffic.

#### Developer

Retain `secret.id` from creation as `SECRET_ID`, set `PROVIDER_CREDENTIAL` to the replacement and use the value operation below. After validation, explicitly set the Published value for the intended Environment; this changes the credential serving live traffic.

#### Developer

Save the Draft update body as `credential-value.json`:

```sh
jq -n --arg value "$PROVIDER_CREDENTIAL" --arg env "$ENVIRONMENT" \
  '{value:$value,environmentAlias:$env,versionVariant:"draft"}' > credential-value.json
```

#### API

```sh
curl --fail-with-body --silent --show-error -X PUT \
  "https://realtime-api.voiceflow.com/v1/stable/secret/$SECRET_ID/value?projectID=$PROJECT_ID" \
  -H "Authorization: Bearer $VF_TOKEN" -H 'Content-Type: application/json' \
  --data-binary @credential-value.json
```

#### CLI

```sh
vf secret set-value --project-id "$PROJECT_ID" --secret-id "$SECRET_ID" \
  --output-format json < credential-value.json
```

For the selected Environment's Published credential, change `versionVariant` to `published` after the Draft test. To replace the project default, omit `environmentAlias` and `versionVariant`; this also writes Main's Published value. Test the intended connection before changing a live default.

Before launch, select the target Environment and supply the provider Secret's **Default value** for its published agent; a Draft override alone does not supply Published. [Publish the tested configuration](/docs/documentation/deploy/environments/publishing), then repeat the conversation test against that Environment's published client and verify the provider account/resource it reaches.

Rotate the credential with the provider owner, update the relevant Secret default/Environment overrides, and retest the existing tool. Removing a tool from Voiceflow does not remove the provider deployment or revoke its credential. Disable/revoke access in Boomi when retiring the integration, then remove the unused attachment and API resource.
