CONNECT APP
Build with Workiom
Business Management
- API key
MCP
Give your agent Workiom tools
Every Workiom action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Workiom account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "workiom",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Record:
const result = await mcp.callTool({
name: "workiom-create-record",
arguments: {
appId: "App ID",
listId: "List ID",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "workiom",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Create Record:
result = await session.call_tool("workiom-create-record", {
"appId": "App ID",
"listId": "List ID",
})API PROXY
Call the Workiom API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Workiom API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.workiom.com/api/services/app/Apps/GetAll",
})
// Any allowed Workiom endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.workiom.com/api/services/app/Apps/GetAll
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkud29ya2lvbS5jb20vYXBpL3NlcnZpY2VzL2FwcC9BcHBzL0dldEFsbA?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Workiom actions from your backend
Connect a user's Workiom account once, then run Create Record on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "workiom-create-record",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
workiom: { authProvisionId: "apn_xxxxxxx" },
appId: "App ID",
listId: "List ID",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="workiom-create-record",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"workiom": {"authProvisionId": "apn_xxxxxxx"},
"appId": "App ID",
"listId": "List ID",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "workiom-create-record",
"configured_props": {
"workiom": { "authProvisionId": "apn_xxxxxxx" },
"appId": "App ID",
"listId": "List ID"
}
}'TOOLS
Workiom actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Record
actionCreates a new record in a Workiom list. See the documentationWritev0.0.1 -
List App ID Options
actionRetrieves available options for the App ID field.Read-onlyv0.0.1 -
Update Record
actionUpdates an existing record in a Workiom list. This is a partial update, so you only need to send the fields you want to change. See the documentationWritev0.0.1
EVENTS
Workiom triggers
Event sources your backend can deploy for users and receive through a webhook.
- App slug
- workiom
- Authentication
- API key
- Categories
- Business Management
- Actions
- 3
- Triggers
- 2
- API proxy
- Available