ServiceM8 icon

ServiceM8

ServiceM8 Node

Overview

This node integrates with the ServiceM8 platform, allowing users to manage various resources such as Clients, Jobs, Emails, and SMS messages. Specifically, the Add Note To Job operation enables users to add a note to an existing job within ServiceM8. This is useful for logging updates, comments, or additional information related to a job directly in the system.

Practical scenarios include:

  • Adding progress notes or status updates to a job.
  • Attaching important reminders or instructions for field technicians.
  • Logging communication or observations related to a job without altering the main job details.

Properties

Name Meaning
Fields A collection of fields required to add a note to a job:
- Note: The text content of the note to be added.
- Job UUID: The unique identifier of the job to which the note will be attached.

Output

The node outputs a JSON array where each element corresponds to the response from the ServiceM8 API after adding a note to a job. The structure of each JSON object reflects the created note resource returned by the API, typically including identifiers, timestamps, and the note content.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the ServiceM8 API via an API key credential configured in n8n.
  • The node uses HTTP POST requests to the ServiceM8 API endpoint corresponding to adding notes to jobs.
  • Proper permissions on the ServiceM8 account are necessary to create notes on jobs.

Troubleshooting

  • Common Issues:

    • Missing or invalid Job UUID: The operation requires a valid job identifier; ensure the UUID is correct and the job exists.
    • Empty note content: If no note text is provided, the API may reject the request or create an empty note.
    • Authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Error Messages:

    • "No fields to update were added": This error can occur if the note content is missing or empty. Provide a non-empty note.
    • API authentication failures: Check that the API key credential is valid and not expired.
    • Resource not found or invalid UUID: Verify the job UUID is accurate and the job exists in ServiceM8.

Links and References

Discussion