IBM webMethods Integration API

Name: IBM webMethods Integration API API
Brand: IBM webMethods Integration API
Availability: InStock

✓ Official Vendor SpecDeveloper ToolsCi Cdbearer15 EndpointsREST

For Agents

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

Connect the IBM webMethods Integration API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the IBM webMethods Integration API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with IBM webMethods Integration API API.

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

GET STARTED

Start building with IBM webMethods Integration API API

Explore with Jentic

View OpenAPI Document

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.

Use Cases

Patterns agents use IBM webMethods Integration API API for, with concrete tasks.

★ 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.

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.

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.

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.

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

Key Endpoints

15 endpoints — ibm webmethods integration (formerly software ag webmethods.

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

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

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

webMethods bearer tokens are stored encrypted in the Jentic vault. Agents call webMethods through scoped Jentic credentials and never see the raw token, which keeps tenant-level integration credentials out of agent prompts.

Intent-based discovery

Agents search by intent (for example 'run a webMethods workflow') and Jentic returns the matching operation with its parameter schema, so the agent does not have to navigate the webMethods reference.

Time to first call

Direct webMethods integration: 2-4 days for auth, workflow input shaping, and run polling. Through Jentic: under one hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

IBM API Connect Management API

API Connect publishes the APIs that may be backed by webMethods flow services.

Use webMethods to build the integration logic. Use API Connect to expose that logic as a managed external API.

Alternative

Azure Logic Apps Management API

Azure Logic Apps is Microsoft's iPaaS; webMethods is the IBM-platform equivalent.

Choose Azure Logic Apps for Azure-centric integration. Choose webMethods when the organisation already runs IBM Cloud Pak for Integration.

Complementary

IBM Business Automation Workflow API

BAW handles long-running human workflows; webMethods handles cross-system data integration.

Use webMethods for SaaS-to-SaaS data movement. Use BAW when the workflow includes human tasks and case folders.

FAQs

Specific to using IBM webMethods Integration API API through Jentic.

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 the Jentic vault 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.