Integrate Seismic
The standard uni-directional integration between the Optimizely Content Marketing Platform (CMP) and Seismic automatically uploads assets and updates them from CMP to Seismic. Assets landing in the library and identified by a configurable flag are pushed automatically to Seismic's library alongside their mapped metadata. The integration supports the asset's full lifecycle from CMP (create, update, delete).
Note
The Seismic integration is purchased separately and requires configuring and activating services in your instance.
Integration features
- Uni-directional integration from CMP to Seismic
- Field or folder-based flag to send assets
- Push assets after completing tasks, or one at a time or in bulk from the library
- Push assets to specific Seismic folders
- Push the latest version of assets from the CMP to Seismic
- Update assets taxonomy to have it reflected in Seismic
- Deleted assets in the CMP may be removed or expired in Seismic
- Assets may be published using Seismic's Dynamic Folders
Requirements
- An Optimizely Content Marketing Instance (CMP)
- Admin Access to CMP Apps and Integrations
- The library module in CMP
- Seismic integration services agreement
- A Seismic tenant
- Admin access to Seismic ('My Apps' and 'App Registry')
- If automatic publishing is required, Dynamic Folders configured in Seismic
Seismic configuration
You must be a Seismic Premium user with Full Control (System Administrator) permissions. You also need to create an app in Seismic (https://apps.seismic.com/apps) and enable it in your tenant (https://[your tenant].seismic.com/app#/adminsettings/system/MyApps).
- Suggested Short Description – A uni-directional integration from Optimizely Content Marketing Platform to Seismic
- Signing Secret – Share the value you enter in this field with your Optimizely Solution Consultant
- Do you need authentication for your App? – Yes
- Authentication Method – OAuth2 - Authorization Code Flow (User Authentication)
- Client id (client_id) – This value is auto-generated after saving. Share the value in this field with your Optimizely Solution Consultant
- Client secret (client_secret) – This value is auto-generated after saving. Share the value in this field with your Optimizely Solution Consultant
- Redirect URIs (redirect_uri) –
- https://auth.tray.io/oauth2/token
- Scopes –
- seismic.user.view
- seismic.configuration.view
- seismic.library.view
- seismic.library.manage
After you create the app, enable it in your tenant in your tenant's app settings, Settings > System Settings > My Apps (at the bottom of the list)
Note
You do not need to configure specific items for the integration to work. However, if you do want to make changes or updates to settings, see Seismic's documentation for details about Seismic folders, custom properties, and so on.
CMP configuration
You can push assets to Seismic by using a specific label or moving an asset to a specific library folder in CMP. You need to configure only one way to push assets.
Push using a field
You can use a label or single-choice dropdown field to push an asset from CMP to Seismic. For example, a label group: "Send to Seismic?" with a label value: Yes.
The following process shows how to set up this label.
- Go to your Fields settings page.
- 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 the field.
- Click Create.
Push from a folder
To push assets to Seismic based on the CMP folder, create a dedicated folder in the Library section of your CMP instance. CMP pushed content added to this folder to Seismic.
- Go to your library in CMP and click Create Folder.
- Enter a name for your folder and click Create.
- Share the folder name with your solutions consultant.
You can also preselect the Publishing Folder as your default publishing destination from the workflow settings, which is worth doing if your workflows directly relate to creating content for Seismic.
- Select the workflows from your avatar > Workflows Push to Library.
- Select your Publishing Folder as the primary publishing destination. Assets pushed from tasks using this workflow will automatically go into the selected destination.
Taxonomy setup in CMP
To send taxonomy as properties to Seismic, set up and manage related fields in CMP.
Note
Only CMP labels are currently supported.
Adding fields is the same process as setting up the label to indicate CMP should push the asset to Seismic; change the field types, names, and options values to suit it. See Taxonomy Support PagesTaxonomy Support Pages for details on how field inheritance works, plus how to set up and manage fields..
Configure the App and Webhook
Note
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.
- Go to your avatar > Apps & Webhooks.
- 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 – Seismic
- Description – A standard uni-directional integration between the Optimizely Content Marketing Platform (CMP) and Seismic.
- Expose Email Address – Do not expose.
- Homepage URL – Enter the URL for your Seismic tenant.
- Authorization Callback URL's – https://auth.tray.io/oauth2/token
- Click Create App. The grid view of registered applications displays.
- Click your application and click Edit to see two fields displayed:
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.
- Next set up a CMP Webhook – Go to your avatar > Apps & Webhooks.
- Open the Webhooks tab to access the options.
- Click Register New and fill out the form with the following details.
- Name - Sending Assets to Seismic
- Description - This webhook setup will send assets to Seismic 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 client's Tray solution instance).
- Events – Select the following events for proper integration:
- asset_added
- asset_modified
- asset_removed
- 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 Seismic where possible. (You may need to involve your Seismic representative to configure Seismic-specific items such as Dynamic Folders for auto-publishing.) This work includes:
- Deploy a Seismic Integration instance for your use.
- Set your configuration in the integration instance.
- Complete the mapping of your required taxonomy to fields and values required by Seismic API.
Use the Integration
Publish net assets
While completing the task workflow, the assets added to the task must go to Seismic, add the assets, and complete the relevant field values that Seismic needs. The asset is sent to Seismic 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 Seismic.
Certain data within the integration confirms that the asset is intended for use in Seismic. CMP bases confirmation on the value of a specific field or the location of the asset within CMP's library folder designated for Seismic 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.
Alternatively, you can add assets directly to the library in any folder by clicking Upload.
After you select and upload assets, you should complete the relevant field values that Seismic needs.
CMP sends the asset to Seismic in near real-time.
The integration uses the asset metadata and field values to populate Seismic properties, and part of the data confirms that the asset is meant for Seismic use.
When you update assets through a task or directly in the library, creating an updated version of the asset or updating fields sends the updates to Seismic in near real-time.
Update assets
You can update Seismic assets through tasks or directly in the library and have changes reflected in Seismic. The updates may include changing the title, expiry date, fields, and labels or adding a version of the asset. After you make updates in CMP, the integration automatically synchronizes the changes to Seismic, 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 Seismic and CMP in a few ways.
- You can configure the integration to delete an asset in Seismic 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 Seismic. Appending the label again publishes it back to Seismic as a new asset or version.
- Folder publishing – Moving an asset out of the folders synchronized with Seismic also deletes the asset in Seismic. However, moving the asset back into a corresponding folder publishes it back to Seismic as a new asset or version.