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

This node integrates with the Typebot.io API to manage workspaces and their members, among other resources. Specifically, the Invite Member operation under the Workspace resource allows users to invite new members to a workspace by sending an invitation email.

Typical use cases include:

  • Automating workspace member management by inviting users programmatically.
  • Integrating workspace invitations into onboarding workflows.
  • Managing team collaboration by controlling workspace access via invitations.

For example, you can use this node to invite a new team member by specifying their email and role, triggering an email invitation from Typebot.io automatically.

Properties

Name Meaning
Additional Fields Collection of optional fields to customize the invitation:
- Email The email address of the person to invite to the workspace (required for Invite Member).
- Member Type The role/type of the invited member in the workspace. Options: MEMBER (default) or others.

Note: Only the "Additional Fields" property is used for the Invite Member operation, specifically requiring the email and optionally memberType.

Output

The node outputs a JSON object representing the response from the Typebot.io API after attempting to invite a member. This typically includes details about the invitation status or any errors returned by the API.

Example output structure:

{
  "json": {
    "invitationId": "string",
    "email": "user@example.com",
    "status": "pending",
    "role": "MEMBER",
    "createdAt": "2024-01-01T00:00:00Z"
  },
  "pairedItem": {
    "item": 0
  }
}

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Typebot.io API.
  • Needs configuration of the workspace ID within the node credentials or environment.
  • The node sends HTTP requests to the Typebot.io API endpoints.
  • No additional external dependencies beyond standard HTTP and JSON handling.

Troubleshooting

  • Common issues:

    • Missing or invalid API authentication token will cause authorization failures.
    • Providing an invalid or malformed email address may result in API errors.
    • Inviting a user who is already a member or has a pending invitation might cause duplicate invitation errors.
    • Workspace ID must be correctly configured; otherwise, the API will reject the request.

  • Error messages:

    • "Unknown workspace operation: inviteMember": Indicates a misconfiguration or typo in the operation name.
    • "Authorization failed" or HTTP 401 errors: Check that the API key/token is valid and properly set.
    • "Invalid email address": Verify the email format in the input properties.
    • Network or timeout errors: Ensure connectivity to the Typebot.io API endpoint.

To resolve errors, verify all required inputs, ensure correct credentials, and confirm workspace existence.

Links and References

Discussion