N8N Tools - Typebot APIInstall

Overview

This node integrates with the Typebot.io API, specifically focusing on managing workspaces and their members. The "List Members" operation under the "Workspace" resource retrieves all members associated with a given workspace. This is useful for scenarios where you need to audit, display, or manage users within a workspace, such as in team collaboration tools or chatbot management platforms.

Practical examples:

• Automatically fetching and displaying workspace members in a dashboard.
• Synchronizing workspace member lists with other systems like CRM or user directories.
• Auditing workspace membership before performing bulk operations or sending notifications.

Properties

Note: For the "List Members" operation, only the "Additional Fields" property is available but it does not add any parameters relevant to this operation.

Output

The output is a JSON object containing the response from the Typebot API endpoint /api/v1/workspaces/{workspaceId}/members. This typically includes an array of workspace members with details such as user IDs, roles, email addresses, and other metadata related to each member.

The output structure looks like:

{
  "json": {
    // API response data listing workspace members
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data is returned by this operation.

Dependencies

• Requires an API key credential for authenticating with the Typebot API.
• The node uses the workspace ID from the credentials to identify which workspace's members to list.
• The API base URL and authentication token are also retrieved from the credentials.
• No additional environment variables or external services are required beyond the configured API credentials.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will cause authentication failures.
  • Incorrect workspace ID in credentials may result in empty or error responses.
  • Network connectivity issues can prevent successful API calls.

• Error messages:

  • "Unknown workspace operation: listMembers" — indicates a mismatch between the requested operation and the implemented ones; unlikely if using the provided node version.
  • HTTP errors from the API (e.g., 401 Unauthorized) suggest problems with API keys or tokens.

• Resolutions:

  • Verify that the API key and token are correctly set up in the node credentials.
  • Confirm the workspace ID is correct and accessible by the API key.
  • Check network connectivity and firewall settings.
  • Enable "Continue On Fail" in the node settings to handle errors gracefully during workflows.

Links and References

• Typebot.io API Documentation (general reference for API endpoints)
• n8n Documentation on Credentials (for setting up API keys)
• Typebot Workspace Management (conceptual overview of workspaces and members)