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 by the bundled version import). It provides a flexible interface to perform various operations on multiple resources related to Ajax systems. Specifically, for the resource Hub and operation Temporarily Do Not Inform User About Problems (referred to as muteSoundIndication in the properties), it allows users to mute certain sound indications on a hub device temporarily.

Common scenarios where this node is beneficial include:

  • Silencing alerts or notifications from a hub device when maintenance or troubleshooting is underway.
  • Preventing user disturbance from low battery or offline device sounds during specific periods.
  • Automating control over hub sound indications based on external triggers or workflows.

Practical example:

  • A security system administrator wants to mute the low battery warning sound on a particular hub device while replacing batteries, avoiding unnecessary alerts to users.

Properties

Name Meaning
User Id The identifier of the user for whom the sound indication muting command will be applied.
Hub Id The identifier of the hub device on which the sound indication muting will be performed.
Command The specific sound indication to mute. Options:
- MUTE_DEVICE_OFFLINE_SOUND_INDICATIONS: Mute sounds indicating the device is offline.
- MUTE_DEVICE_BATTERY_LOW_SOUND_INDICATIONS: Mute sounds indicating the device battery is low.

Output

The node outputs JSON data representing the result of the executed operation. This typically includes confirmation of the command execution status, any relevant response data from the Ajax API, and possibly updated state information about the hub device.

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

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the @digital-boss/n8n-designpatterns package for response-operation resolution and execution logic.
  • Uses internal backend modules for state management (State), HTTP client communication (HttpClient), and operation methods (operations).
  • The node expects proper configuration of the Ajax API credentials within n8n.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Invalid User Id or Hub Id: Verify that the provided identifiers correspond to existing entities in the Ajax system.
  • Unsupported command values: Confirm that the command property is set to one of the allowed options; otherwise, the API may reject the request.
  • Network issues: Check connectivity to the Ajax API endpoint; transient network failures can cause execution errors.
  • API version mismatch: The node uses a specific API version; if the backend changes, update the node or verify compatibility.

Links and References

Discussion