ServiceM8

ServiceM8 Webhooks API

Object and event webhook subscriptions.

Documentation GitHub OpenAPI

Operations 4

GET /webhook_subscriptions List webhook subscriptions #

POST /webhook_subscriptions Create or update an object webhook subscription #

GET /webhook_subscriptions/{uuid} Retrieve a webhook subscription #

DELETE /webhook_subscriptions/{uuid} Delete a webhook subscription #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/servicem8-webhooks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: ServiceM8 REST Webhooks API
  description: ServiceM8 is field service and job management software for trade and home-service businesses.
  version: '1.0'
  contact:
    name: ServiceM8 Developer
    url: https://developer.servicem8.com
  license:
    name: ServiceM8 API Terms
    url: https://www.servicem8.com/terms
servers:
- url: https://api.servicem8.com/api_1.0
  description: ServiceM8 REST API (object endpoints)
- url: https://api.servicem8.com
  description: ServiceM8 webhook subscription endpoints
security:
- apiKeyAuth: []
- oauth2: []
tags:
- name: Webhooks
  description: Object and event webhook subscriptions.
paths:
  /webhook_subscriptions:
    servers:
    - url: https://api.servicem8.com
    get:
      operationId: listWebhookSubscriptions
      tags:
      - Webhooks
      summary: List webhook subscriptions
      responses:
        '200':
          description: An array of webhook subscription records.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebhookSubscription'
    post:
      operationId: createWebhookSubscription
      tags:
      - Webhooks
      summary: Create or update an object webhook subscription
      description: Subscribe to changes on specific fields of an object type. When a subscribed field changes, ServiceM8 POSTs the object type, changed fields, uuid, and a resource_url to your callback URL.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookSubscription'
      responses:
        '200':
          description: Webhook subscription created or updated.
  /webhook_subscriptions/{uuid}:
    servers:
    - url: https://api.servicem8.com
    parameters:
    - $ref: '#/components/parameters/Uuid'
    get:
      operationId: getWebhookSubscription
      tags:
      - Webhooks
      summary: Retrieve a webhook subscription
      responses:
        '200':
          description: A single webhook subscription record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscription'
    delete:
      operationId: deleteWebhookSubscription
      tags:
      - Webhooks
      summary: Delete a webhook subscription
      responses:
        '200':
          description: Webhook subscription deleted.
components:
  schemas:
    WebhookSubscription:
      type: object
      properties:
        uuid:
          type: string
        object:
          type: string
          description: The object type to watch, e.g. job or company.
        fields:
          type: string
          description: Comma-separated list of fields to subscribe to.
        callback_url:
          type: string
        unique_id:
          type: string
          description: Optional identifier for grouping subscriptions.
  parameters:
    Uuid:
      name: uuid
      in: path
      required: true
      description: The UUID of the record.
      schema:
        type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for private/single-account integrations.
    oauth2:
      type: oauth2
      description: OAuth 2.0 for public add-ons. Access tokens expire after 3600 seconds.
      flows:
        authorizationCode:
          authorizationUrl: https://go.servicem8.com/oauth/authorize
          tokenUrl: https://go.servicem8.com/oauth/access_token
          refreshUrl: https://go.servicem8.com/oauth/access_token
          scopes:
            manage_jobs: Read and write jobs
            read_jobs: Read jobs
            manage_customers: Read and write customers (companies)
            read_customers: Read customers (companies)
            manage_staff: Read and write staff
            read_staff: Read staff
            manage_inventory: Read and write materials and inventory
            manage_schedule: Read and write scheduling and job activities
            publish_sms: Send SMS messages
            publish_email: Send email messages
            vendor_logo: Read vendor account information