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 provides a flexible interface to perform various operations on multiple resources within the Ajax ecosystem. In particular, for the resource "Installation" and operation "Send Request For Add On Installation Hub To Company," it allows users to send a request to associate or install an add-on hub to a specified company.

Common scenarios where this node is beneficial include automating the management of installations in a company's Ajax system, such as programmatically linking hubs to companies without manual intervention. This can be useful in large-scale deployments or integrations where installation workflows need to be triggered from other systems or processes.

Example use case:

  • Automatically sending a request to add a new hub device to a company's installation setup when onboarding new hardware.

Properties

Name Meaning
Company Id The unique identifier of the company to which the add-on installation hub will be sent.
Hub Id The unique identifier of the hub that is requested to be installed or linked to the company.

These properties are required inputs for the "Send Request For Add On Installation Hub To Company" operation under the "Installation" resource.

Output

The node outputs JSON data representing the response from the Ajax API after attempting to send the request for add-on installation. The exact structure depends on the API's response but typically includes status information, confirmation details, or error messages related to the request.

If the node supports binary data output, it would represent any files or attachments returned by the API; however, based on the provided code and context, the primary output is JSON.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the @digital-boss/n8n-designpatterns package for handling resource-operation resolution and execution logic.
  • Uses internal modules for HTTP client 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 configured and has sufficient permissions.
  • Invalid Company Id or Hub Id: Verify that the IDs provided exist and are correct; otherwise, the API may return errors indicating not found or unauthorized access.
  • Network issues: Check connectivity to the Ajax API endpoint.
  • API version mismatch: Confirm that the API version used by the node matches the server-side API version to avoid incompatibility errors.
  • Error messages from API: These will be passed through in the JSON output; review them to understand issues like quota limits, invalid parameters, or server errors.

Links and References

Discussion