N8N Tools - Typebot API icon

N8N Tools - Typebot API

Complete Typebot.io integration - Self-hosted chatbot builder with visual flows
Join our community

Actions23

Overview

The "Get Workspace" operation of the Typebot API node retrieves detailed information about a specific workspace within the Typebot platform. This workspace typically represents an organizational unit or project space where chatbots (typebots), members, and related resources are managed.

This node is beneficial when you want to programmatically access metadata or configuration details about your workspace, such as its name, icon, settings, or other attributes. For example, you might use this operation to:

  • Display workspace details in a dashboard.
  • Verify workspace existence or status before performing further operations.
  • Synchronize workspace data with external systems.

Properties

Name Meaning
Additional Fields A collection of optional fields that can be set for the workspace. For "Get Workspace", no additional fields are required or used.

Note: The "Additional Fields" property includes many options but for the "Get Workspace" operation specifically, it does not require or utilize any additional input parameters.

Output

The output JSON contains the full response from the Typebot API endpoint for the workspace details. It typically includes:

  • Workspace ID
  • Workspace name
  • Icon (emoji or URL)
  • Other metadata related to the workspace configuration

The exact structure depends on the Typebot API response but generally provides all relevant workspace information.

No binary data is output by this operation.

Example output snippet (conceptual):

{
  "id": "workspace_123",
  "name": "My Workspace",
  "icon": "🚀",
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-06-01T08:30:00Z"
}

Dependencies

  • Requires an API key credential for authenticating with the Typebot API.
  • Needs the workspace ID configured in the node credentials or environment.
  • The node makes HTTP requests to the Typebot API base URL, which must be accessible.
  • No other external dependencies are required.

Troubleshooting

  • Common issues:

    • Invalid or missing API authentication token will cause authorization errors.
    • Incorrect workspace ID will result in "not found" or similar errors.
    • Network connectivity problems may cause request failures.

  • Error messages:

    • "Unknown resource: workspace": Indicates the resource parameter was incorrectly set; ensure "Workspace" is selected.
    • "Unknown workspace operation: getWorkspace": Should not occur if operation is correctly set; verify node configuration.
    • Authorization errors like 401 Unauthorized mean the API token is invalid or expired.
    • 404 Not Found means the workspace ID does not exist or is inaccessible.

  • Resolutions:

    • Double-check API credentials and permissions.
    • Confirm the workspace ID is correct and belongs to the authenticated user.
    • Ensure network access to the Typebot API endpoint.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully during workflows.

Links and References

Discussion