User Invites
Add User Invites to Apps

How to add user invites to apps

It's clear from the user invites diagram overview that these APIs are necessary to manage the user invitation process:

  • The sendUserInvites() API sends the invitation.
  • The resendUserInvite() API provides a resend invitation option.
  • The userInvites() API is used to check the status of the invitation.
  • The cancelUserInvite() API allows the inviter to cancel the invitation.

The usage and implementation of these APIs heavily depend on the app and the use case. However, general steps are required to implement the user invitation process.

Get user and tenant data

Before sending any user invitation, we need to get the user and tenant data. The user data can be retrieved from the session using the useSession() method or user query, which returns the user ID and user tenant data from the session.

For example, to get user dan tenant data from the session in Next.js:

import { useSession } from "@/lib/roq"
const { session } = useSession()
const userId = session?.roqUserId
const tenantId = session?.user?.tenantId

Add user invitation UI

You can use a button or any other UI element to trigger the user invitation process.

Send user invitations

After we get the user and tenant data and user invitation UI, we can send the invitation using the sendUserInvites() API method. This method will send an invitation to the user's email. This invitation supports multiple users so that we can send multiple invitations in one request.

import { roqBrowserClient } from '@/lib/roq/roq-client';
const status = async () => {
    const userInvitations = await roqBrowserClient.roqPlatform.sendUserInvites({
        userInvites: {
            tenantId: 'ee764883-f2c3-4486-9de6-070345e350af',
            userInvites: [{
                createdByUserId: '530c9a92-71c5-4dce-a6e3-c638c2d0b1bc',
                email: "",
                locale: "en-US",
                roles: ["content-creator"]
    return userInvitations

In some cases, we need to resend the invitation, so we can utilize the resendUserInvite() API method to resend the invitation or cancel the invitation using the cancelUserInvite() API method.

Track user invitation status

After we send the invitation, we can track the invitation status using the userInvites() API method. This method will return the user invitation status, which can be used to check the invitation status.

import { roqBrowserClient } from '@/lib/roq/roq-client';
const userInvitesData = async() => { 
    return await roqBrowserClient.roqPlatform.userInvites({
        limit: 10