Aigency icon

Aigency

Interact with Aigency API

Overview

This node, named "Aigency," allows interaction with the Aigency API through various operations. It is designed to perform a wide range of actions such as managing messages, subscriptions, capabilities, user sessions, and retrieving different types of data related to users and their activities.

The specific operation "Throw Error" is one of many supported operations. When selected, it triggers an error response from the API, which can be useful for testing error handling workflows or simulating failure scenarios within an automation.

Practical examples:

  • Use the "Throw Error" operation to test how your workflow handles API errors without affecting real data.
  • Combine other operations like "Add Message" or "Get Messages" to automate communication or data retrieval tasks.
  • Manage user subscriptions and capabilities dynamically based on external events.

Properties

Name Meaning
User ID The numeric identifier of the user for whom the operation is performed. Required field.

Note: For the "Throw Error" operation, only the "User ID" property is required and relevant.

Output

The output of the node is a JSON object containing either:

  • A result field with the successful response data from the API (not applicable for "Throw Error" since it triggers an error).
  • An error field containing details about the error returned by the API when the "Throw Error" operation is executed.

The output structure looks like this in case of error:

{
  "error": {
    "code": <number>,
    "message": "<error message>",
    "data": { ... }
  }
}

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential and API URL for authenticating requests to the Aigency API.
  • These credentials can be configured in the n8n UI or provided via environment variables AIGENCY_API_KEY and AIGENCY_API_URL.
  • The node uses HTTP POST requests with JSON-RPC 2.0 format to communicate with the API.

Troubleshooting

  • Missing Credentials: If neither credentials nor environment variables are set, the node will throw an error indicating missing credentials. Ensure you configure the API key and URL properly.
  • API Errors: The "Throw Error" operation intentionally triggers an error response. This is expected behavior for testing purposes.
  • Network Issues: If the API endpoint is unreachable or returns invalid responses, the node will throw an error. Verify network connectivity and API availability.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if an error occurs, returning error details in the output JSON.

Links and References

Discussion