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 groups. Specifically, for the "Group" resource and the "Create New Group" operation, it allows users to create a new group within a specified hub and user context.

Common scenarios where this node is beneficial include:

  • Automating the creation of user groups in an Ajax security system.
  • Integrating group management into workflows that provision or organize devices and users.
  • Streamlining administrative tasks by programmatically managing groups without manual intervention.

For example, a security administrator could use this node to automatically create groups for different departments or locations when onboarding new users or hubs.

Properties

Name Meaning
User Id The identifier of the user who will own or be associated with the new group.
Hub Id The identifier of the hub under which the new group will be created.
Group Name The name assigned to the new group being created.

Output

The node outputs JSON data representing the result of the group creation operation. This typically includes details about the newly created group such as its unique identifier, name, and possibly metadata confirming successful creation.

If the node supports binary data output, it would relate to any files or media returned by the Ajax API, but based on the provided code and properties, the primary output is structured JSON data reflecting the API response.

Dependencies

  • Requires an active connection to the Ajax API via an API key credential configured in n8n.
  • Depends on internal modules handling HTTP requests, state management, and operation resolution/execution.
  • The node uses a bundled HTTP client to communicate with the Ajax backend service.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Invalid parameters: Verify that User Id, Hub Id, and Group Name are correctly provided and valid according to the Ajax API requirements.
  • Network issues: Check connectivity to the Ajax API endpoint; timeouts or unreachable errors may occur if network conditions are poor.
  • API errors: If the Ajax API returns errors (e.g., group name already exists), review the error message and adjust input accordingly.

Links and References

Discussion