IMPLEMENTATION
Call this tool
Connect a user's ServiceM8 account once, then configure and run Create Job 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: "servicem8-create-job",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
servicem8: { authProvisionId: "apn_xxxxxxx" },
companyUuid: "Company",
createdByStaffUuid: "Created by staff",
},
})
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": "servicem8-create-job",
"configured_props": {
"servicem8": { "authProvisionId": "apn_xxxxxxx" },
"companyUuid": "Company",
"createdByStaffUuid": "Created by staff"
}
}'// 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": "servicem8",
},
},
},
)
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: "servicem8-create-job",
arguments: {
companyUuid: "Company",
createdByStaffUuid: "Created by staff",
},
})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 |
|---|---|---|
companyUuid Company | string | Client/company for this job (billing and contact relationship). Required Dynamic |
createdByStaffUuid Created by staff | string | Staff member who created the job ( created_by_staff_uuid). Optional Dynamic |
date Date | string | Job date ( date); format as accepted by the API (e.g. YYYY-MM-DD HH:MM:SS). Optional |
billingAddress Billing Address | string | Invoice address ( billing_address; max 500). Optional |
status Status | string | Initial job status ( status; max 20 characters). Required |
paymentDate Payment date | string | Payment date ( payment_date). Optional |
paymentActionedByUuid Payment actioned by | string | Staff member ( payment_actioned_by_uuid). Optional Dynamic |
paymentMethod Payment method | string | Payment method ( payment_method). Options are distinct method values from job payments; paste a value if yours is not listed. Optional Dynamic |
paymentAmount Payment amount | string | Payment amount ( payment_amount) in the account currency. Optional |
categoryUuid Category | string | Job category ( category_uuid). Optional Dynamic |
purchaseOrderNumber Purchase Order Number | string | Client PO reference ( purchase_order_number; max 100 characters). Optional |
invoiceSent Invoice sent | boolean | Whether an invoice has been sent ( invoice_sent). Optional |
queueUuid Queue | string | Queue this job belongs to ( queue_uuid). Optional Dynamic |
queueAssignedStaffUuid Queue assigned staff | string | Staff assigned to this job in the queue ( queue_assigned_staff_uuid). Optional Dynamic |
badges Badges | string[] | Badge UUIDs (list badges). Sent as a JSON array string for the API. Optional Dynamic |
jobAddress Job Address | string | Work site address ( job_address; max 500 characters). Required |
jobDescription Job Description | string | Scope or work requested ( job_description). Optional |
workDoneDescription Work done description | string | Description of work completed ( work_done_description). Optional |
paymentProcessed Payment processed | boolean | Exported to accounting ( payment_processed). Optional |
paymentReceived Payment received | boolean | Full payment received ( payment_received). Optional |
completionDate Completion date | string | When status became Completed ( completion_date). Optional |
unsuccessfulDate Unsuccessful date | string | When status became Unsuccessful ( unsuccessful_date). Optional |
note Note | string | Optional diary note (creates a Note linked to the new job after create). 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
- servicem8-create-job
- Version
- 0.0.1
- App
- ServiceM8
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗