Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

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, the "Revoke Invite" operation under the "Invite" resource allows users to revoke an existing invitation by specifying relevant identifiers.

Common scenarios for this node include automating user management workflows where invitations need to be revoked programmatically, such as when a user should no longer have access to a hub or system. For example, if an invited user’s email changes or if an invitation was sent by mistake, this operation can cancel that invite efficiently.

Properties

Name Meaning
User Id The unique identifier of the user whose invite is to be revoked.
Hub Id The unique identifier of the hub associated with the invite.
Email The email address of the invited user whose invitation is to be revoked.

All three properties are required to perform the revoke invite operation.

Output

The node outputs JSON data representing the result of the revoke invite operation. This typically includes confirmation of the revocation status or any error messages returned by the Ajax API. The exact structure depends on the API response but generally confirms whether the invite was successfully revoked.

There is no indication that the node outputs binary data.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • The node uses internal backend modules for state management, HTTP client communication, and operation resolution.
  • Proper configuration of the API authentication token within n8n credentials is necessary.

Troubleshooting

  • Missing or invalid credentials: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Invalid or missing input parameters: All three inputs (User Id, Hub Id, Email) are mandatory; missing any will likely cause errors.
  • API errors: If the Ajax API returns errors (e.g., invite not found, permission denied), these will be surfaced in the node output. Verify that the provided identifiers are correct and that the authenticated user has rights to revoke invites.
  • Network issues: Connectivity problems may cause request failures; check network settings and API availability.

Links and References

  • Refer to the official Ajax API documentation for detailed information about the invite revocation endpoint and expected request/response formats.
  • Consult n8n documentation on how to configure API credentials and use custom nodes.

Discussion