Aigency icon

Aigency

Interact with Aigency API

Overview

The node interacts with the Aigency API, providing various operations related to user data and messaging capabilities. Specifically, the Get Reward Amount operation retrieves the reward amount associated with a given user ID.

This node is useful in scenarios where you want to programmatically access or manage user-related information, messages, subscriptions, capabilities, and rewards within the Aigency platform. For example, you might use it to fetch a user's current reward balance to display in a dashboard or trigger workflows based on reward thresholds.

Properties

Name Meaning
User ID The unique numeric identifier of the user for whom the reward amount will be retrieved.

Output

The output JSON contains the result returned by the Aigency API for the "Get Reward Amount" operation. It typically includes the reward amount details associated with the specified user ID.

Example structure (simplified):

{
  "rewardAmount": 123.45,
  "currency": "USD"
}

If an error occurs, the output JSON will contain an error field describing the issue.

The node does not output binary data.

Dependencies

  • Requires an API key credential and API URL for authenticating requests to the Aigency API.
  • These credentials can be configured either in the n8n credentials interface or via environment variables:
    • AIGENCY_API_KEY
    • AIGENCY_API_URL

Troubleshooting

  • Missing Credentials: If neither credentials nor environment variables are set, the node throws an error indicating missing credentials. Ensure that the API key and URL are properly configured.
  • API Errors: If the API returns an error (e.g., invalid user ID, network issues), the node either throws an error or outputs the error message depending on the "Continue On Fail" setting.
  • Invalid User ID: Providing a non-numeric or missing user ID will likely cause the API call to fail.
  • Network Issues: Connectivity problems to the Aigency API endpoint will result in errors; verify network access and API availability.

Links and References

Discussion