ServiceM8 icon

ServiceM8

ServiceM8 Node

Overview

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

Practical scenarios include:

  • Adding internal notes or instructions to a job for team members.
  • Recording follow-up actions or observations related to a job.
  • Attaching reminders or alerts that require action completion tracking.

Properties

Name Meaning
Note The textual content of the note to be added to the job.
Job UUID The unique identifier of the job to which the note will be attached.
Action Required A string describing any required action related to the note (optional).
Action Completed By Staff UUID The unique identifier of the staff member who completed the action (optional).

Output

The output is a JSON array containing the response from the ServiceM8 API after adding the note. Each item corresponds to the created note object with its details as returned by the API.

If the operation succeeds, the output JSON typically includes fields confirming the note's creation, such as its ID, content, related job UUID, timestamps, and status flags.

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 requests to interact with the ServiceM8 REST API endpoints.
  • Proper permissions on the ServiceM8 account are necessary to add notes to jobs.

Troubleshooting

  • Missing Job UUID: If the Job UUID is not provided or invalid, the API call will fail. Ensure the correct job identifier is supplied.
  • Empty Note Field: Submitting an empty note might result in an error or no action. Always provide meaningful note content.
  • API Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network Issues: Connectivity problems can cause request failures; check network access to the ServiceM8 API.
  • Error Messages: The node throws errors if required fields are missing or if the API returns an error. Review the error message details for guidance.

Links and References

Discussion