Octave icon

Octave

Interact with the Octave V2 API

Actions26

Overview

The "Create Playbook" operation in this node allows users to create a new playbook associated with a specific product within the Octave V2 API ecosystem. A playbook here represents a structured set of insights, contexts, personas, and use cases designed to guide sales, marketing, or other strategic activities.

This operation is beneficial for teams looking to programmatically manage their playbooks, automate the creation process, and integrate playbook management into larger workflows. For example, a sales enablement team could automatically generate tailored playbooks for new products or market segments, ensuring consistent messaging and strategy alignment.

Properties

Name Meaning
Product OId The unique identifier of the product to associate with the new playbook (required).
Description A textual description explaining the purpose or content of the playbook (required).
Key Insight The main insight or takeaway that the playbook emphasizes (required).
Name Optional name for the playbook.
Type The category/type of the playbook. Options: Competitive, Custom, Segment, Signal, Solution, Specialist.
Context Optional additional context information about the playbook.
Persona OIds (JSON Array) Optional JSON array listing persona identifiers related to the playbook (e.g., ["p_123"]).
Use Case OIds (JSON Array) Optional JSON array listing use case identifiers related to the playbook (e.g., ["uc_123"]).
Create Templates Boolean flag indicating whether to create templates for the playbook (optional).
Model Optional model selection for the playbook. Options: Echo, Harmony, Pulse.
Additional Context Sources (JSON) Optional JSON array specifying extra context sources, e.g., URLs ([{"type":"URL","value":"https://example.com"}]).

Output

The node outputs an array of JSON objects representing the created playbook(s). Each output item contains the details returned by the Octave API after successfully creating a playbook, which typically includes identifiers, metadata, and any relevant status or confirmation fields.

If the node supports binary data output (not indicated explicitly here), it would represent attachments or files related to the playbook, but based on the provided code and properties, the output is purely JSON.

Dependencies

  • Requires an active connection to the Octave V2 API via an API key credential.
  • The node depends on the Octave API endpoints for playbook creation.
  • Proper configuration of the API key credential in n8n is necessary.
  • No additional external services are explicitly required beyond the Octave API.

Troubleshooting

  • Common Issues:

    • Missing required fields such as Product OId, Description, or Key Insight will likely cause the API to reject the request.
    • Invalid JSON format in the Persona OIds or Use Case OIds fields can lead to parsing errors.
    • Network or authentication failures if the API key is invalid or expired.

  • Error Messages:

    • Errors from the API may include messages about missing or invalid parameters; ensure all required fields are correctly filled.
    • Parsing errors might occur if JSON arrays are malformed; validate JSON syntax before input.
    • Authentication errors indicate issues with the API key credential setup.

  • Resolution Tips:

    • Double-check required inputs and their formats.
    • Validate JSON inputs using online tools or built-in n8n validators.
    • Verify API key credentials and permissions.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch operations.

Links and References

Discussion