# Workiom

```json
{
  "name": "Workiom",
  "slug": "workiom",
  "url": "https://composio.dev/toolkits/workiom",
  "markdown_url": "https://composio.dev/toolkits/workiom.md",
  "logo_url": "https://logos.composio.dev/api/workiom",
  "categories": [
    "workflow automation"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:30:38.282Z"
}
```

![Workiom logo](https://logos.composio.dev/api/workiom)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Workiom MCP or direct API to automate workflows, manage records, trigger tasks, and sync data through natural language.

## Summary

Workiom is a workflow automation platform that lets businesses design custom processes and integrate apps. It streamlines operations to reduce manual work and boost productivity.

## Categories

- workflow automation

## Toolkit Details

- Tools: 3

## Images

- Logo: https://logos.composio.dev/api/workiom

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Workiom.
  - Setup:
    - Configure Api Key credentials for Workiom.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- List all active projects in our workspace
- Create a new client record in CRM list
- Fetch overdue tasks from the Tasks list
- Show all lists with their field definitions

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `WORKIOM_CREATE_RECORD` | Create record | Creates a new record in a specified Workiom list. This tool creates a record with basic field types like text, numbers, dates, and static list items. The record data should be provided as a JSON object where each key is a field ID and the value matches the expected data type for that field. |
| `WORKIOM_GET_ALL_LISTS` | Get all lists | Get all lists from a Workiom app. This action fetches all lists within a specific Workiom app. Lists are containers for records (similar to database tables) and are the fundamental data structure in Workiom. Each list has a unique ID and contains views for displaying data. Use this action to discover available lists before performing operations like creating records (which require a list ID). |
| `WORKIOM_GET_RECORDS` | Get records | Retrieves records from a specified Workiom list. Use this action to fetch data from a Workiom list. The list_id is required and can be obtained from the WORKIOM_GET_ALL_LISTS action. Each record contains field values keyed by numeric field IDs. Features: - Pagination: Use max_result_count and skip_count to paginate through large datasets - Sorting: Sort by any field using 'FIELD_ID ASC' or 'FIELD_ID DESC' format - Filtering: Apply conditions using filter operators (Contains, Is, Greater, etc.) Note: Field IDs are numeric (e.g., 5037173) and can be found in list metadata. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Workiom Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Workiom actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Create a new record in the "Sales Leads" list with today\'s contact details.'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Create a new record in the "Sales Leads" list with today\'s contact details.'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Workiom tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Get all lists from my Workiom workspace')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Get all lists from my Workiom workspace' }],
  stopWhen: stepCountIs( 5 )
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Workiom Integration

- Supports both Workiom MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Workiom data

### 2. Managed Auth

- Built-in API key handling for Workiom with secure storage
- Central place to manage, scope, and revoke Workiom access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Workiom
- Scoped, least privilege access to Workiom resources
- Full audit trail of agent actions to support review and compliance

## Use Workiom with any AI Agent Framework

Choose a framework you want to connect Workiom with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/workiom/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/workiom/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/workiom/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/workiom/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/workiom/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/workiom/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/workiom/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/workiom/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/workiom/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/workiom/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/workiom/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/workiom/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/workiom/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/workiom/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/workiom/framework/autogen)

## Related Toolkits

- [Apilio](https://composio.dev/toolkits/apilio) - Apilio is a home automation platform that lets you connect and control smart devices from different brands. It helps you build flexible automations with complex conditions, schedules, and integrations.
- [Basin](https://composio.dev/toolkits/basin) - Basin is a no-code form backend for quickly setting up reliable contact forms. It lets you collect and manage form submissions without writing any server-side code.
- [Bouncer](https://composio.dev/toolkits/bouncer) - Bouncer is an email validation platform that verifies the authenticity of email addresses in real-time and batch. It helps boost deliverability and reduce bounce rates for your communications.
- [Conveyor](https://composio.dev/toolkits/conveyor) - Conveyor is a platform that automates security reviews with a Trust Center and AI-driven questionnaire automation. It streamlines compliance and vendor security processes for faster, hassle-free reviews.
- [Crowdin](https://composio.dev/toolkits/crowdin) - Crowdin is a localization management platform that streamlines translation workflows and collaboration. It helps teams centralize multilingual content, boost productivity, and automate translation processes.
- [Databox](https://composio.dev/toolkits/databox) - Databox is a business analytics platform that connects your data from any tool and device. It helps you track KPIs, build dashboards, and discover actionable insights.
- [Detrack](https://composio.dev/toolkits/detrack) - Detrack is a delivery management platform for real-time tracking and proof of delivery. It helps businesses automate notifications and keep customers updated every step of the way.
- [Dnsfilter](https://composio.dev/toolkits/dnsfilter) - Dnsfilter is a cloud-based DNS security and content filtering solution. It helps organizations block online threats and manage safe internet access with ease.
- [Faraday](https://composio.dev/toolkits/faraday) - Faraday lets you embed AI in workflows across your stack for smarter automation. It boosts your favorite tools with actionable intelligence and seamless integration.
- [Feathery](https://composio.dev/toolkits/feathery) - Feathery is an AI-powered platform for building dynamic data intake forms with advanced logic. It helps teams automate complex workflows and collect structured data with ease.
- [Fillout forms](https://composio.dev/toolkits/fillout_forms) - Fillout forms is an online platform for building and managing forms with a flexible API. It lets you create, distribute, and collect responses from forms with ease.
- [Formdesk](https://composio.dev/toolkits/formdesk) - Formdesk is an online form builder for creating and managing professional forms. It's perfect for collecting data, automating workflows, and integrating form submissions with your favorite services.
- [Formsite](https://composio.dev/toolkits/formsite) - Formsite lets you build online forms and surveys with drag-and-drop simplicity. Capture, manage, and integrate form responses securely for streamlined workflows.
- [Graphhopper](https://composio.dev/toolkits/graphhopper) - GraphHopper is an enterprise-grade Directions API for routing, optimization, and geocoding across multiple vehicle types. It enables fast, reliable route planning and logistics automation for businesses.
- [Hyperbrowser](https://composio.dev/toolkits/hyperbrowser) - Hyperbrowser is a next-generation platform for scalable browser automation. It empowers AI agents to interact with web apps, automate workflows, and handle browser sessions at scale.
- [La Growth Machine](https://composio.dev/toolkits/lagrowthmachine) - La Growth Machine automates multi-channel sales outreach and routine tasks for sales teams. Streamline your workflow and focus on closing more deals.
- [Leverly](https://composio.dev/toolkits/leverly) - Leverly is a workflow automation platform that connects and coordinates actions across your apps. It streamlines repetitive processes so your business runs smoother, faster, and with fewer manual steps.
- [Maintainx](https://composio.dev/toolkits/maintainx) - Maintainx is a cloud-based CMMS for centralizing maintenance data, communication, and workflows. It helps organizations streamline maintenance operations and improve team coordination.
- [Make](https://composio.dev/toolkits/make) - Make is an automation platform that connects your favorite apps and services. Build powerful, custom workflows without writing code.
- [Ntfy](https://composio.dev/toolkits/ntfy) - Ntfy is a notification service to send push messages to phones or desktops. Instantly deliver alerts and updates to users, devices, or teams.

## Frequently Asked Questions

### Do I need my own developer credentials to use Workiom with Composio?

Yes, Workiom requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)