Overview

This node operation invites a new user by sending an invitation email. It is useful in scenarios where an administrator wants to onboard new users to a system by inviting them via email, specifying their role, and optionally customizing the invitation URL. For example, inviting a new team member to a project management platform with a specific role and a custom invite link.

Use Case Examples

1. Invite a new user to a workspace by providing their email and role.
2. Send a customized invitation email with a specific invite URL to a new user.

Properties

Output

JSON

• email - The email address of the invited user.
• role - The role assigned to the invited user.
• inviteUrl - The custom invite URL if provided.
• status - The status of the invitation process, e.g., success or failure.

Dependencies

• Requires an API key credential or authentication token to interact with the user management system's invitation API.

Troubleshooting

• Ensure the email address is valid and properly formatted to avoid invitation failures.
• Verify that the role provided exists and is valid in the system to prevent errors.
• If using a custom invite URL, ensure the USER_INVITE_URL_ALLOW_LIST environment variable is configured correctly to enable this feature.
• Common errors may include authentication failures, invalid input data, or permission issues when inviting users. Check API credentials and permissions.

Links

• USER_INVITE_URL_ALLOW_LIST Environment Variable - Documentation on configuring environment variables to enable custom invite URLs.