This is where you’ll configure and design the actual invitation form that will be rendered in your web or mobile application. Your primary goals here are to select all of the features you want to be part of your invitation form, and then make sure the form matches your application’s look and feel.
Commonly referred to as shareable links, these invitation links can be distributed by your users however they see fit. For example, they may copy the link and paste it into a Slack channel or a WhatsApp chat. The various toggles are ways you can facilitate that distribution by providing deep links into the message composition experience for common distribution channels.
Copy link button - Provides a button that copies the shareable link to the user’s clipboard so that they can paste it elsewhere. This is the most common option for B2B services, especially on the web, since the links are most frequently copied and shared into Slack and Microsoft Teams.
Share link via SMS - Provides a button that opens the user’s messaging app and prefills a message that includes the shareable link.
Share link via Instagram DMs - Provides a button that opens Instagram and prefills a message that includes the shareable link. This option is only available for mobile invitation flows.
Share link via Twitter DMs - Provides a button that opens Twitter and prefills a message that includes the shareable link.
Share link via WhatsApp - Provides a button that opens WhatsApp and prefills a message that includes the shareable link.
Share link via QR code - Provides a button that displays a QR code that represents the shareable link.
Share link via native share sheet - Provides a button that opens that OS’s native share sheet, where common sharing options are controlled by the device’s operating system. While many B2C services like to control the specific sharing destinations offered via the above options, other services leave it to the OS to offer the most common options. This is particularly true with B2B services on mobile devices.
Share link via email - Provides a button that is a mailto link that opens the user’s email client and prefills an email with a message that includes the shareable link.
Autojoin allows users to join based on the domain of their email address. For example, AcmeTasks may allow anyone to join their workspace on your service by signing up with an @acmetasks.com email address. The checkbox to enable autojoin should only be exposed to users in your customer organizations that have appropriate priviledges (e.g., admins). You control this by including the autoJoinscope in the adminScopes parameter of your JWT payload when the current user has sufficient priviledges.Autojoin is usually included on invitation forms shown to users during an onboarding flow, although it may also be included in other invitation flows. The checkbox to enable autojoin only does so for the domain associated with the current user.You’ll also want to allow admins in your customer organizations to manage their list of allowed domains so that they may add and remove domains as needed. Once you’ve created a interface, send a POST request to the /api/v1/invitations/autojoin endpoint (or one of our SDKs) to send the updated list of domains to Vortex.
The Elements tab allows you to control the styling of your widget. Select an element from the dropdown at the top of the Elements tab, or click on an element in the widget preview, to control the details of its styling (fonts, colors, borders, spacing, etc.).
The Add Element tab allows you to add custom fields and other elements to your form.
Custom Fields - Additional information that applies to every invitee. For example, you might specify the role of the people being invited (e.g., Member or Admin). Again, the selected values apply to ALL invitees. Note that custom fields only apply to email invitations, and not shareable links, so ideally they would be placed on the form in a way that makes this clear.
Content - Additional content such as text areas, images and links.
The widget preview at the right will update as you add and remove features, or change styling. You can use drag-and-drop to rearrange elements on the form.The dropdown at the above the preview allows you to switch between edit mode and preview mode. Although the true test of the widget will be when you embed it in your own application, preview mode does give you a sense for how the form will appear to your users.
