Octave icon

Octave

Interact with the Octave V2 API

Actions26

Overview

This node integrates with the Octave V2 API to create a new "Reference" resource. A Reference in this context represents detailed information associated with a product, including descriptive metadata and structured JSON data that captures how customers interact with and benefit from the product.

Typical use cases include:

  • Automating the creation of customer or product references within a CRM or marketing platform.
  • Enriching product records with qualitative insights and custom fields for sales enablement.
  • Managing structured reference data programmatically as part of a larger workflow involving product lifecycle or customer success management.

For example, a user might input a product identifier along with a narrative description and JSON-formatted data explaining how customers use the product and the benefits they derive, which the node then submits to the Octave API to create a new reference entry.

Properties

Name Meaning
Name The name/title of the reference being created. This is a required string field.
Product OID The unique identifier (OID) of the product to which this reference is linked. This is a required string field.
Description A textual description providing additional details about the reference. This is an optional multiline string field.
Data (JSON Format) A JSON object containing structured reference data. This includes fields such as explanations on how customers make money, use the product, benefit from it, email snippets, and any custom fields. The schema should follow the Octave API documentation.

Output

The node outputs an array of JSON objects representing the created reference(s). Each output item contains the response data returned by the Octave API after successfully creating the reference. The exact structure depends on the API but typically includes identifiers, timestamps, and the submitted reference data.

No binary data output is indicated.

Dependencies

  • Requires an active connection to the Octave V2 API via an API key credential configured in n8n.
  • The node depends on the Octave API endpoint responsible for creating references.
  • Proper network access and authentication credentials must be set up in n8n for successful API communication.

Troubleshooting

  • Common Issues:

    • Invalid or missing required fields (Name or Product OID) will cause the API call to fail.
    • Malformed JSON in the Data (JSON Format) property can lead to parsing errors or API rejection.
    • Authentication failures if the API key credential is not correctly configured or expired.
    • Network connectivity issues preventing access to the Octave API.

  • Error Messages:

    • Errors returned from the API are captured and included in the output when "Continue On Fail" is enabled.
    • Parsing errors on the API response body may occur if the response is not valid JSON.
    • Common resolution steps include verifying input data correctness, ensuring valid JSON format, checking API key validity, and confirming network connectivity.

Links and References

Discussion