Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

Overview

This node allows sending specific commands to a device within a company context. It is designed for scenarios where you need to remotely control or test devices managed by a company, such as security sensors, alarms, or smart home devices. For example, you can use it to start or stop connection tests, mute alarms, switch devices on or off, trigger sensor tests, or reset passwords.

Practical examples:

  • Remotely muting a security alarm device in a building.
  • Starting a calibration process on a fire protection sensor.
  • Triggering a photo capture on a motion camera device.
  • Enabling or disabling bypass modes on various security devices.

Properties

Name Meaning
Company Id The unique identifier of the company owning the device.
Hub Id The identifier of the hub to which the device is connected.
Device Id The unique identifier of the target device to which the command will be sent.
Command The command to send to the device. Options include: CONNECTION_TEST_START, MUTE, SWITCH_ON, etc.
Device Type The type/model of the device receiving the command. Examples: DoorProtect, MotionProtect, Keypad, etc.

Output

The node outputs JSON data representing the result of the command execution on the device. This typically includes confirmation of the command being accepted or any response data returned by the device or backend service. The exact structure depends on the backend API's response but generally confirms success or failure and may include status details.

If the node supports binary data output (not explicitly shown here), it would represent device-generated media like photos or logs.

Dependencies

  • Requires an API key credential for authenticating with the Ajax backend service.
  • Depends on the Ajax backend API to send commands and receive responses.
  • Uses internal HTTP client and operation resolver utilities from bundled dependencies.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Invalid Credentials: If the API key is missing or invalid, the node will fail to authenticate. Ensure the correct API key credential is configured.
  • Incorrect IDs: Providing wrong Company Id, Hub Id, or Device Id will cause the command to fail. Verify these identifiers are accurate.
  • Unsupported Commands or Device Types: Sending a command not supported by the specified device type may result in errors or no action. Confirm compatibility.
  • Network Issues: Connectivity problems with the backend API can cause timeouts or failures. Check network access and API availability.
  • Error Messages: Common error messages might indicate authorization failure, resource not found, or invalid parameters. Review the message details and adjust inputs accordingly.

Links and References

  • Ajax API Documentation (example placeholder, replace with actual if available)
  • Device command reference and supported device types should be consulted in the official Ajax system documentation.

Discussion