LivePerson Inbound Connector
About the LivePerson Inbound Connector
You can use the LivePerson inbound connector to load chats and messages from your LivePerson account into XM Discover.
Required Setup in LivePerson
To connect XM Discover to LivePerson, you will need the following information about your LivePerson account:
- Your LivePerson account ID
- If using OAuth 2.0, your LivePerson username and password
- If using API keys, your LivePerson API security tokens
Qtip: For more information, please see the LivePerson documentation.
Setting Up a LivePerson Inbound Job
Qtip: The “Manage Jobs” permission is required to use this feature.
- On the Jobs page, click New Job.
- Select LivePerson.
- Give your job a name so you can identify it.
- Choose the project to load data into.
- Give your job a description so you know its purpose.
- Click Next.
- Choose a LivePerson account to use, or select Add New to add a new one.
- If adding a new account, give the connection a name so you can identify it.
- Choose between Oauth 2.0 and API Key as the authorization mode.
- If you’re using Oauth, enter the following information:
- LivePerson Username: Your LivePerson username.
- LivePerson Password: Your LivePerson password.
- Account ID: Your LivePerson account ID.
- If you’re using an API key, enter the following information:
- LivePerson App Key: Your LivePerson app key.
- LivePerson App Secret: Your LivePerson app secret.
- LivePerson Token: Your LivePerson token.
- LivePerson Token Secret: Your LivePerson token secret.
- Account ID: Your LivePerson account ID.
- If you want your credentials to expire, then configure the following options:
- Send Expiration Notifications: Select this option to allow your credentials to expire.
- Days prior expiration: If enabling expiration notifications, enter how many days you’d like to be notified before the expiration. You may enter a value between 1 to 100 days.
- Expiration Date: Set the date when the credentials will expire. Click on the box to open a calendar to pick the date.
- Click Next.
- Select the type of data to upload from LivePerson.
- Chat: Upload chat transcripts and related data.
- Message: Upload contact center messaging interactions. Only closed messages are imported.
- Click Next.
- If needed, adjust your data mappings. See the Data Mapping support page for detailed information on mapping fields in XM Discover. The Default Data Mapping section has information on the fields specific to this connector and the Mapping Conversational Fields section covers how to map data for conversational data.
- Click Next.
- If desired, you can add data substitution and redaction rules to hide sensitive data or automatically replace certain words and phrases in customer feedback and interactions. See the Data Substitution and Redaction support page.
Qtip: Click Download Sample Data to download an Excel file with sample data to your computer. - Click Next.
- If desired, you can add a connector filter to filter the incoming data to limit what data is imported.
- You can also limit the number of records imported in a single job by entering a number in the Specify Record Limit box. Enter “All” if you would like to import all records.
Qtip: For conversational data, the limit is applied based on conversations rather than rows.
- Click Next.
- Choose when you’d like to be notified. See Job Notifications for more information.
- Click Next.
- Choose how duplicate documents are handled. See Duplicate Handling for more information.
- Choose Schedule Incremental Runs if you’d like your job to run periodically on a schedule, or Set Up One-Time Pull if you’d like the job to run just once. See Job Scheduling for more information.
- Click Next.
- Review your setup. If you need to change a specific setting, click the Edit button to be brought to that step in the connector setup.
- Click Finish to save the job.
Default Data Mapping
Attention: As field names are case-sensitive in Connectors, the first letter of the field name must be upper-case as displayed in the Data Sample to ensure data mappings are accurate and the job succeeds.
This section contains information on the default fields for LivePerson inbound jobs.
- richVerbatim: Verbatim for conversational data. This field includes sub-fields to track the client’s and representative’s side of the conversation.
Qtip: Transformations are not supported for conversational verbatim fields.
- clientVerbatim: Identifies data from the client’s side of a conversation. By default this field is mapped to “clientVerbatimChat” for digital interactions, and to “clientVerbatimCall” for call interactions.
- agentVerbatim: Identifies data from the representative’s side of a conversation. By default this field is mapped to “agentVerbatimChat” for digital interactions, and to “agentVerbatimCall” for call interactions.
- unknown: Identifies data from the unknown side of a conversation. By default this field is mapped to “unknownVerbatimChat” for digital interactions, and to “unknownVerbatimCall” for call interactions.
- natural_id: A unique identifier of a document. It is highly recommended to have a unique ID for each document to process duplicates correctly. For Natural ID, you can select any text or numeric field from your data. Alternatively, you can automatically generate IDs by adding a custom field.
- document_date: The primary date field associated with a document. This date is used in XM Discover reports, trends, alerts, and so on. You can choose one of the following options:
- chatRequestedTime: The time the chat was requested.
- interactiveTime: The time when the CoBrowse session became interactive.
- startTime (default): Conversation start time.
- endTime: Conversation end time.
- You can also set a specific document date.
- feedback_provider: Identifies data obtained from a specific provider. For LivePerson documents, this attribute’s value is set to “LivePerson” and cannot be changed.
- source: Identifies data obtained from a specific source. This can be anything that describes the origin of data, such as the name of a survey or a mobile marketing campaign. By default, this attribute’s value is set to “LivePerson.” Use custom transformations to set a custom value, define an expression, or map it to another field.
- feedback_type: Identifies data based on its type. This is useful for reporting when your project contains different types of data (for example, surveys and social media feedback). By default, this attribute’s value is set “Messaging Platform”. Use custom transformations to set a custom value, define an expression, or map it to another field.
- job_name: Identifies data based on the name of the job used to upload it. You can modify this attribute’s value during the setup via the Job Name field that is displayed at the top of each page during the setup.
- loadDate: Indicates when a document was uploaded into XM Discover. This field is set automatically and cannot be changed.