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 "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, making it useful for automating workspace management tasks.

Common scenarios where this node is beneficial:

  • Automatically renaming or rebranding a workspace based on external triggers.
  • Updating workspace icons programmatically to reflect changes in team branding.
  • Integrating workspace updates into broader automation workflows that manage chatbot environments.

Practical example:

  • A marketing team uses n8n to update their chatbot workspace icon and name whenever a new campaign launches, ensuring consistent branding across all chatbots managed in that workspace.

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)
- Name New name for the workspace to update

Note: For the "Update Workspace" operation, only the name and icon fields from the additional fields collection are used to update the workspace.

Output

The node outputs a JSON object representing the response from the Typebot API after attempting to update the workspace. This typically includes the updated workspace details such as its ID, name, icon, and other metadata returned by the API.

Example output structure (simplified):

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

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Typebot API.
  • Needs the workspace ID to identify which workspace to update; this is retrieved from credentials or environment.
  • The node sends HTTP PATCH requests to the Typebot API endpoint /api/v1/workspaces/{workspaceId}.
  • Requires proper configuration of the API base URL and authentication token in the node credentials.

Troubleshooting

  • Error: Unknown workspace operation
    Occurs if an unsupported operation is specified. Ensure the operation is set exactly to "Update Workspace".

  • Authentication errors
    If the API token or key is invalid or missing, the request will fail. Verify that the API credentials are correctly configured.

  • Invalid JSON in input fields
    If JSON fields like theme or settings are provided but malformed, the node may throw parsing errors. For this operation, these fields are not used, but ensure inputs are valid if extended.

  • Workspace not found or permission denied
    If the workspace ID is incorrect or the API user lacks permissions, the update will fail. Confirm the workspace ID and API user rights.

Links and References

Discussion