N8N Tools - Typebot API icon

N8N Tools - Typebot API

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

Actions23

Overview

The "Update Workspace" operation in this node allows users to modify the settings of a workspace within the Typebot.io platform. This includes updating basic workspace properties such as its name and icon. The node interacts with the Typebot API to send these updates, enabling automation and integration workflows that manage workspace configurations programmatically.

Typical use cases include:

  • Automating workspace renaming or rebranding.
  • Updating workspace icons to reflect new branding or themes.
  • Integrating workspace management into larger automation pipelines for team collaboration tools.

For example, a user might trigger this node to update the workspace icon and name after a company rebrand, ensuring all related chatbots and workspaces reflect the new identity without manual intervention.

Properties

Name Meaning
Additional Fields Collection of optional fields to update workspace settings:
- Stream Enabled Enable streaming for real-time responses (not applicable for workspace update).
- Prefilled Variables Variables to prefill in the typebot (not applicable here).
- Result ID Existing result ID to continue conversation (not applicable here).
- Theme Custom theme configuration as JSON (not applicable here).
- Settings Custom settings as JSON (not applicable here).
- Icon Workspace icon, can be an emoji or URL string to update the workspace's icon.
- Typebot JSON Typebot configuration as JSON (not applicable here).
- Export Format Format for exporting results (not applicable here).
- Filename Custom filename for file uploads (not applicable here).
- File Size Limit MB File size limit in megabytes (not applicable here).

Specifically for Update Workspace operation, only the following additional fields are used:

Name Meaning
name New name for the workspace
icon New icon for the workspace (emoji or URL)

These fields allow partial updates; you can provide either or both.

Output

The node outputs the JSON response from the Typebot API after attempting to update the workspace. The structure typically contains the updated workspace details reflecting the changes made, such as the new name and icon.

Example output JSON structure (simplified):

{
  "id": "workspace-id",
  "name": "Updated Workspace Name",
  "icon": "🆕",
  "otherProperties": "..."
}

If the update fails, the output will contain an error message describing the issue.

Dependencies

  • Requires an API key credential for authenticating with the Typebot API.
  • Needs the workspace ID configured in the credentials or environment to identify which workspace to update.
  • The node sends HTTP PATCH requests to the Typebot API endpoint /api/v1/workspaces/{workspaceId}.
  • Requires network access to the Typebot API service.
  • Uses an internal proxy service (https://n8ntools.io/api/v1/proxy/typebot) to forward requests.

Troubleshooting

  • Common issues:

    • Invalid or missing API authentication token: Ensure the API key and token are correctly set in the credentials.
    • Incorrect workspace ID: Verify the workspace ID is correct and accessible by the authenticated user.
    • Invalid field values: For example, providing malformed JSON in fields like theme or settings (though not used here) may cause errors.
    • Network connectivity problems to the Typebot API or proxy service.

  • Error messages:

    • "Unknown workspace operation": Indicates the operation parameter is incorrect or unsupported.
    • HTTP 401 Unauthorized: Authentication failure; check API keys and tokens.
    • HTTP 404 Not Found: Workspace ID does not exist or is inaccessible.
    • Validation errors: Returned if provided fields do not meet API requirements (e.g., invalid icon format).

To resolve errors, verify credentials, input parameters, and ensure the workspace exists and is accessible.

Links and References

Discussion