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 progress notes or status updates to a job.
  • Recording action items or follow-ups required for a job.
  • Attaching internal comments or instructions for team members working on the job.

Properties

Name Meaning
Fields A collection of fields to define the note details:
- Note The text 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 (Optional) Specifies any action required related to the note.
- Action Completed By Staff UUID (Optional) Identifier of the staff member who completed the action.

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 typically includes confirmation details about the created note, such as its ID, timestamps, and associated job information.

If binary data were involved (not in this operation), it would represent files or attachments related to the job note, but this operation deals only with JSON data.

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

Troubleshooting

  • Missing Job UUID: If the "Job UUID" field is empty or incorrect, the API call will fail because the note cannot be linked to a job. Ensure the correct job identifier is provided.
  • Empty Note Content: While not always mandatory, submitting an empty note might result in no meaningful update or an error depending on API validation.
  • API Authentication Errors: If the API key or credentials are invalid or expired, the node will throw authentication errors. Verify and update credentials in n8n.
  • Network Issues: Connectivity problems can cause request failures. Check network access and ServiceM8 service status.
  • Error Messages: The node throws detailed errors if the API returns failure responses. Review the error message for hints, such as permission issues or malformed requests.

Links and References

Discussion