How to set up the Vidyard for Salesforce integration

The Vidyard integration is a collection of components that allows you to implement a video layer across your various teams' Salesforce experience.

At its core, the integration allows you to track video engagement within individual lead, contact and user records, as well as incorporate data into reports and dashboards to help you understand the impact of video on your business.

This document explains the process to set up the integration, including:

1. how to install the Vidyard app from the Salesforce AppExchange,
2. options for how to grant your team access to the app,
3. how to add the video view component to your page layouts,
4. how to test the integration to ensure data is being passed successfully to records in Salesforce.

Requirements

Install the Vidyard for Salesforce app

Before you install the Vidyard app, we recommend that you sign out of all Salesforce instances. Vidyard uses an OAuth connection to install the app⁠—signing out prevents you from accidentally installing the app on the wrong account.

1. Open the Vidyard listing in the Salesforce AppExchange in a separate browser tab 
2. Click on Get it Now to begin the installation
3. Select Install in Production or Install in Sandbox (depending on the account you want to use)
   • If installing in a sandbox account, complete the remaining instructions in this article, then also install the sandbox app package (you will need both).
4. Select the checkbox to indicate that you've read and agree to the Terms and Conditions, then select Confirm and Install
   • You'll be redirected to a Salesforce sign in page. Enter your account credentials to continue.
5. You will be presented with options to specify for which users you want to install the app
   • Select Install for All Users, then click on Install

Manage which users have access to the Vidyard app

For each connected app in Salesforce, you specify both which users have access to the app as well as how the app behaves (e.g. what IP restrictions apply, for how long a refresh token is valid, etc).

For the Vidyard app specifically, you'll need to both set the authorization policy and select which users have access to the app.

1. In the top right-hand corner of Salesforce, select Setup (the gear icon)
2. Use the Quick Find menu on the left side of the page to search for and select Apps > Manage Connected Apps,
3. Click on Vidyard to open the app's settings, then select Edit Policies
4. Under OAuth Policies, use the dropdown menu to set Permitted Users to Admin approved users are pre-authorized
5. Click Save
6. Scroll down to select the Profiles or Permission Sets that you want to access to the Vidyard app
   
   • To allow access by Profile, select Manage Profiles
   • To allow access by Permission Sets, select Manage Permission Sets
7. Select one or more Profiles or Permissions Sets from the available list
8. Click Save when finished

Note: if you choose to allow access to the app by permission set, do not use the permission set included with the Vidyard App called Vidyard Application; it no longer works as intended. It is best to grant access from your existing profiles or permission sets. 

Add the Vidyard custom related list to your page layouts

The Vidyard for Salesforce app includes a "video views" related list that you can add to lead, contact or user records. Within each record, the object provides you with contextual information about which videos the person has watched, when, for how long (+ more).

Learn more about the video data that Vidyard syncs with Salesforce.

1. In the top right-hand corner of the page, select Setup (the gear icon)
2. Use the Quick Find menu to search for and select Objects and Fields > Object Manager
3. Select the object you want to modify (lead, contact or user)
4. Click on Page Layouts, then select the layout you want to edit
5. From the objects menu, select Related Lists
6. Click and drag the Video Views item onto the layout
7. Click Save when finished 

Optional: customize the fields on the Video Views related list

With the related list added to your Lead, Contact, or User records, you will see a snapshot of the video data that Vidyard writes to Salesforce whenever an identified viewer watches a video. The list also contains an option to "View All" and dive deeper into the complete data set.

In the Salesforce Object Manager, you can customize the data that you see at a glance on the related list.

1. Click on the wrench icon next to the Video Views related list 
2. Use the Add  and Remove arrows to customize which fields are immediately available on the related list
3. Use the Up and Down arrows to determine the order of the fields
4. Select OK
5. Click Save to finish

Connect Vidyard to Salesforce

1. Sign in to Vidyard
2. From the dashboard, select Admin > Integrations
3. Next to Salesforce, select Add
   
   • You'll be redirected to a Salesforce sign in page. Enter your account credentials to continue. 
   • If you're already signed in, Vidyard will connect to your Salesforce account automatically

Note: If your company uses single sign on (SSO) to manage authentication to Salesforce, you may encounter an error that prevents you from completing the connection with Vidyard.

When Vidyard redirects you to sign in to Salesforce, select the Use Custom Domain option to change the default login.salesforce.com sign in URL to your company's domain (i.e. domain.my.salesforce.com), then enter your credentials.

Optional: Allow Vidyard to create new leads

Vidyard offers powerful tools to ensure that anyone who watches your videos becomes an identified viewer. For example, you might identify someone through a lead capture form (CTA) or a video email message that contains a tracking token.

If an identified viewer matches an email address already in Salesforce, Vidyard will send video view analytics to their associated record.

In addition, you can also configure the integration so that a new lead is created whenever Vidyard identifies a viewer that does not have an existing record in Salesforce.

Note: When Vidyard creates a new lead, Salesforce will indicate that the lead is both "Owned by" and "Created by" the account used to set up the integration.

1. Open the dropdown menu next to the Salesforce integration, then select Update
2.  Toggle Lead Creation Option to ON, then click on Update

Test the integration

To test whether the integration successfully passes video view data from Vidyard to Salesforce, use a video and a test email address to generate an identified view.

1. Select the Share button next to a video in your library
2. Click on Copy Link to obtain the sharing page URL
3. Open the sharing page in an incognito or private browser session
4. Force an identified view to pass data to a Salesforce record
   • Append the following string to the sharing page URL:
     ?vyemail=example.email@company.com
   • We recommend that you use an email address associated with an existing record that you don't mind testing the integration with.
5. Open the record in Salesforce associated with the test email
   • If you've added the video view object to the record's page layout, you should see Video Views as a new element on the page
   • Click on View All to expand for complete details

What video data does Vidyard write to Salesforce?

Below is a list of the complete data set that Vidyard writes to an identified viewer's record in Salesforce whenever they watch a video.