Setup Guide

Set up Refiner as a destination in RudderStack.

  •   2 minute read  

This guide will help you set up Refiner as a destination in the RudderStack dashboard. It also lists the configuration settings required to correctly send data from the supported sources to Refiner.

Connection compatibility

Destination info
  • Status: Generally Available
  • Supported sources: Web, Cloud, Android, iOS , Unity, AMP , Warehouse, React Native , Flutter, Cordova, Shopify
  • Refer to it as REFINER in the Integrations object.

Connection modes
SourceCloud modeDevice modeHybrid mode
AMPsupportednot supportednot supported
Androidsupportednot supportednot supported
Cloudsupportednot supportednot supported
Cordovasupportednot supportednot supported
Fluttersupportednot supportednot supported
iOSsupportednot supportednot supported
React Nativesupportednot supportednot supported
Shopifysupportednot supportednot supported
Unitysupportednot supportednot supported
Warehousesupportednot supportednot supported
Websupportedsupportednot supported
Supported message types
SourceIdentifyPageTrackScreenGroupAlias
Cloud mode
Supported sourcessupportedsupportedsupportednot supportedsupportednot supported
Device mode
Websupportedsupportedsupportednot supportedsupportednot supported

Get started

Once you have confirmed that the source platform supports sending events to Refiner, follow these steps:

  1. From your RudderStack dashboard, add the source. Then, from the list of destinations, select Refiner.
  2. Assign a name to your destination and click Continue.

Connection settings

To successfully set up Refiner as a destination, you need to configure the following settings:

  • Refiner REST API Key: Enter your Refiner REST API key.
  • Refiner Web Client API Key: Enter your web client API key.
info
For more information on obtaining the Refiner REST API key and web client API key, refer to the FAQ section below.
  • Map Rudder user attributes to Refiner contact traits: Use this setting to map specific properties from the RudderStack event to Refiner’s contact traits.
  • Map Rudder account attributes to Refiner account traits: Use this setting to map specific properties from the RudderStack event to Refiner’s account traits.
  • Client-side Events Filtering: This setting lets you specify which events should be blocked or allowed to flow through to Refiner. For more information on this setting, refer to the Client-side Events Filtering guide.
  • Use device mode to send events: Enable this setting to send your events to Refiner via web device mode.
  • Consent management provider: Configure the consent management settings for the specified source by choosing the consent management provider from the dropdown. If you choose Custom, make sure to pass the custom consent data to SDK.

FAQ

Where can I find the Refiner REST API key and web client API key?

To get your Refiner REST API key and web client API key, follow these steps:

  1. Log into your Refiner dashboard.
  2. From the left sidebar, click the Integrations icon and go to REST API. You will find the REST API Key listed here under Secret API Key:
Refiner REST API key
  1. To get your Refiner web client API key, click the Settings icon from the left sidebar and go to Web Client. You will find the API key listed here:
Refiner web client API key

Questions? Contact us by email or on Slack