CONNECT APP
Build with WorkFlowy
Productivity
- API key
MCP
Give your agent WorkFlowy tools
Every WorkFlowy 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 WorkFlowy 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": "workflowy",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Node:
const result = await mcp.callTool({
name: "workflowy-create-node",
arguments: {
name: "Name",
note: "Note",
},
})# 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": "workflowy",
}
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 Node:
result = await session.call_tool("workflowy-create-node", {
"name": "Name",
"note": "Note",
})API PROXY
Call the WorkFlowy API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the WorkFlowy 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://workflowy.com/api/v1/nodes",
})
// Any allowed WorkFlowy 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://workflowy.com/api/v1/nodes
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly93b3JrZmxvd3kuY29tL2FwaS92MS9ub2Rlcw?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run WorkFlowy actions from your backend
Connect a user's WorkFlowy account once, then run Create Node 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: "workflowy-create-node",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
workflowy: { authProvisionId: "apn_xxxxxxx" },
name: "Name",
note: "Note",
},
})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="workflowy-create-node",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"workflowy": {"authProvisionId": "apn_xxxxxxx"},
"name": "Name",
"note": "Note",
},
)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": "workflowy-create-node",
"configured_props": {
"workflowy": { "authProvisionId": "apn_xxxxxxx" },
"name": "Name",
"note": "Note"
}
}'TOOLS
WorkFlowy actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Node
actionCreates a new bullet node in WorkFlowy via the beta API (POST /api/v1/nodes). Use this to add a top-level node or a child under an existing parent. To create a child node, first run Search Nodes to obtain a valid parent node ID and pass it asparentNodeId. Returns the newly created node's ID. See the documentation.Writev0.0.2 -
Search Nodes
actionSearches all WorkFlowy nodes by keyword. WorkFlowy has no dedicated search endpoint, so this exports all nodes (GET /api/v1/nodes-export) and filters client-side by matching the query against each node's name and note. Use this to discover node IDs before running Create Node (as a parent) or Update Node. Note: the export endpoint is rate limited to 1 request per minute. Returns matching nodes with their IDs and content. See the documentation.Read-onlyv0.0.2 -
Update Node
actionUpdates an existing WorkFlowy node's name, note, and/or layout mode (POST /api/v1/nodes/:id). Run Search Nodes first to obtain the target node ID. At least one of name, note, or layout mode must be provided. Note that the update endpoint only returns a status, not the full updated node. See the documentation.Writev0.0.2
EVENTS
WorkFlowy triggers
Event sources your backend can deploy for users and receive through a webhook.
No WorkFlowy triggers are available yet.
- App slug
- workflowy
- Authentication
- API key
- Categories
- Productivity
- Actions
- 3
- Triggers
- 0
- API proxy
- Available