Setup Guide

Set up Singular as a destination in RudderStack.

  •   2 minute read  

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

Connection compatibility

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

Connection modes
SourceCloud modeDevice modeHybrid mode
AMPsupportednot supportednot supported
Androidsupportedsupportednot supported
Cloudsupportednot supportednot supported
Cordovasupportedsupportednot supported
Fluttersupportednot supportednot supported
iOSsupportedsupportednot supported
React Nativesupportedsupportednot supported
Shopifysupportednot supportednot supported
Unitysupportednot supportednot supported
Warehousesupportednot supportednot supported
Websupportednot supportednot supported
Supported message types
SourceIdentifyPageTrackScreenGroupAlias
Cloud mode
Supported sourcesnot supportednot supportedsupportednot supportednot supportednot supported
Device mode
Androidsupportednot supportedsupportedsupportednot supportednot supported
Cordovasupportednot supportedsupportedsupportednot supportednot supported
iOSsupportednot supportedsupportedsupportednot supportednot supported
React Nativesupportednot supportedsupportedsupportednot supportednot supported

Setup

In your RudderStack dashboard, add a source. Then, from the list of destinations, select Singular.

Connection settings

SettingDescription
API keyEnter your Singular API key.
SecretEnter your Singular secret. It is required for device mode integrations with the RudderStack iOS and Android SDKs.
Session event nameEnter the event names to be used as session events.

Note: This setting is applicable only for sending session events to Singular in cloud mode.
Use device mode to send eventsWhen using the Android / iOS source, you can turn on this setting to send events in device mode. Then, follow the Singular Device Mode guide for steps on adding the Singular integration to your project.
Client-side events filteringSpecify which events should be blocked or allowed to flow through to Singular.

See Client-side Events Filtering for more information.
Consent management providerConfigure the consent management settings for the specified source by choosing the consent management provider from the dropdown.

Note: If you choose Custom, make sure to pass the custom consent data to SDK.

FAQ

Where can I find the Singular API key and secret?

To obtain your Singular API key and secret, log into your Singular dashboard and navigate to Settings > SDK Keys:

Singular API key

Questions? Contact us by email or on Slack