Workiz
Schedule jobs, work leads, and read the team and payments of a home-service business over the Workiz API.
About
Workiz ships in the w6w first-party pack. It declares 20 actions, 2 health checks, and the host runs its code in a sandbox that never sees the credential.
- App id
io.w6w.workiz- Version
- 0.1.0
- Author
- w6w
- Licence
- MIT
- Categories
- Calendar & Scheduling · Customer Relationship Management · Finance & Accounting
Overview
Workiz is the field-service-management platform a plumbing, HVAC, cleaning or landscaping business schedules its day on, and this app covers the four resources its public API exposes: the team, company and per-user time off, leads, and jobs.
Jobs and leads are the centre of gravity. A workflow can read one by id or page through them with Workiz’s own filters — a date window, a record count, open-only, and a status list — create and update either, and drive the lifecycle calls that move a lead toward work: mark it lost or put it back with activate, assign or unassign a technician, and convert it into a job. The wrapper each of those returns carries the record’s UUID and its link into the Workiz web app.
Jobs take the same lifecycle plus payment: an addPayment call records a cash, credit or cheque payment against a job, with the same type sent as both a path-adjacent query parameter and a body field because the vendor declares it required in both places.
The client-side shape is deliberately literal. Workiz’s wire format mixes PascalCase and camelCase across resources and this app reproduces every field name exactly, including the vendor’s own inconsistency, because that casing is the API. Two of the API’s design choices are unusual enough to be documented where they matter: the account API token is a URL path segment rather than a header, and every write against an existing record takes a second, per-record auth_secret that the create/get responses hand back. Health covers Workiz’s own Atlassian status page — which reports api.workiz.com as a component — and declares the request-rate dimension unavailable, because Workiz publishes neither rate-limit response headers nor a limits endpoint.
Build with Workiz
Three routes to the same 20 actions. The Workflow tab is generated from Workiz's own manifest and carries its real ids, so it is copy-pasteable; the Code and CLI examples are the same call for any action on any app, so every app-specific value in them is a blank you fill in.
Activate Lead
lead-activate Reactivate a lost lead, identified by UUID and its per-record auth secret.
Convert Lead to Job
lead-convert Convert a lead into a job and return the new job's UUID, client id and link.
List Team
team-list List every team member on the Workiz account, with their role, skills and areas.
List Time Off for a User
time-off-list-for-user Read one team member's time off, addressed by their name.
A workflow step names the app and the action, and the editor fills in the
connection when you pick one. This is the Step shape from the
workflow spec, carrying Workiz's real ids.
{
"manifestVersion": "2",
"name": "workiz-example",
"steps": [
{
"id": "job-add-payment",
"uses": {
"app": "io.w6w.workiz",
"action": "job-add-payment",
"connection": "conn_YOUR_CONNECTION_ID"
},
"with": {
"uuid": "<uuid>",
"type": "<type>",
"amount": "<amount>"
}
}
]
}Here are some of the things you can do
-
Add Job Payment
performjob-add-payment -
Assign Job
performjob-assign -
Create Job
performjob-create -
Get Job
readjob-get -
List Jobs
searchjob-list
+15 more actions available
Every app-specific value here is a blank you have to fill in. An
app action is reached through the connection that authenticates it, so the
address is a connection id, not the app id — and connections belong to your account,
so a public page cannot know yours. Create one for Workiz, then fill in
the three blanks: conn_YOUR_CONNECTION_ID, the action key, and the
parameters that action declares. The call itself is real — the shape is transcribed
from the studio's own snippet builder, which prints the same kind of blanks — but
nothing in it is specific to Workiz. The Workflow tab is where this app's
real ids are.
npm install @w6w/sdkyarn add @w6w/sdkpnpm add @w6w/sdkdeno add npm:@w6w/sdkimport { W6wClient, isActionRun } from "@w6w/sdk";
// Reads W6W_BASE_URL and W6W_TOKEN from the environment when omitted.
const client = new W6wClient();
const envelope = await client.run({
urn: "conn_YOUR_CONNECTION_ID",
action: "job-add-payment",
payload: {
uuid: "<value>",
type: "<value>",
amount: "<value>",
date: "<value>",
authSecret: "<value>",
// reference: "<value>",
},
});
if (isActionRun(envelope)) console.log(envelope.value);npm install -g @w6w/cliw6w run conn_YOUR_CONNECTION_ID --action job-add-payment --payload '{"uuid":"<value>","type":"<value>","amount":"<value>","date":"<value>","authSecret":"<value>"}'Give an AI agent Workiz — without giving it Workiz's credentials. One MCP endpoint exposes every app, function and workflow the caller is entitled to, as tools it can discover and run. Access is granted per team while we onboard.
One tool call{
"name": "w6w_invoke",
"arguments": {
"ref": "app:io.w6w.workiz#job-add-payment",
"input": {
"uuid": "<uuid>",
"type": "<type>",
"amount": "<amount>"
}
}
}
Every tool names its target with a single ref. The
app: form above doesn't name a connection at all — the
host resolves which of the caller's Workiz connections to sign
with, and refuses rather than guesses when the answer is ambiguous.
What the agent gets
Credentials it can't read
The token is attached host-side, at the moment of the call. It is never a tool argument, never in the model's context, and never in a transcript — so a prompt injection has nothing to exfiltrate.
A tool surface scoped to the caller
Tools are derived per end user from what that person has actually connected and is entitled to — not one shared bot identity carrying the union of everyone's access.
A durable workflow in one call
Multi-step work runs on the workflow engine and returns a run handle the agent can poll — retries, branching and state survive the conversation that started them.
Health-aware discovery
Workiz's declared health checks are on the surface too, so an agent can tell "the vendor is down" from "your credential expired" before it burns a retry on either.
The MCP surface is part of the hosted platform. Workiz itself is MIT, and the runtime that executes it is source-available (FSL).
Health checks
Workiz declares its own checks, so its health is a property of the app rather than something the host guesses at.
Workiz platform status
Component status from workiz.statuspage.io. The component list names api.workiz.com directly, alongside app.workiz.com, the calls and SMS services, Communication and Integrations.