Octave icon

Octave

Interact with the Octave V2 API

Actions26

Overview

This node integrates with the Octave V2 API to perform asynchronous email generation tasks. Specifically, the "Async" resource with the "Generate Headless Emails" operation allows users to request the generation of emails in a headless (background) manner, where the actual email content creation happens asynchronously. The node sends input data to Octave and provides a callback URL that Octave will call once the email generation is complete.

This is useful in scenarios where email content needs to be generated dynamically based on user or company data but without blocking the workflow execution while waiting for the generation process. For example, marketing automation workflows can trigger personalized email generation and continue processing other tasks, receiving the generated emails later via webhook callbacks.

Properties

Name Meaning
Callback URL The URL that Octave will call back upon completion of the email generation. This should be a publicly accessible webhook endpoint to receive results.
Agent OID (Email Agent) The unique identifier (OID) of the email agent configured in Octave to use for asynchronous email generation. This selects which agent handles the request.
Email Generation Inputs (JSON Format) A JSON object containing inputs required for generating the email, such as recipient email, first name, company name, etc. This data customizes the generated email content.

Output

The node outputs an array of JSON objects representing the response from the Octave API after requesting asynchronous email generation. Each output item corresponds to one input item processed.

  • The json field contains the API response data, which typically includes identifiers or status information about the asynchronous generation request.
  • Since this operation is asynchronous, the actual generated emails are not returned immediately but delivered later via the specified callback URL.
  • No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the Octave V2 API using an API key credential configured in n8n.
  • The callback URL must be publicly accessible and able to receive HTTP requests from Octave.
  • Proper configuration of the email agent within Octave is necessary; the node requires the agent's OID to initiate generation.

Troubleshooting

  • Common Issues:

    • Invalid or unreachable callback URL: Ensure the URL is correct and publicly accessible.
    • Incorrect agent OID: Verify the agent identifier matches one configured in Octave.
    • Malformed JSON in email inputs: Validate the JSON structure to avoid parsing errors.
    • Network or authentication failures connecting to Octave API.

  • Error Messages:

    • API response errors may include details in the error message or context fields.
    • Parsing errors if the API response body is malformed or unexpected.
    • Authentication errors if the API key credential is missing or invalid.

  • Resolutions:

    • Double-check all input parameters for correctness.
    • Confirm network connectivity and API credentials.
    • Use try/catch blocks or enable "Continue On Fail" in n8n to handle errors gracefully.

Links and References

Discussion