Workiz ACTION
Create Lead
Create a new lead in Workiz. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Workiz account once, then configure and run Create Lead 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: "workiz-create-lead",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
workiz: { authProvisionId: "apn_xxxxxxx" },
email: "Email",
phone: "Phone",
},
})
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": "workiz-create-lead",
"configured_props": {
"workiz": { "authProvisionId": "apn_xxxxxxx" },
"email": "Email",
"phone": "Phone"
}
}'// 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": "workiz",
},
},
},
)
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: "workiz-create-lead",
arguments: {
email: "Email",
phone: "Phone",
},
})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 |
|---|---|---|
email Email | string | Email address of the lead Required |
phone Phone | string | Phone number of the lead Optional |
firstName First Name | string | First name of the lead Optional |
lastName Last Name | string | Last name of the lead Optional |
company Company | string | Company name of the lead Optional |
address Address | string | Street address of the service location Optional |
city City | string | City of the service location Optional |
state State | string | State of the service location Optional |
postalCode Postal Code | string | Postal Code of the service location Optional |
leadDateTime Job Datetime | string | The datetime of the lead in ISO 8601 format, e.g. 2016-08-29T09:12:33.001Z Optional |
jobType Job Type | string | The type of job Optional |
jobSource Job Source | string | The source of job 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
- workiz-create-lead
- Version
- 0.0.2
- App
- Workiz
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗