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 bundled code). It supports multiple resources and operations, including the "Hub" resource with the operation "Get Hub Two-Stage Arming Operation Status." The node fetches the status of a two-stage arming operation on an Ajax security hub, which is useful in scenarios where enhanced security measures require a two-step confirmation to arm the system.

Typical use cases include:

  • Monitoring the progress or result of a two-stage arming command sent to a security hub.
  • Integrating Ajax security system status checks into automation workflows.
  • Triggering subsequent actions based on the arming status, such as notifications or logging.

Properties

Name Meaning
Token Token received from the arm command if two-stage arming is enabled. Required for this operation.
User Id Identifier of the user who initiated the arming operation. Required.
Hub Id Identifier of the hub device for which the two-stage arming status is requested. Required.

These properties must be provided when selecting the "Hub" resource and the "Get Hub Two-Stage Arming Operation Status" operation.

Output

The node outputs JSON data representing the status of the two-stage arming operation for the specified hub. This typically includes details about whether the arming process is pending, completed, or failed, along with any relevant metadata returned by the Ajax API.

If the node supports binary data output, it would relate to any binary content returned by the Ajax API, but based on the provided code and context, the primary output is structured JSON data reflecting the operation status.

Dependencies

  • Requires an API key credential to authenticate with the Ajax API.
  • Depends on the @digital-boss/n8n-designpatterns package for response and operation handling.
  • Uses internal backend modules for state management, HTTP client communication, and operation execution.
  • The node expects proper configuration of the Ajax API credentials within n8n.

Troubleshooting

  • Missing or invalid token: Since the token is required for two-stage arming status retrieval, ensure that the token parameter is correctly passed from the initial arm command response.
  • Invalid User Id or Hub Id: Verify that the user and hub identifiers are correct and correspond to existing entities in the Ajax system.
  • Authentication errors: Check that the API key credential is valid and has sufficient permissions.
  • API connectivity issues: Network problems or incorrect endpoint configurations can cause failures; verify network access and credential settings.
  • Unexpected API responses: If the Ajax API changes or returns unexpected data, the node might fail; updating the node or checking API documentation may help.

Links and References

Discussion