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 the "Monitoring" resource with an operation to "Send Deletion Request With Security Company For Company." The node facilitates sending structured requests to the Ajax backend services, enabling automation of tasks such as managing monitoring companies and their associated data.

A common use case for this node is automating administrative or security-related workflows within a monitoring system. For example, when a company needs to be removed from monitoring services managed by a security company, this node can send the necessary deletion request programmatically, ensuring consistent and auditable operations without manual intervention.

Properties

Name Meaning
Company Id The unique identifier of the company for which the deletion request will be sent.
Hub Id The identifier of the hub related to the monitoring setup involved in the deletion.
Monitoring Company Id The identifier of the monitoring/security company that will receive the deletion request.

These properties are required inputs for the "Send Deletion Request With Security Company For Company" operation under the "Monitoring" resource.

Output

The node outputs JSON data representing the response from the Ajax API after executing the requested operation. This typically includes confirmation of the deletion request status or any relevant metadata returned by the backend service.

If the node supports binary data output, it would represent files or media related to the operation, but based on the provided code and context, the primary output is JSON structured data 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 handling resource-operation resolution and execution logic.
  • Utilizes internal modules for HTTP communication (HttpClient), state management (State), and operation methods (operationMethods).
  • The node expects proper configuration of the Ajax API credentials within n8n to function correctly.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key credential for the Ajax API is correctly configured and has sufficient permissions.
  • Incorrect property values: Verify that the Company Id, Hub Id, and Monitoring Company Id are valid and correspond to existing entities in the Ajax system.
  • API errors: If the Ajax API returns errors, check the error message for details such as rate limits, authorization failures, or malformed requests.
  • Network issues: Confirm that the n8n instance has network access to the Ajax API endpoints.

Common error messages might include authentication failures or resource not found errors. Resolving these typically involves checking credentials, input parameters, and network connectivity.

Links and References

Discussion