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 RRU Codes. Specifically, for the "RRU Code" resource and the "Create New RRU Code" operation, this node allows users to create a new Rapid Response Unit (RRU) code by providing necessary details such as company ID, hub ID, name, and a password code.

Common scenarios where this node is beneficial include:

  • Automating the creation of access codes for security systems.
  • Integrating Ajax security hardware management into workflows.
  • Managing user or device credentials programmatically within a security infrastructure.

Practical example:

  • A security administrator wants to automatically generate and assign new RRU codes to hubs when onboarding new sites, streamlining the process without manual entry.

Properties

Name Meaning
Company Id Identifier of the company under which the RRU code will be created.
Hub Id Identifier of the hub associated with the RRU code.
Name The display name for the new RRU code.
Password A 4-6 digit numeric code used as the password for the RRU code.
Additional Fields Optional extra parameters:
- Index: Numeric index value.
- Post Alarm Activation Delay Seconds: Delay time after alarm activation.
- Action Period Minutes: Duration of action period in minutes.

Output

The node outputs JSON data representing the result of the "Create New RRU Code" operation. This typically includes details about the newly created RRU code such as its identifiers, status, and any metadata returned by the Ajax API.

If binary data were involved (not indicated here), it would represent related files or attachments, but this node focuses on JSON responses from the API.

Dependencies

  • Requires an active connection to the Ajax API via an API key credential configured in n8n.
  • Uses internal helper classes for HTTP communication, state management, and operation resolution.
  • No additional external dependencies beyond the Ajax API and the provided credential.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key credential for the Ajax API is correctly set up and has sufficient permissions.
  • Invalid input values: Check that required fields like Company Id, Hub Id, Name, and Password are provided and valid. Password must be 4-6 digits.
  • API errors: If the Ajax API returns errors (e.g., duplicate codes, invalid hub), verify the input parameters and consult the API documentation.
  • Network issues: Confirm network connectivity to the Ajax API endpoint.

Common error messages might include authentication failures, validation errors on input fields, or server-side errors from the Ajax API. Resolving these usually involves verifying credentials, input correctness, and API availability.

Links and References

Discussion