Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with a specific Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Object" resource with the operation "Get Object Notes By Object Id." The node fetches notes associated with a particular object identified by its ID within a specified company.

Common scenarios for this node include:

  • Retrieving detailed notes or comments linked to an object in a company's system.
  • Integrating object-related annotations into workflows for further processing or reporting.
  • Automating data retrieval from the Ajax API to keep systems synchronized.

For example, a user might use this node to get all notes attached to a customer record (object) in a CRM system by providing the company ID and the object ID.

Properties

Name Meaning
Company Id The unique identifier of the company to which the object belongs. Required for the query.
Object Id The unique identifier of the object whose notes are to be retrieved. Required for the query.

Output

The node outputs JSON data containing the notes related to the specified object. The exact structure depends on the Ajax API response but typically includes fields such as note content, timestamps, authorship, and possibly metadata about each note.

If the node supports binary data output, it would represent attachments or media related to the notes; however, based on the provided code and properties, the primary output is JSON-formatted note data.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external @digital-boss/n8n-designpatterns package for operation resolution and execution logic.
  • Uses internal backend modules for HTTP communication and state management.
  • The node expects proper configuration of the API credentials within n8n to function correctly.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key credential is correctly set up and has sufficient permissions to access the Ajax API.
  • Invalid Company Id or Object Id: Providing incorrect or non-existent IDs will result in empty responses or errors. Verify these values before running the node.
  • API connectivity issues: Network problems or API downtime can cause request failures. Check network connectivity and API status.
  • Unexpected API response: If the API changes or returns unexpected data, the node may fail or produce incomplete output. Confirm API version compatibility.

Common error messages might include authentication failures, resource not found, or rate limiting notices. Resolving them typically involves verifying credentials, input parameters, and API usage limits.

Links and References

Discussion