CONNECT APP
Build with Paylocity
Human Resources
- OAuth
MCP
Give your agent Paylocity tools
Every Paylocity 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 Paylocity 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": "paylocity",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// Every tool arrives with its own input schema — run one with mcp.callTool().# 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": "paylocity",
}
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()
# Every tool arrives with its own input schema — run one with call_tool().API PROXY
Call the Paylocity API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Paylocity 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.example.com/v1/me",
})
// Any allowed Paylocity 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.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Paylocity actions from your backend
Connect a user's Paylocity account once, then discover and run its tools 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 tools = await pd.components.list({
app: "paylocity",
componentType: "action",
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
tools = pd.components.list(
app="paylocity",
component_type="action",
)curl "https://api.pipedream.com/v1/connect/{project_id}/components?app=paylocity&component_type=action" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}"TOOLS
Paylocity actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
No Paylocity actions are available yet.
EVENTS
Paylocity triggers
Event sources your backend can deploy for users and receive through a webhook.
No Paylocity triggers are available yet.
MULTI-APP
Use Paylocity with other popular apps
Most products don't stop at one integration. Pair Paylocity with the other apps your users rely on, and ship use cases that span both.
- App slug
- paylocity
- Authentication
- OAuth
- Categories
- Human Resources
- Actions
- 0
- Triggers
- 0
- API proxy
- Available
OAuth scopes
These are the scopes Pipedream's managed Paylocity OAuth client requests when one of your users connects an account. Supply your own OAuth client to request a different set.
- WebLinkAPI