Octave icon

Octave

Interact with the Octave V2 API

Actions26

Overview

This node integrates with the Octave V2 API to list playbooks. It allows users to retrieve a collection of playbooks based on various filters and pagination options. This is useful in scenarios where you want to automate workflows or decision trees defined as playbooks, for example:

  • Fetching all available playbooks to display in a dashboard.
  • Searching for specific playbooks by text or product association.
  • Paginating through large sets of playbooks to process them in batches.

Practical examples include automating marketing sequences, customer support flows, or sales outreach strategies that are encapsulated as playbooks.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit. Boolean: true returns all results.
Limit Maximum number of playbooks to return when not returning all. Minimum value is 1.
Offset Pagination offset to skip a number of playbooks before starting to collect results. Minimum 0.
Text Search Optional text string to search for within playbooks.
Query Type Scope of the playbook search. Options: All, Team, Mine.
Product OId (Filter) Optional filter to restrict playbooks by a specific Product OId.

Output

The node outputs an array of JSON objects representing playbooks matching the query criteria. Each item corresponds to one playbook with its associated data fields as returned by the Octave API.

  • The output field json contains the playbook details.
  • No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Octave V2 API.
  • The node depends on the Octave API service being accessible.
  • No additional environment variables or external services are explicitly required beyond the API key.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API key.
    • API rate limits or network connectivity problems.
    • Invalid parameter values such as negative offsets or limits below 1.

  • Error messages:

    • Errors from the API will be caught and included in the output if "Continue On Fail" is enabled.
    • Parsing errors may occur if the API response body is malformed.

  • Resolutions:

    • Verify the API key credential is correctly configured.
    • Ensure numeric parameters respect minimum values.
    • Check network connectivity and API status.
    • Use "Return All" carefully with large datasets to avoid timeouts.

Links and References

Discussion