ServiceM8 icon

ServiceM8

ServiceM8 Node

Overview

This node integrates with the ServiceM8 platform, allowing users to manage various resources such as jobs, clients, emails, SMS, and searches. Specifically, for the Job - Get operation, it retrieves detailed information about a specific job identified by its UUID. This is useful in scenarios where you want to fetch job details for processing, reporting, or automation workflows.

Practical examples:

  • Automatically retrieving job details when a new job is created to trigger follow-up actions.
  • Fetching job status or metadata before updating or sending notifications.
  • Integrating job data into other systems like CRMs or dashboards.

Properties

Name Meaning
UUID The unique identifier of the job to retrieve. This string value specifies which job's details will be fetched from ServiceM8.

Output

The node outputs an array of JSON objects representing the job(s) retrieved from ServiceM8. For the "Get" operation on a Job resource, the output JSON contains detailed fields describing the job, such as its identifiers, status, client info, scheduling, and other metadata as provided by the ServiceM8 API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the ServiceM8 API using an API key credential configured in n8n.
  • The node depends on the serviceM8ApiRequest helper function to make authenticated HTTP requests to the ServiceM8 REST API.
  • Network access to https://api.servicem8.com is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or empty UUID will result in failure to retrieve the job.
    • Network connectivity problems or incorrect API credentials can cause authentication errors.
    • If the job UUID does not exist, the API may return an error or empty response.
  • Error messages:

    • "No search query was provided." — Not applicable for the "Get" operation but relevant for search operations; ensure required parameters are set.
    • "No fields to update were added" — Relevant for update operations; ensure at least one field is specified.
    • General API errors will be thrown if the request fails; check credentials and UUID validity.
  • To resolve errors:

    • Verify the UUID input is correct and non-empty.
    • Confirm API credentials are valid and have sufficient permissions.
    • Check network connectivity and ServiceM8 service status.

Links and References

Discussion