Actions50
- Agent Actions
- Async Actions
- Competitor Actions
- Experiment Actions
- Persona Actions
- Playbook Actions
- Product Actions
- Proof Point Actions
- Reference Actions
- Segment Actions
- Use Case Actions
Overview
The "Build Workspace" operation under the "Agent" resource is designed to create or configure a workspace environment within the Octave platform. This workspace acts as a collaborative and organizational space where users, agents, and offerings (products or services) are associated and managed.
Typical use cases include:
- Setting up a new workspace for a team or project with specific agents assigned.
- Configuring workspace details such as name, URL, and user inclusion preferences.
- Associating product offerings with the workspace, including their unique value propositions and references.
- Providing runtime context data to customize the build process dynamically.
This node is beneficial for automating workspace setup in sales, marketing, or customer success platforms that integrate with Octave, enabling streamlined onboarding and configuration workflows.
Properties
| Name | Meaning |
|---|---|
| Workspace: Name | The name of the workspace to be built or configured. This is a required string identifying the workspace. |
| Workspace: URL | Optional URL of the workspace, e.g., https://octave.com. Can be used to link to the workspace's web interface or landing page. |
| Workspace: Add Existing Users | Boolean flag indicating whether existing users should be added to the workspace. Defaults to true if not specified. |
| Workspace: Agent OIds (JSON Array) | Optional JSON array of agent identifiers (OIds) to associate with the workspace, e.g., ["id1", "id2"]. These agents become part of the workspace's team or resources. |
| Offering: Name | Required name of the offering or product associated with the workspace. |
| Offering: Differentiated Value | Required string describing the unique value proposition or differentiator of the offering. |
| Offering: Additional URLs (JSON Array) | Optional JSON array of additional URLs related to the offering, such as documentation links, e.g., ["https://docs.octave.com"]. |
| Offering: Status Quo | Optional description of the current status quo or problem that the offering addresses. |
| Offering: References (JSON Array of Objects) | Optional JSON array of reference objects providing evidence or case studies supporting the offering, e.g., [{"url": "https://casestudy.example.com/customer-a", "details": "Customer A achieved X results..."}]. |
| Runtime Context (JSON for Build Workspace) | Optional JSON object providing runtime context parameters to customize the workspace build process dynamically. |
Output
The node outputs an array of JSON objects representing the result of the workspace build operation. Each output item typically contains structured data about the created or updated workspace, including its properties and associations.
If the operation involves binary data (not indicated here), it would be summarized accordingly, but this operation primarily deals with JSON data.
Dependencies
- Requires an API key credential for authenticating with the Octave V2 API.
- The node depends on the Octave platform's API endpoints to perform workspace creation and configuration.
- No additional external services are explicitly required beyond the Octave API.
- Proper network connectivity and valid credentials must be configured in n8n for successful execution.
Troubleshooting
Common Issues:
- Invalid or missing required properties such as workspace name or offering name will cause errors.
- Malformed JSON input for properties expecting JSON arrays or objects (e.g., agent OIds, offering references) can lead to parsing failures.
- API authentication failures due to incorrect or expired API keys.
- Network connectivity issues preventing communication with the Octave API.
Error Messages:
- Errors returned from the API will be included in the output under an error object if "Continue On Fail" is enabled.
- Parsing errors for JSON inputs will indicate malformed JSON; ensure proper formatting.
- Authentication errors suggest checking the API key credential configuration.
Resolution Tips:
- Validate all JSON inputs using a JSON validator before running the node.
- Confirm that all required fields are provided and correctly spelled.
- Verify API credentials and permissions.
- Enable "Continue On Fail" to capture detailed error information for debugging.
Links and References
- Octave Platform Documentation — For detailed API and workspace management guides.
- JSON Validator — Useful for validating JSON input properties.
- n8n Documentation on Credentials — For setting up API authentication securely.