avanta icon

avanta

Consume avanta API

Actions8

Overview

This node acts as a generic interface to the Avanta API, allowing users to interact with various resources such as Company, CompanyAddress, CompanyUser, and SalesOrg. It is designed to facilitate operations on these resources by routing requests through a centralized router function. This node is beneficial in scenarios where automation workflows need to integrate with Avanta's services for managing company data, addresses, users, or sales organizations.

For example, a user might use this node to create a new company record, update an existing user's details, or retrieve sales organization information within an automated workflow.

Properties

Name Meaning
Return to Webhook Boolean flag indicating whether the node should return its response directly to a webhook. Requires a subsequent 'Respond to Webhook' node to handle the response. Default is false.

Output

The node outputs JSON data corresponding to the result of the invoked Avanta API operation. The structure of the output depends on the specific resource and operation performed (e.g., company creation, user retrieval). The output typically contains the API response data mapped into JSON format.

If binary data were involved, it would be summarized here; however, based on the provided code and properties, this node does not handle binary output.

Dependencies

  • Requires an API key credential for authenticating with the Avanta API.
  • Depends on internal action modules (router, company, companyAddress, companyUser, salesOrg) which implement the logic for each resource.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Missing or invalid API credentials: Ensure that a valid API key credential is configured in n8n for this node to authenticate successfully.
  • No 'Respond to Webhook' node after enabling 'Return to Webhook': If the "Return to Webhook" property is set to true, a subsequent 'Respond to Webhook' node must be present to properly send back the response; otherwise, the workflow may hang or fail.
  • Incorrect resource or operation selection: Selecting unsupported combinations may lead to errors or empty responses. Verify that the chosen resource and operation are supported by the node.
  • API errors from Avanta: Errors returned by the Avanta API (e.g., rate limits, invalid parameters) will propagate through this node. Review error messages for guidance and ensure request parameters are correct.

Links and References

Discussion