AjaxInstall

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). It supports multiple resources and operations, including managing invites. Specifically, for the "Invite" resource and the "Revoke Invite For Company" operation, the node allows users to revoke an existing invitation sent to a user by specifying the company, hub, and email address associated with that invite.

Common scenarios where this node is beneficial include:

• Managing user access and invitations within a company's security or monitoring system.
• Automating the revocation of invites when a user should no longer have access.
• Integrating with workflows that require dynamic control over user invitations based on business logic.

Practical example:

• A security administrator wants to automatically revoke an invite sent to a contractor after their contract ends. Using this node, they can specify the company ID, hub ID, and the contractor's email to revoke the invite programmatically.

Properties

Output

The node outputs JSON data representing the result of the revoke invite operation. This typically includes confirmation of the revocation status or any relevant response from the Ajax API indicating success or failure.

If the node supports binary data output, it would relate to any files or attachments returned by the API, but based on the provided code and context, the primary output is JSON structured data about the operation result.

Dependencies

• Requires an API key credential for authenticating with the Ajax API.
• Depends on the external Ajax API service being accessible and properly configured.
• Uses internal helper classes for HTTP communication, state management, and operation resolution/execution.
• No additional environment variables are explicitly required beyond the API authentication credential.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will cause authentication failures.
  • Incorrect companyId, hubId, or email values may lead to errors or no action taken if the invite does not exist.
  • Network connectivity problems can prevent successful API calls.

• Error messages:

  • Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
  • "Invite not found" or similar errors suggest the specified invite details do not match any existing records; double-check input parameters.
  • Timeout or connection errors imply network issues; ensure the API endpoint is reachable.

Links and References

• Ajax API Documentation (general reference for the Ajax API)
• n8n documentation on creating custom nodes for further customization guidance