canonical: https://jentic.com/apis/ibm.com/webmethods-integration

# IBM webMethods Integration API

IBM webMethods Integration (formerly Software AG webMethods.io) is the integration platform-as-a-service that enterprises use to wire SaaS, on-prem, and event-driven systems together via flow services and prebuilt connectors. The REST API exposes workflows, flow services, connector accounts, and execution monitoring so platform teams can run, observe, and operate integrations from CI pipelines or AI agents instead of the webMethods console. It is suited to teams that need to embed integration runs in larger automations.

## For AI agents

Run and monitor IBM webMethods workflows and flow services, manage connector accounts, and inspect execution history through a single REST surface.

## Scope

Does not handle workflow authoring, connector source code, or low-level message transport - use for running and monitoring webMethods workflows, flow services, and connectors only.

## Capabilities

- List and inspect workflows via `/integration/rest/external/v1/workflows`
- Trigger a workflow run via `/integration/rest/external/v1/workflows/{workflowUid}/run`
- Inspect workflow executions via `/integration/rest/external/v1/workflows/{workflowUid}/executions`
- Run flow services on demand via `/integration/rest/external/v1/flowservices/{flowServiceUid}/run`
- Manage connectors and their accounts via `/integration/rest/external/v1/connectors` and `/connectors/accounts`
- Inspect overall execution history via `/integration/rest/external/v1/monitor/executions`

## Use cases

### Workflow Orchestration

Run a webMethods workflow as part of an external automation - for example, kick off an order-fulfilment workflow when a webhook fires from an upstream system. POST to `/integration/rest/external/v1/workflows/{workflowUid}/run` to start the workflow, then poll /executions for completion and outcome.

Example prompt: POST to `/integration/rest/external/v1/workflows/{workflowUid}/run` for the order-fulfilment workflow with the order ID payload, then poll /executions until status is Completed.

### On-Demand Flow Service Execution

Run a flow service synchronously - for example, validating an inbound payload by passing it through a transformation flow and reading the result. The `/integration/rest/external/v1/flowservices/{flowServiceUid}/run` endpoint accepts the input and returns the flow output, which makes it the right surface when integration logic should be reusable across multiple callers.

Example prompt: POST the inbound order payload to `/integration/rest/external/v1/flowservices/{flowServiceUid}/run` and use the validated output to drive the next step.

### Execution Monitoring

Pull execution history across workflows so an external dashboard or agent can flag failures and rerun stuck integrations. The `/monitor/executions` endpoint returns recent executions, and per-workflow /executions returns history for a single workflow, which together cover both global and targeted monitoring.

Example prompt: GET `/integration/rest/external/v1/monitor/executions` for the last hour and post any Failed executions to the on-call channel.

### AI Agent Integration Operator

An AI agent uses Jentic to drive webMethods workflows and flow services from natural-language requests, without holding the raw bearer token for the tenant. The agent searches by intent, loads the workflow run schema, and executes the call. Typical agent integration is under one hour because the run-and-monitor surface is concentrated on a few endpoints.

Example prompt: Search Jentic for 'run a webMethods workflow', load the `/workflows/{workflowUid}/run` schema, and trigger the order-fulfilment workflow.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/integration/rest/external/v1/workflows` | List workflows |
| POST | `/integration/rest/external/v1/workflows/{workflowUid}/run` | Run a workflow |
| GET | `/integration/rest/external/v1/workflows/{workflowUid}/executions` | List executions for a workflow |
| POST | `/integration/rest/external/v1/flowservices/{flowServiceUid}/run` | Run a flow service |
| GET | `/integration/rest/external/v1/connectors` | List connectors |
| GET | `/integration/rest/external/v1/connectors/accounts` | List connector accounts |
| GET | `/integration/rest/external/v1/projects` | List projects |
| GET | `/integration/rest/external/v1/monitor/executions` | Inspect execution history |

## Key resources

- **Workflows** — Run, list, and monitor workflows
- **Flow Services** — Run flow services on demand
- **Connectors** — Inspect connector definitions and accounts
- **Projects** — Group workflows and flow services
- **Monitoring** — Inspect execution history across the tenant

## Why Jentic

- **Setup:** Wiring the IBM webMethods Integration API by hand means handling its bearer-token auth, resolving your tenant and regional webmethods.io host, and mapping its workflow and flow-service routes yourself. Through Jentic you install once, import the IBM webMethods Integration API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** webMethods puts the workflow and flow service ids in the URL path (`/workflows/{workflowUid}`, `/flowservices/{flowServiceUid}`), so a rule can pin your agent to reading and running one workflow. You choose the operations it may call, so running a flow service is not included unless you add it.
- **Credential handling:** Your webMethods token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'run a webMethods workflow' or 'check recent workflow executions', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **IBM API Connect Management API** — API Connect publishes the APIs that may be backed by webMethods flow services.
- **Azure Logic Apps Management API** — Azure Logic Apps is Microsoft's iPaaS; webMethods is the IBM-platform equivalent.
- **IBM Business Automation Workflow API** — BAW handles long-running human workflows; webMethods handles cross-system data integration.

## FAQ

### What authentication does the IBM webMethods Integration API use?

The webMethods Integration REST API uses HTTP bearer authentication. Through Jentic, the bearer token for the tenant is stored in your Jentic One instance and the agent calls webMethods via a scoped Jentic credential rather than the raw token.

### Can I trigger a workflow with this API?

Yes. POST to `/integration/rest/external/v1/workflows/{workflowUid}/run` with the workflow inputs to start a run. Poll `/workflows/{workflowUid}/executions` for the run status, or pull `/monitor/executions` for a tenant-wide view.

### What is the difference between workflows and flow services?

Workflows are the higher-level orchestrations triggered by events or schedules and are run via `/workflows/{workflowUid}/run.` Flow services are reusable on-demand routines invoked synchronously via `/flowservices/{flowServiceUid}/run`, suitable for transformations that multiple callers share.

### How do I run a webMethods workflow through Jentic?

Search Jentic for 'run a webMethods workflow', load the `/workflows/{workflowUid}/run` schema, and execute with the workflow inputs. Install the SDK with pip install jentic and use the async search, load, execute pattern.

### Can I list all connector accounts on the tenant?

Yes. GET `/integration/rest/external/v1/connectors/accounts` returns the connector accounts configured on the tenant, which is the right starting point when auditing which third-party systems are wired into the integration platform.

### What are the rate limits for the IBM webMethods Integration API?

webMethods does not publish a fixed REST rate limit; throughput depends on the tenant's plan and the underlying execution capacity. Treat 429 and 503 responses as backpressure, retry with exponential backoff, and avoid tight polling loops on /executions.

### Can I limit what my agent is allowed to do with the IBM webMethods Integration API?

Yes. Because you run Jentic One yourself, your own rules decide which webMethods operations and which stored tenant token the agent may use. Since webMethods puts the workflow and flow service ids in the URL path (`/workflows/{workflowUid}`, `/flowservices/{flowServiceUid}`), you can pin the agent to reading and running a single workflow while blocking everything else. Running a flow service via `/flowservices/{flowServiceUid}/run` or listing connector accounts is not included unless you explicitly add those operations.