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 system. In particular, for the resource "Installation" and operation "Invite Installation Company By Company," it allows users to invite an installation company associated with a given company and hub.

Common scenarios where this node is beneficial include automating workflows that involve managing installations, inviting companies to participate in installation processes, or integrating Ajax's installation management features into broader automation pipelines.

For example, a user might use this node to programmatically send invitations to installation companies linked to a particular company and hub, streamlining coordination without manual intervention.

Properties

Name Meaning
Company Id The unique identifier of the company to which the installation company invitation applies.
Hub Id The unique identifier of the hub related to the installation context.
Company Hex Id A hexadecimal string identifier representing the company, used for precise identification in the invitation process.

Output

The node outputs JSON data representing the result of the invitation operation. This typically includes confirmation details such as success status, any returned identifiers, or error messages if the invitation failed.

If the node supports binary data output, it would relate to attachments or files associated with the invitation process, but based on the provided code and properties, the primary output is structured JSON data reflecting the API response.

Dependencies

  • Requires an API key credential to authenticate requests against the Ajax API.
  • Depends on internal modules handling HTTP communication, state management, and operation resolution/execution.
  • The node uses a bundled HTTP client to communicate with the backend Ajax API.
  • No additional external services beyond the Ajax API are required.

Troubleshooting

  • Authentication Errors: If the API key credential is missing or invalid, the node will fail to authenticate. Ensure the correct API key is configured in the node credentials.
  • Invalid Property Values: Providing incorrect or empty values for required properties like Company Id, Hub Id, or Company Hex Id will cause the operation to fail. Double-check these inputs.
  • API Response Errors: Network issues or server-side errors from the Ajax API may result in error responses. Review the error message returned in the node output for guidance.
  • Version Mismatch: Using an outdated version of the node or API may cause incompatibilities. Verify that the node version matches the expected API version.

Links and References

Discussion