Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with a specific Ajax API (version indicated in the code). It supports multiple resources and operations, including managing invites. The particular operation "Get Hub Invites For Company" retrieves invite information related to a specified company and hub within the Ajax system.

Common scenarios for this node include:

  • Fetching all active or pending invites for a company's hub to manage user access.
  • Integrating invite data into workflows that automate onboarding or monitoring of invited users.
  • Synchronizing invite status with other systems or databases.

For example, a security administrator could use this node to pull all current invites for a company's hub to audit who has access or to trigger notifications when new invites are created.

Properties

Name Meaning
Company Id The unique identifier of the company whose hub invites you want to retrieve.
Hub Id The unique identifier of the hub within the company for which to get the invites.

Both properties are required string inputs that specify the scope of the invite retrieval.

Output

The node outputs JSON data representing the list of invites associated with the specified company and hub. Each invite entry typically includes details such as invitee information, invite status, creation date, and possibly expiration or usage metadata.

If the node supports binary data output, it would relate to any attachments or files associated with invites, but based on the provided code and context, the primary output is structured JSON data about invites.

Dependencies

  • Requires an API key credential to authenticate with the Ajax API service.
  • Depends on internal modules handling HTTP requests, state management, and operation resolution/execution.
  • The node expects proper configuration of the API credentials within n8n to successfully connect and fetch data.

Troubleshooting

  • Missing or invalid credentials: Ensure the API key credential is correctly set up and has sufficient permissions to access invite data.
  • Invalid Company Id or Hub Id: Verify that the provided identifiers exist and are correct; otherwise, the API may return errors or empty results.
  • Network or API errors: Check network connectivity and API availability. Common error messages might indicate timeouts or unauthorized access.
  • Operation not supported: If the resource or operation parameters are incorrect or unsupported, the node may fail to resolve the operation method.

To resolve these issues:

  • Double-check input property values.
  • Confirm API credentials and permissions.
  • Review API documentation for correct usage and limits.

Links and References

Discussion