Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with an Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Group" resource with the "Control Hub Arm State" operation. The primary function of this operation is to send a command to control the arm state of a security hub group—specifically to arm or disarm it.

Common scenarios for this node include:

  • Automating security system controls within a building or facility.
  • Integrating security hub management into broader workflows, such as arming the system when everyone leaves or disarming upon arrival.
  • Remote control of security groups via API calls triggered by other events or systems.

Practical example:

  • A user can provide their User Id, Hub Id, and Group Id along with a command ("ARM" or "DISARM") to remotely change the security state of a specific group within a hub.

Properties

Name Meaning
User Id Identifier of the user performing the operation; required to authenticate or specify context.
Hub Id Identifier of the security hub where the group resides; required to target the correct hub.
Group Id Identifier of the group within the hub whose arm state is to be controlled; required.
Command The action to perform on the group's arm state. Options: "ARM" to activate security, "DISARM" to deactivate.
Ignore Problems Boolean flag indicating whether to ignore any problems or errors during the operation.

Output

The node outputs JSON data representing the result of the arm/disarm command execution. This typically includes confirmation of the command sent, status updates, or error messages if the operation failed.

If the node supports binary data output, it would relate to any raw response or logs from the API call, but based on the provided code and properties, the main output is structured JSON reflecting the operation's outcome.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API service.
  • Depends on the external Ajax API backend services to perform the arm/disarm commands.
  • Uses internal helper classes for HTTP communication, state management, and operation resolution/execution.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Common issues:

    • Invalid or missing User Id, Hub Id, or Group Id leading to failed requests.
    • Incorrect command value (anything other than "ARM" or "DISARM") will not be accepted.
    • Network or authentication failures due to invalid API credentials.
    • If "Ignore Problems" is false, the node may throw errors on minor issues; setting it true might suppress these but could mask real problems.

  • Error messages:

    • Authentication errors indicate invalid or missing API credentials; verify and update the API key.
    • Resource not found errors suggest incorrect Hub Id or Group Id; double-check identifiers.
    • Command rejected errors mean the command parameter was invalid or the group cannot accept the command in its current state.

Resolving these usually involves verifying input parameters, ensuring valid credentials, and confirming the target hub/group exists and is reachable.

Links and References

Discussion