View as Markdown
Workiz icon

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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Lead inputs
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