Identify your users with PLuG

Once you have installed PLuG, all your users who interact with the widget are created as anonymous users in the DevRev app with a random name since there is no information about the user.

For users who are logged into your website, you can identify them in PLuG so they can view their past conversations. Identifying your users also enables more personalized engagement.

In this flow, you have to generate a session token for every user who visits your website. The session token identifies the customer when they interact with the widget. The session token is generated using the application access token and customer information. It should be generated on your website’s back end since the app token needs to be kept hidden.

To identify logged-in users, follow these steps:

Generate an application access token

1. In DevRev, go to Settings > Support > PLuG Tokens through the settings icon on the top-left corner.
2. Under the Application access tokens panel, click New token and copy the token that’s displayed.

Generate a session token

Using the rev_info method, you can generate and recognize a user within the DevRev system by providing relevant user details. This method enables you to convey information systematically, ensuring alignment between your DevRev CRM and the structured data model. For information regarding terminologies, click here.

$
 curl --location 'https://api.devrev.ai/auth-tokens.create' \
>
--header 'accept: application/json, text/plain, */*' \
>
--header 'authorization: <AAT>' \
>
--header 'content-type: application/json' \
>
--data-raw '{
>
    "rev_info": {
>
        "user_ref": "example@devrev.ai",
>
        "account_ref": "devrev.ai",
>
        "workspace_ref": "devrev-dev",
>
        "user_traits": {
>
            "email": "test-user@devrev.ai",
>
            "display_name": "Devrev Test USer",
>
            "phone_numbers": ["+911122334455"],
>
            "custom_fields": {
>
               "tnt__<field1_name>": "value 1"
>
            }
>
        },
>
        "workspace_traits": {
>
            "display_name": "Devrev Dev",
>
            "custom_fields": {}
>
        },
>
        "account_traits": {
>
            "display_name": "Devrev",
>
            "domains": [
>
                "devrev.ai"
>
            ],
>
            "phone_numbers": ["+919988998833"],
>
            "custom_fields": {
>
                "tnt__<field2_name>": "value x"
>
            }
>
        }
>
    }
>
}'

Pass custom attributes

To create custom attributes, see Object customization.

You can pass the custom attributes that are created as shown below:

1
"custom_fields": {
2
  "tnt__custom_attribute_name1": <value>,
3
  "tnt__custom_attribute_name2": <value>,
4
}

You can pass custom traits, as shown above, not only for users but also for workspaces and accounts.

If you prefer a two-level structure, where users are directly associated with an account instead of a workspace, you can provide the user_ref and details along with the account_ref and details.

Attributes for users

Attributes for workspaces

Attributes for accounts

Pass the session token

While initializing the PLuG widget you pass the session token for DevRev to identify this user and thereby make the widget more customized for the user and their context.

1
// You can generate this session token using the above API in your backend
2
const sessionToken = '<SESSION_TOKEN>'
3
<script type="text/javascript" src="https://plug-platform.devrev.ai/static/plug.js"></script>
4
<script>
5
    (() => {
6
      window.plugSDK.init({
7
        app_id: '<your_unique_app_id>',
8
          session_token: sessionToken
9
        })})();
10
</script>