Brex ACTION
Invite User
Invites a person to the Brex account as an employee, emailing them to finish onboarding. Returns the new Brex user ID, which Create Card, Set Limit for User, and Get User take. See the documentation
- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Brex account once, then configure and run Invite User from your backend or agent.
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: "brex-invite-user",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
brex: { authProvisionId: "apn_xxxxxxx" },
firstName: "First Name",
lastName: "Last Name",
},
})
console.log(result)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": "brex-invite-user",
"configured_props": {
"brex": { "authProvisionId": "apn_xxxxxxx" },
"firstName": "First Name",
"lastName": "Last Name"
}
}'// 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": "brex",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "brex-invite-user",
arguments: {
firstName: "First Name",
lastName: "Last Name",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
firstName First Name | string | The user's first name, e.g. Jane. Required |
lastName Last Name | string | The user's last name, e.g. Doe. Required |
email Email | string | The work email address the invitation is sent to, e.g. jane@acme.com. Must be unique within the Brex account. Required |
manager Manager | string | The person who reviews and approves this user's expenses, as a Brex user ID. Use List Users to find a user ID by email address. Optional |
department Department | string | The department to assign the user to, as a department ID, e.g. dep_clu9ah28r000008l3d4b1g5xy. Use List Departments to find a department ID by name. Omit to leave the user unassigned. Optional |
location Location | string | The office location to assign the user to, as a location ID, e.g. loc_clu9ah28r000008l3d4b1g5xy. Use List Locations to find a location ID by name. Omit to leave the user unassigned. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- brex-invite-user
- Version
- 0.1.3
- App
- Brex
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗