CONNECT APP
Build with Userflow
Web & App Development
- API key
MCP
Give your agent Userflow tools
Every Userflow 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 Userflow 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": "userflow",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create or Update User:
const result = await mcp.callTool({
name: "userflow-create-update-user",
arguments: {
userId: "User ID",
numberOfGroups: 10,
},
})# 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": "userflow",
}
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 or Update User:
result = await session.call_tool("userflow-create-update-user", {
"userId": "User ID",
"numberOfGroups": 10,
})API PROXY
Call the Userflow API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Userflow 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.userflow.com/users",
})
// Any allowed Userflow 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.userflow.com/users
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkudXNlcmZsb3cuY29tL3VzZXJz?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Userflow actions from your backend
Connect a user's Userflow account once, then run Create or Update User 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: "userflow-create-update-user",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
userflow: { authProvisionId: "apn_xxxxxxx" },
userId: "User ID",
numberOfGroups: 10,
},
})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="userflow-create-update-user",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"userflow": {"authProvisionId": "apn_xxxxxxx"},
"userId": "User ID",
"numberOfGroups": 10,
},
)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": "userflow-create-update-user",
"configured_props": {
"userflow": { "authProvisionId": "apn_xxxxxxx" },
"userId": "User ID",
"numberOfGroups": 10
}
}'TOOLS
Userflow actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create or Update User
actionCreates or updates a user in Userflow. If the user does not already exist in Userflow, it will be created. If it already exists, the given attributes will be merged into the existing user's attributes. See the documentationWritev0.0.2 -
Find User
actionFinds an existing user by user ID or email, optionally filtering by group ID. See the documentationRead-onlyv0.0.2
EVENTS
Userflow triggers
Event sources your backend can deploy for users and receive through a webhook.
-
New Checklist Completed (Instant)
triggerEmit new event when a user has completed all tasks in a checklist. See the documentationInstantv0.0.1 -
New Event Tracked (Instant)
triggerEmit new new event when an event is tracked in Userflow. See the documentationInstantv0.0.1 -
New Flow Completed (Instant)
triggerEmit new event when a flow is completed by a user by reaching a goal step. See the documentationInstantv0.0.1
- App slug
- userflow
- Authentication
- API key
- Categories
- Web & App Development
- Actions
- 2
- Triggers
- 3
- API proxy
- Available