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 "Update Group Detailed Info" operation, the node updates detailed information about a group within a hub.

Typical use cases include:

  • Updating group metadata such as the group's name.
  • Configuring security-related settings like bulk arming/disarming capabilities.
  • Managing two-stage arming options.
  • Setting or updating image URLs associated with the group.

Practical example: A security system administrator can automate updating group details when organizational changes occur, such as renaming a group or changing its arming policies, directly from an n8n workflow.

Properties

Name Meaning
User Id Identifier of the user performing the update; required to authenticate or track the action.
Hub Id Identifier of the hub where the group exists; required to specify the context of the group.
Group Id Identifier of the group to be updated; required to target the correct group.
Group Name New name to assign to the group; required to update the group's display name.
Bulk Arm Involved Boolean flag indicating if bulk arming is enabled for this group.
Bulk Disarm Involved Boolean flag indicating if bulk disarming is enabled for this group.
Two Stage Arming Collection containing a single boolean property Enabled that toggles two-stage arming feature.
Image Urls Collection of URLs for images representing the group, with three sizes: Small, Medium, and Big.

Output

The node outputs JSON data representing the result of the update operation on the group. This typically includes confirmation of the updated fields and possibly the full updated group object as returned by the Ajax API.

If the node supports binary data output, it would relate to any media or image data associated with the group, but based on the provided code and properties, the output is primarily JSON structured data reflecting the updated group information.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external Ajax API service being available and reachable.
  • Uses internal helper classes for HTTP communication, state management, and operation resolution/execution.
  • The node expects proper configuration of credentials within n8n to access the Ajax API.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect or missing required parameters (e.g., User Id, Hub Id, Group Id) will lead to errors or failed updates.
    • Network connectivity problems may prevent successful API calls.
    • Providing invalid URLs in the Image Urls collection might cause validation errors on the API side.

  • Error messages:

    • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
    • Validation errors: Ensure all required fields are filled and formatted correctly.
    • HTTP errors (e.g., 404 Not Found): Confirm that the specified Hub Id and Group Id exist.
    • Timeout or network errors: Check network connectivity and API service status.

Links and References

Discussion