An essential part of building a multi user agent is to identify which user is currently interacting with your agent. There are a few ways in which you can achieve this:

  1. Identifying at the start of a new session

The JSON payload sent to your webhook contains an endUserId field. At the moment, this field is only set if you have created a custom client and passed in the userID when starting a new session. So in most cases, this field will be empty.

For existing integrations that we have, the channel property in the JSON object will contain the user’s email or user ID (for example, slack user ID), using which you can identify the user reliably.

We are working on a method of automatically identifying the user by prompting them to do a Google sign in as part of the agent workflow. Once this is implemented, and if you enable it for your agent, you will always have an email and a endUserId in the JSON payload, regardless of communication channel being used.

  1. Identifying a user with a sessionId

If you have organized your code in a way that only propagates the sessionId to your agent, you can use this to identify the user. This is especially useful if you have a multi user agent system. You can call the following API to get the user information based on the sessionId:

curl -X GET https://api.agentreach.com/v1/session?sessionId=<sessionId> \
  -H "Authorization: Bearer <Agent API Key>"

The resulting JSON will be structured this way:

{
    id: string,
    agentId: string,
    completed: boolean,
    endUserId: string | undefined,
    channel: {
        type: string,
        email?: string,
        slackUserId?: string
    },
    createdAt: timestamp,
}