Create Link button

Embeddable Button

The Create ClearSlide Link button enables your end user to create ClearSlide link directly from your application with the appropriate data/context. When the user clicks the button, the user is presented with the ClearSlide authentication page. Upon successful login, user is automatically redirected to the ClearSlide Create Link experience. If the user’s login state is valid, then the user won’t be prompted to login.

Getting Started

The simplest way to display a Create ClearSlide Link button on your page is to embed the following snippet into your HTML resource.

In the following HTML, replace YOUR_CLIENT_ID with your client id.

<form action="" method="POST" target="_blank">
  <input type="hidden" name="clientId" value="YOUR_CLIENT_ID">
  <input type="hidden" name="companyName" value="sampleCompanyName">
  <input type="hidden" name="companyCrmId" value="sampleCompanyId">
  <input type="hidden" name="personCrmId" value="samplePersonId">
  <input type="hidden" name="deckId" value="sampleDeckId">
  <input type="hidden" name="externalId" value="sampleOtherId">
  <input type="hidden" name="recipientName" value="sampleRecipientName">

  <input type="submit" value="Create ClearSlide Link">

Live Example - Embeddable Javascript

Display a Create ClearSlide Link button on your page to embed the following JS snippet into your application.

Replace YOUR_CLIENT_ID with your client id.


Supported Browsers

ClearSlide APIs are supported on the latest versions of Chrome, Firefox, Safari, Internet Explorer, and Edge. Please note that Internet Explorer 10 and below are not supported.

How does it work?

Create ClearSlide Link button, when submitted, makes an HTTP POST request to the ClearSlide web application with the form data sent to ClearSlide create link. The meaning of each parameter can be found in the description section below.

You can place multiple buttons on the same page. Each button can pass the same or different context when creating ClearSlide link.

If you are not logged into ClearSlide in another browser tab, you will be prompted to login before creating a link.

If you are logged into ClearSlide in another browser tab, ClearSlide create link form will be loaded immediately.

What parameters can be sent with a button?

Standard url parameters

Parameter NameDescription
clientId (required)Specifies which partner app is requesting access to ClearSlide functionality
deckId (optional)Enables the end user to land into the ClearSlide link experience with the target deck pre-loaded (You can use the Presentations API endpoint to get deck ids)
companyName (optional)Enables the end user to see the target company name pre-populated
recipientName (optional)Enables the end user to see the target recipient name pre-populated

Custom url parameters

The purpose of custom parameters is to enable you to attach a custom id to a ClearSlide create link. By doing so, you’ll be able to associate and relate ClearSlide customer activity and engagement data with objects unique to your application.

Custom parameters are particularly useful when embedding Create ClearSlide Link button in a CRM application. For example, if your end user starts a ClearSlide create link with a contact at an account, you can pass personCrmId and companyCrmId as url parameters when calling the ClearSlide create link url.

Parameter NameDescription
companyCrmId (optional)Enables you to associate a CRM company id (account / opportunity) with the ClearSlide Link
personCrmId (optional)Enables you to associate a CRM person id (contact / lead) with the ClearSlide Link
externalId (optional)Enables you to associate a unique id with the ClearSlide Link

End to End working example - 5 mins

In this example, you will be creating ClearSlide Link with third-party data, creating link, and query Insights API to view third-party data associated with activity summary.

Step 1 of 3 :

Provide valid parameters into the HTML. Click the Create ClearSlide Link button.

Step 2 of 3 :

Complete creating a ClearSlide link in the web application.

Step 3 of 3 :

Option 1 - Use the Insights API reference document.

Option 2 - Use the below fiddle editing the following parameters: - authorization, targetUserId, timestamp