Sprinklr

Overview

This integration is designed to import posts, comments, and replies from Sprinklr Dashboards into Birdie.

Note: You will need 2 types of accounts:

Requirements

Birdie's integration with Sprinklr requires some credentials that can be acquired by following the steps below. Birdie utilizes the Client Credentialsarrow-up-right authentication method.

Necessary credentials:

  • env: Sprinklr environment.

    circle-info

    Note: A key generated for one environment cannot be used in another environment and URL conventions are different for each environment. No need to enter {env} in case of Production (prod) environment — remove {env} from URL.

  • apikey: The key you get after registering your application on the developer portal.

  • secret: The secret you received upon application activation.

Setup in Sprinklr

Find your Sprinklr environment (env)

Before making API requests, identify the environment (env) where your Sprinklr instance is hosted. This information is required because API URLs can differ depending on your environment.

  1. Login to the Sprinklr UI platform.

  2. Right-click anywhere on the page.

  3. Select “View Page Source” from the dropdown menu.

  4. Open the search engine (Ctrl+F (Windows/Linux) or Cmd+F (Mac)) and search for “sentry-environment”.

  5. The value displayed next to “sentry-environment” indicates where your Sprinklr instance is hosted.

Create a new app in Sprinklr Developer Portal

To integrate Sprinklr with Birdie, create an application in the Sprinklr Developer Portal. This process will provide the API Key and Client Secret required for Birdie.

  1. Click on your email address at the top-right corner.

  2. Select “Apps” from the dropdown menu.

  3. Click on the “+ New App” button to create a new application.

  4. During the process to create a new application, you will have a field called "Callback Url". Since the callback won't actually be used, you can use any valid URL.

  5. After completing the process, you can get the API Key and Client Secret.

Enable Client Credentials authentication method

To enable Birdie's integration with Sprinklr, you need to request that the User ID associated with your client ID be allowed to use the Client Credentials authentication method. Send an email to Sprinklr supportarrow-up-right with that request.

Follow these steps to find the User ID:

  1. Login to the Sprinklr UI platform.

  2. Go to "All Settings" and click on "Users" icon within "Manage Workspace".

  3. Using the Search bar, find the user you want to set up client credentials for.

  4. Click on the three vertical dots beside the User Name and choose "Details" from the dropdown menu.

  5. You can find the user Id as part of the browser URL in this format: /users/1000127865/overview. Here 1000127865 is the user Id.

Once you have the Client ID and User ID, send an email similar to the one below (replace placeholders accordingly):

I would like to request the activation of access token authentication using the Client Credentials method for the following account. API Key: {API key} User Id: {User ID}

About Sprinklr UI

Dashboards and Columns

In Sprinklr, Dashboards are used to organize and monitor your brand’s data. Each dashboard can contain multiple Columns, and each column displays information from different social media sources or data types. For more information, see the documentationarrow-up-right.

Creating a Dashboard

  1. Go to the Home Page.

  2. Click the “+” button at the top of the page to create a new page.

  3. On the new page, locate the Engage section.

  4. Click on "Engagement Dashboards" to view all your existing dashboards.

  5. Click the “+ Create Dashboard” button in the top-right corner.

  6. Fill in the required information: the dashboard name, folder, and tag.

Creating a Column in a Dashboard

  1. Inside the dashboard, click the “+ Add Column” button.

  2. Select the social media source you want to collect data from.

  3. Choose the type of data the column will display.

  4. (Optional) On the next screen, configure filters to customize the data you want to retrieve (for example, display only customer comments from a post).

Connect to Birdie

To retrieve information from your columns, Birdie needs two pieces of information:

  1. The name of the dashboard where the columns are located.

  2. The IDs of the columns from which you want to retrieve data.

Finding the Dashboard Name

  • Go to the Home Page in Sprinklr, click the “+” button at the top of the page to create a new page, then navigate to the Engagement Dashboards section. Finally, locate the dashboard you want to work with and note its name.

Finding the Column IDs

You can retrieve the column ID by making the following API request:

(Original content referenced an API request here — keep the actual request as provided in source.)

Data in scope

Currently, Birdie supports the following social media sources and specific types of content:

  • Facebook

    • Posts, Comments, and Replies

  • Instagram

    • Posts, Comments, and Replies

Last updated