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 a "Monitoring" resource with an operation to "Send Deletion Request With Security Company." The node facilitates sending structured requests to the Ajax backend services, enabling automation of tasks such as user data deletion requests involving security companies.

A common use case for this node is automating compliance-related workflows where user data must be deleted upon request, coordinating with associated security companies. For example, when a user requests data removal, this node can send the necessary deletion request to the relevant security company managing that user's data.

Properties

Name Meaning
User Id The unique identifier of the user whose data deletion request is being sent.
Hub Id The identifier of the hub related to the user or security company context.
Company Id The identifier of the security company to which the deletion request will be sent.

These properties are required inputs when using the "Send Deletion Request With Security 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 error messages returned by the backend service.

If the node handles binary data, it would relate to attachments or files involved in the request, but based on the provided code and operation, the output is primarily JSON structured data.

Dependencies

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

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Incorrect or missing required input properties (User Id, Hub Id, Company Id) will result in validation errors.
    • Network connectivity issues may prevent successful API calls.

  • Error Messages:

    • Authentication errors typically indicate problems with the provided API key; verify and update credentials.
    • Validation errors suggest required parameters are not set or incorrectly formatted; ensure all required fields are filled.
    • API response errors should be checked against the Ajax API documentation for specific error codes and messages.

Links and References

Discussion