N8N Tools - Typebot API icon

N8N Tools - Typebot API

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

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 operation is useful when you want to:

  • Fetch current workspace settings and metadata.
  • Verify workspace details before performing further actions like managing typebots or members.
  • Integrate workspace data into workflows for reporting or synchronization purposes.

Practical example:
You might use this node in an automation workflow that audits your chatbot environments by retrieving workspace info regularly, ensuring configurations are up-to-date or triggering alerts if certain workspace properties change.

Properties

Name Meaning
Additional Fields Optional extra parameters to customize the request; includes:
- Stream Enabled Enable streaming for real-time responses (boolean)
- Prefilled Variables Variables to prefill in the typebot, each with a name and value (multiple entries allowed)
- Result ID Existing result ID to continue conversation (string)
- Theme Custom theme configuration as JSON
- Settings Custom settings as JSON
- Icon Typebot icon specified as emoji or URL
- Typebot JSON Typebot configuration as JSON (for import/update)
- Export Format Format for exporting results; options: CSV, JSON, Excel
- Filename Custom filename for file uploads
- File Size Limit MB File size limit in megabytes for uploads

For the Get Workspace operation specifically, the node uses the workspace ID from credentials and does not require additional input fields beyond optional "Additional Fields" if applicable.

Output

The output is a JSON object containing the workspace information retrieved from the Typebot API. The structure typically includes:

  • Workspace ID
  • Name
  • Icon
  • Creation and update timestamps
  • Other metadata related to the workspace configuration

The exact fields depend on the Typebot API response but generally provide comprehensive details about the workspace.

No binary data output is involved in this operation.

Example output snippet (simplified):

{
  "id": "workspace_123",
  "name": "Marketing Bots",
  "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 to identify which workspace to retrieve.
  • The node makes HTTP requests to the Typebot API endpoint, so internet connectivity and correct API URL configuration are necessary.

Troubleshooting

  • Common issues:

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

  • Error messages:

    • "Unknown resource: workspace" — indicates the resource parameter was set incorrectly.
    • "Unknown workspace operation: getWorkspace" — suggests the operation parameter is invalid or misspelled.
    • HTTP 401 Unauthorized — check API key validity and permissions.
    • HTTP 404 Not Found — verify the workspace ID exists and is accessible.

  • Resolutions:

    • Ensure the API key credential is correctly set up and has required permissions.
    • Confirm the workspace ID matches an existing workspace in your Typebot account.
    • Check network access and proxy settings if requests fail to reach the API.

Links and References

Discussion