ServiceM8 plugin

Use ServiceM8 through Corsair: one client, typed API calls. The ServiceM8 API supports API keys for private applications and OAuth 2.0 for public applications. Set authType: 'oauth_2' when providing an OAuth access token. Custom-field deletion requires OAuth and is not available with private API keys. List operations accept $filter and cursor; start paginating with cursor: '-1', then use the nextCursor returned by each page. Create operations return the API result and recordUuid from the x-record-uuid response header. Notes use /note.json for list/create and /dbonote/{uuid}.json for individual operations as documented by ServiceM8. Webhook subscriptions, inbound callbacks, and additional resources outside these 28 operations are excluded. A 429 for the per-minute limit is retried up to 3 times; the daily limit and other errors are not retried. Creating jobs can incur ServiceM8 account charges, so jobs.create is marked destructive. ServiceM8’s authentication guide lists manage_templates but the document-template endpoint reference specifies read_templates; its OAuth security scheme lists both. Confirm the permissions granted to your application if template reads fail. The default OAuth connection requests every scope the operations need, including read_forms, read_job_payments and manage_job_payments. Assets and forms need their add-ons activated on the ServiceM8 account; otherwise ServiceM8 answers 400 “requires addon activation”. What you get:

28 typed API operations

Setup

Install

npm install corsair @corsair-dev/servicem8 better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/servicem8 better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/servicem8 better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/servicem8 better-sqlite3
bun add --dev @types/better-sqlite3

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { servicem8 } from '@corsair-dev/servicem8';

export const corsair = createCorsair({
	plugins: [
		servicem8(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

API Key (Recommended)
OAuth 2.0

Store the ServiceM8 API key before the first call: pnpm corsair setup --plugin=servicem8 --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.

servicem8()

More: API Key

Open hub.corsair.dev, navigate to your project, and enter the client ID and client secret from your ServiceM8 OAuth app.

servicem8({
	authType: 'oauth_2',
})

More: OAuth 2.0

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'servicem8',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

jobs.list

const tenant = corsair.withTenant('acme');
await tenant.servicem8.api.jobs.list({ cursor: '-1' });

notes.create

const tenant = corsair.withTenant('acme');
await tenant.servicem8.api.notes.create({ related_object: 'job', related_object_uuid: '550e8400-e29b-41d4-a716-446655440000', note: 'Example' });

See the full list on the API page.

What’s next

API reference

Every servicem8.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

Overview

Plugins