Integrate Highspot

  • Updated

The standard uni-directional integration between the Optimizely Content Marketing Platform (CMP) and Highspot lets assets be automatically uploaded and updated from CMP to Highspot. Assets landing in the library and identified with a configurable flag are pushed automatically to your selected Highspot spot alongside their mapped metadata. The integration supports the asset's full lifecycle from CMP (create, update, delete). 

You purchase the Highspot integration separately. You must configure and activate services in your instance. 

Integration Features

  • Uni-directional integration – CMP to Highspot
  • Automated push to Highspot based on a defined trigger (Label OR Folder) through the library
  • Supports mapping the CMP library taxonomy (labels only) to the Highspot existing taxonomy to leverage Highspot filtering and automated rules
  • Supports one CMP field to one Highspot list group or one CMP field to many Highspot list groups
  • Supports Create, Update, and Delete operations

Requirements

  • Access to the Highspot API for this integration. You can check with your Highspot representative to see if you have access to the API. API access comes with the Highspot Enterprise Platform+ Package.
  • An Optimizely Content Marketing Instance (CMP)
  • Admin Access to CMP Apps and Integrations
  • The library module in CMP
  • Highspot API User (Service Account)
  • Your Highspot representative will configure this user

Highspot configuration

Using the credentials for the API user provided by Highspot, you must access the API information required to set up the integration. You need the following: 

  • URL – Accesses your Highspot instance with the API.
  • Key – Authenticates API requests on behalf of the API user.
  • Secret – Authenticates API requests on behalf of the API user.

CMP Configuration

You can push assets to Highspot using a specific label or by moving an asset to a specific library folder in CMP. You can choose only one of these options. 

Push using a field

You can use a label or single-choice drop-down field to indicate that CMP should push an asset to Highspot. For example: a label group: "Send to Highspot?" with a label value: Yes.

The following process shows how to set up this label.

  1. Go to your Fields settings page.
    highspot-1.png
  2. Click Add Field. The Create a New Field view displays.
    • Select Label or Dropdown for Field Type.
    • Select Single-Select (preferred) or Multi-Select.
    • Enter an intuitive name in the Field Name so your colleagues know how to use this field.
      highspot-2.png
  3. Click Create.

Push from a folder

To push assets to Highspot based on the CMP folder, create a dedicated folder in the Library section of your CMP instance. CMP pushes content added to this folder to Highspot.

  1. Go to your library in CMP and click Create Folder.
    highspot-3.png
  2. Enter a name for your folder and click Create.
    highspot-4.png
  3. Share the folder name with your solutions consultant.

You also can preselect the Publishing Folder as your default publishing destination from the workflow settings, which is worth doing if your workflows relate directly to creating content for Highspot.

  1. Select the workflows from your avatar > Workflows Push to Library.
  2. Select your publishing folder as the primary publishing destination. Assets pushed from tasks using this workflow automatically go to the selected destination.
    highspot-5.png

Taxonomy setup in CMP

Set up and manage related fields in CMP to send taxonomy as lists to Highspot.

Only CMP labels are supported.

Adding fields is the same process as setting up the label to indicate the asset should be pushed to Highspot; you just change the field types, names, and options values to suit. See the Taxonomy Support Pages for details on how field inheritance works and how to set up and manage fields.

Configure the App and Webhook

You should be an administrator and (or have Manage integrations permissions in your role profile) because the following steps require registering your client application and setting up a webhook.

  1. Go to your avatar > Apps & Webhooks.
    highspot-6.png
  2. Click Register App and fill out the form with the following details.
    • Select Production mode. (If you are setting up just for testing, select Development.)
    • Name – Highspot
    • Description – A standard uni-directional integration between the CMP and Highspot.
    • Expose Email Address – Do not expose.
      highspot-7.png
    • Homepage URL – Enter the URL to your Highspot instance.
    • Authorization Callback URLs – https://auth.tray.io/oauth2/token
  3. Click Create App. The grid view of registered applications displays.
  4. Click your application and click Edit to see two fields displayed:
    highspot-8.png
    CMP generates the Client ID and Client Secret for your application. Share the value in this field with your Optimizely Solution Consultant. Keep these values safe.
  5. Set up a CMP Webhook by going to your avatar > Apps & Webhooks.
  6. Open the Webhooks tab to access the options.
    highspot-9.png
  7. Click Register New and fill out the form with the following details.
    • Name – Sending Assets to Highspot
    • Description – This webhook setup will send assets to Highspot when they land in Optimizely Content Marketing Platform library.
    • Callback URL – Enter the URL provided by your solutions consultant (from the Workflow Public URL from the Parent: CMP Event Handler workflow in the clients Tray solution instance).
    • Events – Select the following events for proper integration:
      • asset_added
      • asset_modified
      • asset_removed
        highspot-10.png
  8. Click Save.

Deployment

The Optimizely CMP Solution Consultant team completes the integration deployment. The solution consultant works with you, letting you complete the integration configuration in CMP and Highspot where possible. This work includes:

  • Deploy a Highspot Integration instance for your use.
  • Set your configuration in the integration instance.
  • Complete mapping your required taxonomy to fields and values required by Highspot API.

Use the Highspot integration

Publish net assets

While completing the task workflow, the assets added to the task must go to Highspot, add the assets, and complete the relevant field values that Highspot needs. The asset is sent to Highspot in near real-time when it arrives in CMP's library. The integration uses the field values on the asset to populate properties and other metadata in Highspot.

Certain data within the integration confirms that the asset is intended for use in Highspot. CMP bases confirmation on the value of a specific field or the location of the asset within CMP's library folder designated for Highspot content. You may select the folder the asset should be saved to in the library in the icon on the Content tab of the task.

highspot-11.png

highspot-12.png

Alternatively, you can add assets directly to the library in any folder by clicking Upload.

highspot-13.png

highspot-14.png

After you select and upload assets, you should complete the relevant field values that Highspot needs.

highspot-15.png

The asset is sent to Highspot immediately.

The integration uses the asset metadata and field values to populate Highspot lists, and part of the data confirms that the asset is meant for Highspot.

When you update assets through a task or directly in the library by creating an updated version of the asset or updating fields, the updates are sent to Highspot in near real-time.

Update assets

You can update Highspot assets through tasks or directly in the library and have changes reflected in Highspot. The updates may include changing the title, expiry date, fields, and labels or adding a new version of the asset. After updates are made in CMP, the integration automatically synchronizes the changes to Highspot, also in near real-time, as long as the synchronization conditions remain true (the asset is in the correct folder or has the correct label for publishing).

Delete assets

You can remove assets from Highspot and CMP in a few ways.

  • You can configure the integration to delete an asset in Highspot if you delete the asset from the CMP library. Deletion applies to folder and label publishing.
    • Label publishing – Removing the label from the asset also deletes the asset in Highspot. Appending the label again publishes it back to Highspot as a new asset or version.
    • Folder publishing – Moving an asset out of the folders synchronized with Highspot also deletes the asset in Highspot. However, moving the asset back into a corresponding folder publishes it back to Highspot as a new asset or version.