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 supports multiple resources and operations, including the "Network" resource with the operation "Get Balance request Status For Company." The node fetches the status of a balance request for a specified company within a given hub using an authentication token.

Common scenarios where this node is beneficial include:

  • Monitoring financial or credit balances related to companies in a networked system.
  • Automating status checks of balance requests as part of larger workflows involving company account management.
  • Integrating Ajax API data into n8n workflows for reporting or alerting purposes.

Practical example:

  • A user wants to check if a company's balance request has been approved or is still pending. By providing the company ID, hub ID, and a valid token, the node retrieves the current status, enabling automated decision-making or notifications.

Properties

Name Meaning
Company Id The unique identifier of the company whose balance request status is being queried.
Hub Id The identifier of the hub within which the company operates; used to scope the request.
Token An authentication token required to authorize the API request for balance status access.

Output

The node outputs JSON data representing the status of the balance request for the specified company. The exact structure depends on the Ajax API response but typically includes fields such as status indicators, timestamps, and possibly additional metadata about the balance request.

If the node supports binary data output, it would relate to any attachments or documents associated with the balance request status, but based on the provided code and properties, the primary output is JSON-formatted status information.

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 HTTP client communication and state management.
  • The node expects proper configuration of credentials within n8n to enable authorized API calls.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key/token is correctly configured and has sufficient permissions.
  • Incorrect Company Id or Hub Id: Verify that the IDs are accurate and correspond to existing entities in the Ajax system.
  • API connectivity issues: Network problems or incorrect endpoint configurations can cause failures; check network access and API availability.
  • Unexpected API responses: If the API changes or returns errors, the node might fail; review error messages and update node or credentials accordingly.

Common error messages may include authentication failures, resource not found, or invalid parameters. Resolving these typically involves verifying input values and credential validity.

Links and References

Discussion