ServiceM8 icon

ServiceM8

ServiceM8 Node
Join our community

Actions11

Overview

This node integrates with the ServiceM8 platform, allowing users to manage various resources such as Clients, Jobs, Emails, and SMS messages. Specifically, for the Job - Delete operation, it enables the deletion of a job identified by its UUID from the ServiceM8 system.

Common scenarios where this node is beneficial include:

  • Automating cleanup of completed or canceled jobs in ServiceM8.
  • Integrating job management workflows where jobs are programmatically removed based on external triggers or conditions.
  • Maintaining data hygiene by removing obsolete job entries without manual intervention.

For example, after a job is marked as completed in an external system, this node can be used to delete the corresponding job in ServiceM8 automatically.

Properties

Name Meaning
UUID The unique identifier (UUID) of the job to delete. This string value specifies which job will be removed from ServiceM8.

Output

The node outputs a JSON array containing the response from the ServiceM8 API after attempting to delete the specified job(s). The structure typically reflects the API's confirmation or details about the deleted job.

If the API returns any binary data (not indicated in the code), it would represent associated files or attachments related to the job, but this node primarily handles JSON responses.

Dependencies

  • Requires an API key credential for authenticating requests to the ServiceM8 API.
  • The node depends on the ServiceM8 REST API endpoints to perform operations.
  • No additional environment variables or external services are explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Providing an invalid or empty UUID will cause the API request to fail.
    • Network connectivity problems may prevent successful communication with the ServiceM8 API.
    • Insufficient permissions or incorrect API credentials will result in authorization errors.

  • Error messages:

    • If no fields are provided when updating (not applicable for delete but relevant for other operations), the node throws an error indicating "No fields to update were added."
    • API errors returned from ServiceM8 (e.g., 404 Not Found if the job UUID does not exist) will be surfaced as node execution errors.

  • Resolution tips:

    • Ensure the UUID is correctly specified and corresponds to an existing job.
    • Verify that the API key credential has the necessary permissions.
    • Check network connectivity and ServiceM8 service status.
    • Use the node’s "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion