FieldProxy icon

FieldProxy

Interacts with the FieldProxy API

Overview

The node named "FieldProxy" interacts with the FieldProxy API to perform various operations related to work orders, messages, and custom fields. Specifically, the "Create Work Order Message" operation allows users to add a new message to an existing work order by specifying the work order's ID and the message content.

This node is beneficial in scenarios where you need to programmatically update or annotate work orders with additional information, comments, or instructions. For example, a service management workflow could automatically append status updates or technician notes to a work order as it progresses through different stages.

Properties

Name Meaning
Work Order ID The unique identifier of the work order to which the message will be added.
Message The text content of the message to create and attach to the specified work order.

Output

The node outputs JSON data representing the result of the "Create Work Order Message" operation. This typically includes details about the newly created message such as its ID, content, timestamp, and possibly metadata related to the work order. The exact structure depends on the FieldProxy API response but generally confirms successful creation and provides reference information for the message.

There is no indication that this node outputs binary data.

Dependencies

  • Requires an API key credential for authenticating with the FieldProxy API.
  • Needs the base URL of the FieldProxy API configured in the credentials.
  • The node uses HTTP requests with JSON payloads and expects JSON responses.

Troubleshooting

  • Common issues:

    • Invalid or missing Work Order ID: Ensure the provided ID corresponds to an existing work order.
    • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
    • Network or connectivity problems: Confirm that the base URL is correct and accessible from the n8n environment.
  • Error messages:

    • Unauthorized or 401 errors usually indicate invalid or expired API credentials.
    • 404 errors may mean the specified work order does not exist.
    • Validation errors might occur if the message content is empty or exceeds allowed length.

To resolve these, double-check input values, credentials, and network settings.

Links and References

Discussion