# ServiceM8 — Pipedream Connect

> Field service software

- API slug: `servicem8` (use in MCP headers and tool keys)
- Auth: OAuth (Pipedream-managed)
- Categories: Business Management
- Website: https://servicem8.com
- Managed OAuth scopes: `staff_locations` · `staff_activity` · `publish_sms` · `publish_email` · `vendor` · `vendor_logo` · `vendor_email` · `read_locations` · `manage_locations` · `read_staff` · `manage_staff` · `read_customers` · `manage_customers` · `read_customer_contacts` · `manage_customer_contacts` · `read_jobs` · `manage_jobs` · `create_jobs` · `read_job_contacts` · `manage_job_contacts` · `read_job_materials` · `manage_job_materials` · `read_job_categories` · `manage_job_categories` · `read_job_queues` · `manage_job_queues` · `read_tasks` · `manage_tasks` · `read_schedule` · `manage_schedule` · `read_inventory` · `manage_inventory` · `read_job_notes` · `publish_job_notes` · `read_job_photos` · `publish_job_photos` · `read_job_attachments` · `publish_job_attachments` · `read_inbox` · `read_messages` · `manage_notifications` · `manage_templates` · `manage_badges` · `read_assets` · `manage_assets` · `read_attachments`
- This page (HTML): https://pipedream.com/apps/servicem8
- Tools: 75 actions · 5 triggers

## Connect via MCP (recommended)

- Endpoint: `https://remote.mcp.pipedream.net/v3`
- Headers: `Authorization: Bearer <token>` · `x-pd-project-id` · `x-pd-environment` · `x-pd-external-user-id` · `x-pd-app-slug: servicem8`

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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()

// e.g. run Create Attachment:
const result = await mcp.callTool({
  name: "servicem8-create-dboattachment",
  arguments: {
    relatedObject: "Related Object",
    relatedObjectUuid: "Related record",
  },
})
```

Docs: [MCP guide](https://pipedream.com/docs/connect/mcp/developers.md)

## API proxy

For a ServiceM8 endpoint with no pre-built tool, the proxy forwards your request with the connected user's credentials attached.

```bash
# The path segment is the target URL, URL-safe base64 encoded:
# https://api.servicem8.com/api_1.0/staff.json

curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuc2VydmljZW04LmNvbS9hcGlfMS4wL3N0YWZmLmpzb24?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
  -H "Authorization: Bearer {access_token}" \
  -H "x-pd-environment: production"
```

Docs: [API proxy guide](https://pipedream.com/docs/connect/api-proxy.md)

## SDK

```ts
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-dboattachment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    servicem8: { authProvisionId: "apn_xxxxxxx" },
    relatedObject: "Related Object",
    relatedObjectUuid: "Related record",
  },
})
```

Docs: [Managed auth guide](https://pipedream.com/docs/connect/managed-auth/quickstart.md) · [Tools guide](https://pipedream.com/docs/connect/components.md)

## Actions (75)

### `servicem8-create-dboattachment` — Create Attachment (Write)

Create an attachment. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-dboattachment.md

### `servicem8-create-badge` — Create Badge (Write)

Create a badge. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-badge.md

### `servicem8-create-category` — Create Category (Write)

Create a job category. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-category.md

### `servicem8-create-company` — Create Company (Write)

Create a company (client). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-company.md

### `servicem8-create-company-contact` — Create Company Contact (Write)

Create a company contact. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-company-contact.md

### `servicem8-create-job` — Create Job (Write)

Create a job. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-job.md

### `servicem8-create-job-activity` — Create Job Activity (Write)

Create a job activity. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-job-activity.md

### `servicem8-create-job-contact` — Create Job Contact (Write)

Create a job contact. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-job-contact.md

### `servicem8-create-job-material` — Create Job Material (Write)

Create a job material line. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-job-material.md

### `servicem8-create-job-payment` — Create Job Payment (Write)

Create a job payment. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-job-payment.md

### `servicem8-create-queue` — Create Job Queue (Write)

Create a job queue. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-queue.md

### `servicem8-create-note` — Create Note (Write)

Create a note. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-note.md

### `servicem8-create-staff` — Create Staff Member (Write)

Create a staff member. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-staff.md

### `servicem8-create-webhook-subscription` — Create Webhook Subscription (Write)

Create or update an object webhook subscription. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/create-webhook-subscription.md

### `servicem8-delete-dboattachment` — Delete Attachment (Write)

Delete an attachment by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-dboattachment.md

### `servicem8-delete-badge` — Delete Badge (Write)

Delete a badge by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-badge.md

### `servicem8-delete-category` — Delete Category (Write)

Delete a category by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-category.md

### `servicem8-delete-company` — Delete Company (Write)

Delete a company by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-company.md

### `servicem8-delete-company-contact` — Delete Company Contact (Write)

Delete a company contact by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-company-contact.md

### `servicem8-delete-job` — Delete Job (Write)

Delete a job by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-job.md

### `servicem8-delete-job-activity` — Delete Job Activity (Write)

Delete a job activity by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-job-activity.md

### `servicem8-delete-job-contact` — Delete Job Contact (Write)

Delete a job contact by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-job-contact.md

### `servicem8-delete-job-material` — Delete Job Material (Write)

Delete a job material by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-job-material.md

### `servicem8-delete-job-payment` — Delete Job Payment (Write)

Delete a job payment by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-job-payment.md

### `servicem8-delete-note` — Delete Note (Write)

Delete a note by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-note.md

### `servicem8-delete-queue` — Delete Queue (Write)

Delete a job queue by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-queue.md

### `servicem8-delete-staff` — Delete Staff (Write)

Delete a staff member by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-staff.md

### `servicem8-delete-webhook-subscription` — Delete Webhook Subscription (Write)

Delete a webhook subscription by object type. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/delete-webhook-subscription.md

### `servicem8-get-dboattachment` — Get Attachment (Read-only)

Get an attachment by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-dboattachment.md

### `servicem8-get-badge` — Get Badge (Read-only)

Get a badge by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-badge.md

### `servicem8-get-category` — Get Category (Read-only)

Get a category by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-category.md

### `servicem8-get-company` — Get Company (Read-only)

Get a company by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-company.md

### `servicem8-get-company-contact` — Get Company Contact (Read-only)

Get a company contact by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-company-contact.md

### `servicem8-get-feedback` — Get Feedback (Read-only)

Get feedback by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-feedback.md

### `servicem8-get-job` — Get Job (Read-only)

Get a job by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-job.md

### `servicem8-get-job-activity` — Get Job Activity (Read-only)

Get a job activity by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-job-activity.md

### `servicem8-get-job-contact` — Get Job Contact (Read-only)

Get a job contact by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-job-contact.md

### `servicem8-get-job-material` — Get Job Material (Read-only)

Get a job material by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-job-material.md

### `servicem8-get-job-payment` — Get Job Payment (Read-only)

Get a job payment by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-job-payment.md

### `servicem8-get-note` — Get Note (Read-only)

Get a note by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-note.md

### `servicem8-get-queue` — Get Queue (Read-only)

Get a job queue by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-queue.md

### `servicem8-get-staff` — Get Staff (Read-only)

Get a staff member by UUID. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/get-staff.md

### `servicem8-list-dboattachments` — List Attachments (Read-only)

List attachments with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-dboattachments.md

### `servicem8-list-badges` — List Badges (Read-only)

List badges with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-badges.md

### `servicem8-list-categories` — List Categories (Read-only)

List categories with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-categories.md

### `servicem8-list-companies` — List Companies (Read-only)

List companies (clients) with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-companies.md

### `servicem8-list-company-contacts` — List Company Contacts (Read-only)

List company contacts with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-company-contacts.md

### `servicem8-list-feedback` — List Feedback (Read-only)

List feedback with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-feedback.md

### `servicem8-list-job-activities` — List Job Activities (Read-only)

List job activities with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-job-activities.md

### `servicem8-list-job-contacts` — List Job Contacts (Read-only)

List job contacts with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-job-contacts.md

### `servicem8-list-job-materials` — List Job Materials (Read-only)

List job materials with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-job-materials.md

### `servicem8-list-job-payments` — List Job Payments (Read-only)

List job payments with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-job-payments.md

### `servicem8-list-jobs` — List Jobs (Read-only)

List jobs with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-jobs.md

### `servicem8-list-notes` — List Notes (Read-only)

List notes with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-notes.md

### `servicem8-list-queues` — List Queues (Read-only)

List job queues with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-queues.md

### `servicem8-list-staff` — List Staff (Read-only)

List staff with optional filters. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-staff.md

### `servicem8-list-webhook-subscriptions` — List Webhook Subscriptions (Read-only)

List webhook subscriptions. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/list-webhook-subscriptions.md

### `servicem8-make-api-request` — Make API Request (Write)

Send an authenticated ServiceM8 API request. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/make-api-request.md

### `servicem8-produce-invoice` — Produce Invoice (Write)

Generate a job invoice (PDF, DOCX, or JPG). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/produce-invoice.md

### `servicem8-produce-quote` — Produce Quote (Write)

Generate a job quote (PDF, DOCX, or JPG). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/produce-quote.md

### `servicem8-send-email` — Send Email (Write)

Send an email via the Messaging API. See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/send-email.md

### `servicem8-send-sms` — Send SMS (Write)

Send an SMS via the Messaging API (charges may apply). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/send-sms.md

### `servicem8-update-dboattachment` — Update Attachment (Write)

Update an attachment (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-dboattachment.md

### `servicem8-update-badge` — Update Badge (Write)

Update a badge (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-badge.md

### `servicem8-update-category` — Update Category (Write)

Update a category (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-category.md

### `servicem8-update-company` — Update Company (Write)

Update a company (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-company.md

### `servicem8-update-company-contact` — Update Company Contact (Write)

Update a company contact (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-company-contact.md

### `servicem8-update-job` — Update Job (Write)

Update a job (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-job.md

### `servicem8-update-job-activity` — Update Job Activity (Write)

Update a job activity (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-job-activity.md

### `servicem8-update-job-contact` — Update Job Contact (Write)

Update a job contact (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-job-contact.md

### `servicem8-update-job-material` — Update Job Material (Write)

Update a job material line (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-job-material.md

### `servicem8-update-job-payment` — Update Job Payment (Write)

Update a job payment (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-job-payment.md

### `servicem8-update-queue` — Update Job Queue (Write)

Update a job queue (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-queue.md

### `servicem8-update-note` — Update Note (Write)

Update a note (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-note.md

### `servicem8-update-staff` — Update Staff Member (Write)

Update a staff member (loads the record, merges your fields, then POSTs). See the documentation

Full schema: https://pipedream.com/apps/servicem8/actions/update-staff.md

## Triggers (5)

### `servicem8-new-client` — New Client (Instant) (Instant)

Emit new event when a new client is created.

Full schema: https://pipedream.com/apps/servicem8/triggers/new-client.md

### `servicem8-new-form-response` — New Form Response (Instant) (Instant)

Emit new event when a new Form Response is created.

Full schema: https://pipedream.com/apps/servicem8/triggers/new-form-response.md

### `servicem8-new-job` — New Job (Instant) (Instant)

Emit new event when a new job is created. By creating this trigger, any other Job triggers will stop working as ServiceM8 will replace any previous ones.

Full schema: https://pipedream.com/apps/servicem8/triggers/new-job.md

### `servicem8-job-completed` — New Job Completed (Instant) (Instant)

Emit new event when a job completes. By creating this trigger, any other Job triggers will stop working as ServiceM8 will replace any previous ones.

Full schema: https://pipedream.com/apps/servicem8/triggers/job-completed.md

### `servicem8-job-queued` — New Job Queued (Instant) (Instant)

Emit new event when a job is queued. By creating this trigger, any other Job triggers will stop working as ServiceM8 will replace any previous ones.

Full schema: https://pipedream.com/apps/servicem8/triggers/job-queued.md

---

- All apps: https://pipedream.com/apps — index: https://pipedream.com/llms.txt
- Pipedream docs for agents: https://pipedream.com/docs/llms.txt