The Login Service API provides endpoints to manage the User Session in LiveEngage, such as User Login, Application Login, Logout and Refresh. Use this API to log into LiveEngage as a user with credentials or an application with an API key. After logging in, you receive a session token (Bearer) to use for other related API calls.

Refer to the API Terms of Use, if you haven't already done so.
We recommend that you implement our Retry Policy and KeepAlive Best Practices.

Step 1. Retrieve your domain

Before you can choose your login method, you must retrieve your domain using the Domain API.

TIP: Use the agentVep service name to retrieve your domain.

Step 2. Choose your method of login

  • User Login - Provides a way for users to access and manage a LiveEngage session. A session could be a customized workspace or hosting a LiveEngage user in an external app. Use the LiveEngage username and password, and refer to User Login for more details.

    Logged in users are managed under the same restrictions as regular users in LiveEngage, including password expiration, concurrent conversation limits, skill groups and so on. If your account has SSO enabled, this method is not standalone, and you must register the relevant user through your hub to provide LiveEngage with an SSO SAML assertion.
  • Application - Provides a way for applications to access and manage LiveEngage sessions, such as bots, virtual agents, or other apps that need to act as an agent. The Application Login method overcomes both issues detailed in the User Login method (above), such as password expiration or SSO integration. For more details, refer to Application Login.

    To login as an application, you must have the User Type - Bot feature activated. If you do not, contact your account team before proceeding.

Step 3. Create an API key and new Bot

  1. Log into LiveEngage with Administrator or Campaign Manager permissions and along the top open the Campaigns area.

  2. In the footnote, click Data Sources.

  3. Open the API tab and click Add new.

    TIP: Alternatively, you can click on an existing key to edit its privileges.

  4. Provide the name of the application and the developer name. Optionally, you can provide a description of the app by clicking the Add description link below the Application name field.

  5. Select the Agent Interactions category, click the User Login check box to select it, and then click Save.


    Once the API key has been successfully created, the authentication details display for four AUTH request values, which you use in the request body of this API:

    • App key

    • Secret

    • Access token

    • Access token secret

  6. Copy the generated App key.


  7. Along the top, open the Users area and click Add user. From the Login Method, select App Key from the drop-down menu.


  8. Remember the App Key you copied earlier? Paste it into the App key field.


  9. Complete the required fields to finish creating the user and then click Save at the top of the form.

    You use the Username field in the request body of this API.

  10. Log into LiveEngage with the following information:

  • App Key

  • App Secret

  • Access Token

  • Access Token Secret

  • Username of the user created in the previous step