diff --git a/.gitignore b/.gitignore index a6a4095404..ba3fed1104 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,4 @@ _site vendor .bundle .DS_Store -_data/catalog/destinations.yml -_data/catalog/sources.yml -.env \ No newline at end of file +.env diff --git a/Makefile b/Makefile index ef0bba5ac0..a0f86c9ee3 100644 --- a/Makefile +++ b/Makefile @@ -9,7 +9,6 @@ docs: echo "Running segment docs at http://localhost:4000/docsv2/" && \ docker run -p 4000:80 segment-docs:latest - .PHONY: build build: echo "Building site for ${JEKYLL_ENV}" @@ -21,6 +20,17 @@ build: make catalog && \ JEKYLL_ENV=${JEKYLL_ENV} bundle exec jekyll build +.PHONY: docker-serve +make docker-serve: + echo "Building site for ${JEKYLL_ENV}" + docker run -it \ + --volume="$(PWD):/srv/jekyll" \ + jekyll/jekyll \ + bundle package && \ + make clean && \ + make deps && \ + JEKYLL_ENV=${JEKYLL_ENV} bundle exec jekyll serve --trace --incremental -H 0.0.0.0 -V + # Helper commands... .PHONY: nav @@ -54,8 +64,11 @@ deps: .PHONY: dev dev: make clean && \ - bundle exec jekyll serve --incremental -H 0.0.0.0 -V + bundle exec jekyll serve --trace --incremental -H 0.0.0.0 -V +.PHONE: trace +trace: + bundle exec jekyll build --trace # Docker-based commands... diff --git a/README.md b/README.md index 004feaf616..9f9d4d1936 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,10 @@ You can make a limited range of edits from the Github site, but this system works best if you clone it locally so you can run test builds. -# Setup instructions +# Local development with docker, without platform-api +Run `make docker-serve` + +# Local development with ruby on local machine 1. First, clone the repo to your local machine. 2. From the command-line, run `make env` to run the Ruby bundler and install the stuff you need to run the repo. **Tip**: If you ever need to do this again, you can run `make deps`. @@ -16,8 +19,9 @@ Use the local build process to preview local changes. If you're doing a release, - `docs`: locally builds the docs and serves the static content via a Docker container running nginx - `build`: Builds the site docs. Used by CI to publish the docs to staging and production +- `docker-serve`: Uses docker to build the docs locally, without needing to refresh the catalog from the platform-api - `nav`: Rebuilds the entire nav datafile based on the current doc structure. This is destructive and should not be used unless absolutely necessary. -- `catalog`: Pulls in the latest catalog data from the Platform API and saves it in the respective data files. Requires an API key saved in .env +- `catalog`: Pulls in the latest catalog data from the Platform API and saves it in the respective data files. Requires an API key to be passed in env via PLATFORM_API_TOKEN - `env`: for when you're first getting set up: installs bundler, and installs the deps for the repo. - `seed`: copies all example data files out of the `_templates` directory and puts them in the `_data` directory. Useful if you don't have a way to setup an API key. - `clean`: runs `jekyll clean` locally diff --git a/_data/catalog/destinations.yml b/_data/catalog/destinations.yml new file mode 100644 index 0000000000..59597a8e6d --- /dev/null +++ b/_data/catalog/destinations.yml @@ -0,0 +1,18232 @@ +# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT +--- +destinations: +- name: catalog/destinations/activecampaign + display_name: ActiveCampaign + description: 'Email marketing & marketing automation solution for small businesses. + +' + type: STREAMING + website: http://www.activecampaign.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/crxyMacQHwBl5JeGhwX7 + mark: https://cdn.filepicker.io/api/file/AihHusTMaZdUXL7OlFDw + categories: + primary: Email Marketing + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your API key can be found by navigating to your Active Campaign account + and clicking on My Settings > API. It should look something like `5292218aadbe410acf66c44164c4be2de4bbf184c509ef699d85a0e8da1d9fabeda175df` + settings: [] + - name: apiSecret + display_name: API url + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your API url can be found by navigating to your Active Campaign account + and clicking on My Settings > API. It should look something like `https://.api-us1.com` + settings: [] +- name: catalog/destinations/adikteev + display_name: Adikteev + description: 'Adikteev is the leading app retargeting solution that helps performance-driven + marketers target and engage their app audiences with customized, immersive creatives. + Combining science and creativity, Adikteev delivers measurable results that increase + user LTV and fuel business growth. ' + type: STREAMING + website: https://www.adikteev.com/ + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/731ca708-febb-4bc4-8ce2-e6f9229d0cd5.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/d159a61b-530e-43bd-90c1-f090dad90c78.svg + categories: + primary: Advertising + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: false + server: false + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[a-zA-Z0-9]*$" + description: Ask your account manager for the API key. + settings: [] +- name: catalog/destinations/adjust + display_name: Adjust + description: Adjust is a business intelligence platform for mobile app marketers, + combining attribution for advertising sources with analytics and store statistics. + type: STREAMING + website: https://adjust.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/adjust-default.png + mark: https://cdn.filepicker.io/api/file/VFbLfGGT1aWXoUBldtpQ + categories: + primary: Attribution + secondary: Deep Linking + additional: [] + components: + - type: IOS + - type: ANDROID + - type: CLOUD + platforms: + browser: false + server: true + mobile: true + methods: + alias: false + group: false + identify: false + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: setEventBufferingEnabled + display_name: Buffer and batch events sent to Adjust + type: BOOLEAN + deprecated: false + required: false + description: "**Device Mode Only**: This will save battery life by buffering and + batching events sent to Adjust. But during development it's nicer to see events + come through immediately." + settings: [] + - name: trackAttributionData + display_name: Track Attribution Data + type: BOOLEAN + deprecated: false + required: false + description: Send Adjust Attribution data to Segment and other tools as a `track` + call. + settings: [] + - name: appToken + display_name: App Token + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Adjust app token can be retrieved from your [Adjust account](https://next.adjust.com/#/) + in the app's Settings. + settings: [] + - name: customEvents + display_name: Map Your Events to Custom Adjust Event Tokens + type: MAP + deprecated: false + required: false + description: Enter your event on the left, and the Adjust custom event token to + map into on the right. Adjust allows you to create custom events under `Settings + > Events`, which have custom tokens. Adjust's API only accepts those tokens, + not arbitrary event names. Any unmapped events will not be sent to Adjust, since + they require a mapped token. + settings: [] + - name: delayTime + display_name: delayTime + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 10 + description: "*You must enable setDelay first!* \n\nSet the initial delay time + in seconds with the setting `setDelay` enabled. The maximum delay start time + of the adjust SDK is 10 seconds." + settings: [] + - name: setDelay + display_name: setDelay + type: BOOLEAN + deprecated: false + required: false + description: Configure a delay to ensure all session parameters have been loaded + properly. The max [delay start](https://github.com/adjust/ios_sdk#delay-start) + time is 10 seconds. + settings: [] + - name: setEnvironmentProduction + display_name: Send to Production Environment on Adjust + type: BOOLEAN + deprecated: false + required: false + description: This will send all your data to your production environment on Adjust. + If unchecked, data will flow to your sandbox environment on Adjust. + settings: [] +- name: catalog/destinations/adlearn-open-platform + display_name: AdLearn Open Platform + description: AdLearn Open Platform is AOL's platform for measuring ad conversions + and retargeting pixels. + type: STREAMING + website: http://www.adlearnop.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/adlearn-open-platform-default.svg + mark: https://cdn.filepicker.io/api/file/VsmrYeBoSXy03e6HGXiC + categories: + primary: Advertising + secondary: Analytics + additional: + - Enrichment + - A/B Testing + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: events + display_name: Events + type: MAP + deprecated: false + required: false + description: AdLearn Open Platform recognizes pixel ids, not custom event names. + When you `analytics.track(event, properties)` an event that represents an AdLearn + Open Platform conversion, you'll need to map the event name on the left to it's + corresponding AdLearn Open Platform pixel id on the right. These pixel ids show + up as the `type` parameters in the pixel. + settings: [] + - name: retargetingPixelId + display_name: Retargeting Pixel ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Your Retargeting Pixel ID, for the pixel that loads on every page. + It shows up in the pixel as the `betr` parameter. + settings: [] +- name: catalog/destinations/adobe-analytics + display_name: Adobe Analytics + description: It’s the industry-leading solution for applying real-time analytics + and detailed segmentation across all of your marketing channels. Use it to discover + high-value audiences and power customer intelligence for your business. + type: STREAMING + website: http://www.adobe.com/marketing-cloud/web-analytics.html + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/omniture-default.svg + mark: https://cdn.filepicker.io/api/file/E42OZ7ThRpuXrvIlMnul + categories: + primary: Analytics + secondary: Video + additional: [] + components: + - type: WEB + - type: IOS + - type: ANDROID + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: false + page_view: true + track: true + browserUnbundlingSupported: true + browserUnbundlingPublic: true + settings: + - name: reportSuiteId + display_name: Report Suite ID(s) + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'You can find your Report Suite ID in your Adobe Analytics Settings + page. Multiple report suite ids can be separated by commas: `suite1,suite2,suite3`.' + settings: [] + - name: sendBothTimestampVisitorId + display_name: Send Both Timestamp and VisitorID for Timestamp Optional Reporting + Suites + type: BOOLEAN + deprecated: false + required: false + description: If you have a *Timestamp Optional* Reporting Suite, you can opt to + send _both_ the timestamp and the visitorID in your XML when sending events + server side. However, note that this is *NOT* recommended by [Adobe](https://marketing.adobe.com/resources/help/en_US/sc/implement/timestamps-overview.html) + as it may lead to out of order data. This setting will only work for reporting + suites that have optional timestamp setting enabled. + settings: [] + - name: timestampOption + display_name: Timestamp Option + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - enabled + - disabled + - hybrid + description: Adobe Analytics can have Report Suites that will accept timestamped, + non-timestamped or hybrid data. Note that we can only play historical data + for timestamped or hybrid Report Suites. + settings: [] + - name: customDelimiter + display_name: 'List Variable and Prop Custom Delimiter: Server-Side Only ' + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - "|" + - "," + - ":" + - ";" + - "/" + description: Add a custom delimiter to concatenate Adobe Analytics lVars or props + sent as an array. Note, if you do not specify a custom delimiter, arrays will + be concatenated with a comma. Please add the Adobe Analytics lVar or prop on + the left and select a custom delimiter on the right. lVars must be in format + 'list1', 'list2', etc. and props in format 'prop1', 'prop2', etc. Must be all + lowercase with no whitespace. + settings: [] + - name: eVars + display_name: eVars + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 250 + map_prefix: eVar + select_options: [] + description: Map your Adobe Analytics eVar names to the property names you’re + using in your Segment events. Enter a Segment property name on the left and + an Adobe Analytics eVar number on the right. You can view your Segment events + and properties in your Schema. + settings: [] + - name: heartbeatTrackingServerUrl + display_name: Heartbeat Tracking Server URL + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: This is the URL of your Adobe Heartbeat server. Please contact Adobe + to obtain this URL. + settings: [] + - name: marketingCloudOrgId + display_name: Marketing Cloud Organization Id + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: If you would like to use the Marketing Cloud Id Service and use visitorAPI.js, + please enter your Marketing Cloud Organization ID. If you do not know your organization + ID, you can find it on the Marketing Cloud administration page. It should look + something like '1234567ABC@AdobeOrg'. + settings: [] + - name: enableTrackPageName + display_name: Enable pageName for Track Events + type: BOOLEAN + deprecated: false + required: false + description: If you do not want to attach `pageName` for your `.track()` calls, + you can disable this option. + settings: [] + - name: ssl + display_name: SSL + type: BOOLEAN + deprecated: false + required: false + description: Check this box if you would like your Adobe Heartbeat calls to be + made over HTTPS. + settings: [] + - name: eventsV2 + display_name: Events V2 (Bundled Mobile Only) + type: MAP + deprecated: false + required: false + description: "**Note**: If you are bundling our Adobe Analytics SDK on your mobile + device, you should map your events here. If you are sending via server side + you should use the `Events` option instead. Map your Adobe Analytics property + names on the left to Adobe event names on the right. Your events MUST be set + up in Adobe and mapped here in order to to be forwarded to the destination. + This setting only applies to Mobile integrations with Adobe." + settings: [] + - name: preferVisitorId + display_name: Prefer VisitorID for Hybrid Timestamp Reporting + type: BOOLEAN + deprecated: false + required: false + description: If you enable this option and you also have a *Timestamp Optional* + reporting suite, you can opt to send your visitorID instead of the timestamp + since Adobe does not allow you to send both. If you care more about your user + attribution, you should enable this if you're using a hybrid timestamp reporting + suite. + settings: [] + - name: props + display_name: Props + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 150 + map_prefix: prop + select_options: [] + description: Map your Adobe Analytics property names to the property names you’re + using in your Segment events. Enter a Segment property name on the left and + an Adobe Analytics property number on the right. You can view your Segment events + and properties in your Schema. + settings: [] + - name: removeFallbackVisitorId + display_name: 'No Fallbacks for Visitor ID: Server-Side Only ' + type: BOOLEAN + deprecated: false + required: false + description: "Note: This setting is for Server-Side only, and only applies when + the Drop Visitor ID setting is disabled and you send a marketingCloudId in the + Adobe Analytics integration object. \n​​\n​​Segment’s default behavior is to + set the Adobe Analytics visitorID based on the destination specific setting + for visitorId​, falling back to userId​ then anonymousId​. This setting removes + the fallbacks." + settings: [] + - name: contextValues + display_name: Context Data Variables + type: MAP + deprecated: false + required: false + description: "Map values you pass into the context object to [Context Data Variables](https://marketing.adobe.com/resources/help/en_US/sc/implement/context_data_variables.html) + in Adobe Analytics. Then you can use processing rules to map you Context Data + Variables in Adobe to other variables with Adobe Analytics Processing Rules. + In the box on the left, put your Segment context key. The box on the right is + what Context Data Variable you'd like it to be mapper to in Adobe.\n\nIf you + have a nested object, separate the name with a `.` For example if you wanted + to map the page referrer, you would put: page.referrer. \n\n**NOTE**: By default + we send all your `properties` as Context Data Variables so you do not need to + map them again here." + settings: [] + - name: customDataPrefix + display_name: Context Data Property Prefix + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: If you would like to prefix your Segment properties before sending + them as contextData, enter a prefix here. + settings: [] + - name: disableVisitorId + display_name: Drop Visitor ID + type: BOOLEAN + deprecated: false + required: false + description: This will disable Visitor ID from being passed to Adobe. + settings: [] + - name: events + display_name: Events + type: MIXED + deprecated: false + required: false + description: Map your Segment events to custom Adobe events. + settings: [] + - name: sendFalseValues + display_name: Send False values + type: BOOLEAN + deprecated: false + required: false + description: By default, we don't send properties with a `false` as value on cloud + mode. Enabling this setting will send any boolean property where value is `false`. + settings: [] + - name: trackingServerSecureUrl + display_name: Tracking Server Secure URL + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: This is the secure URL of your Adobe Analytics server. + settings: [] + - name: trackingServerUrl + display_name: Tracking Server URL + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: This is the URL of your Adobe Analytics server. + settings: [] + - name: useLegacyLinkName + display_name: Use Legacy LinkName + type: BOOLEAN + deprecated: false + required: false + description: |- + Before sending LinkName to Adobe Analytics, prepend the URL with `Link Name - `. + + This setting enables a legacy behavior for backwards compatibility. You probably want to keep this setting turned off. + settings: [] + - name: useSecureServerUrl + display_name: Use Secure URL for Server-side + type: BOOLEAN + deprecated: false + required: false + description: Enable this option if you want to use the 'Tracking Server Secure + URL' endpoint instead of the normal URL for server-side and Cloud Mode calls. + settings: [] + - name: hVars + display_name: Hierarchy Variables + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 5 + map_prefix: hier + select_options: [] + description: Map your Adobe Analytics hVars to the property names you’re using + in your Segment page calls. Enter a Segment property name on the left and an + Adobe Analytics hVar number on the right. You can view your Segment page calls + and properties in your Schema. + settings: [] + - name: lVars + display_name: List Variables + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 3 + map_prefix: list + select_options: [] + description: Map your Adobe Analytics list variables names to the property names + you’re using in your Segment events. Enter a Segment property name on the left + and an Adobe Analytics list variable number on the right. You can view your + Segment events and properties in your Schema. + settings: [] + - name: merchEvents + display_name: 'Merchandising Events ' + type: MIXED + deprecated: false + required: false + description: "Configure merchandising event, such as purchase or currency events.\n\nThis + is currently in Beta Testing and not generally available. " + settings: + - name: merchEvents + display_name: merchEvents + type: MIXED + deprecated: false + required: false + description: The name of the adobe event. + settings: [] + - name: productIdentifier + display_name: Product Identifier + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - name + - sku + - id + description: Adobe Analytics only accepts a single [product identifier](https://marketing.adobe.com/resources/help/en_US/sc/implement/products.html). + Use this option to choose whether we send product `name`, `id`, or `sku`. + settings: [] +- name: catalog/destinations/adroll + display_name: AdRoll + description: 'AdRoll is a retargeting network that allows you to show ads to visitors + who''ve landed on your site while browsing the web. ' + type: STREAMING + website: http://adroll.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/adroll-default.svg + mark: https://cdn.filepicker.io/api/file/IKo2fU59RROBsNtj4lHs + categories: + primary: Advertising + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: advId + display_name: Advertiser ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[A-Z0-9]{22}$" + description: 'You can find your Advertiser ID in your AdRoll dashboard by clicking + the **green or red dot** in the lower-left corner. In the Javascript snippet, + the Advertiser ID appears as `adroll_avd_id = ''XXXXXXX''` on line 2. It should + be 22 characters long and look something like this: `WYJD6WNIAJC2XG6PT7UK4B`.' + settings: [] + - name: events + display_name: Events + type: MAP + deprecated: false + required: false + description: AdRoll allows you to create a Segment Name and ID for conversions + events. Use this mapping to trigger the *AdRoll Segment ID* (on the right) when + the Event Name (on the left) is passed in a Track method. + settings: [] + - name: pixId + display_name: Pixel ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[A-Z0-9]{22}$" + description: 'You can find your Pixel ID in your AdRoll dashboard by clicking + the **green or red dot** in the lower-left corner. In the Javascript snippet, + the Pixel ID appears as `adroll_pix_id = ''XXXXXXX''` on line 3. It should be + 22 characters long, and look something like this: `6UUA5LKILFESVE44XH6SVX`.' + settings: [] + - name: _version + display_name: _version + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: '' + settings: [] +- name: catalog/destinations/adtriba + display_name: Adtriba + description: Adtriba allows advertisers to track, control and optimize their marketing + activities across all digital marketing channels through AI and user journey analysis. + type: STREAMING + website: https://www.adtriba.com + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/6b13904e-e065-48e3-8360-d68dff89baaf.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/7b465fc4-ceae-42bf-9627-d1678531a1be.svg + categories: + primary: Attribution + secondary: Advertising + additional: + - Analytics + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[a-zA-Z0-9]*$" + description: You can find your API key on the project settings page in the setup + area. + settings: [] +- name: catalog/destinations/adwords + display_name: Google Ads (Classic) + description: Advertise on Google and put your message in front of potential customers + right when they're searching for what you have to offer. + type: STREAMING + website: https://adwords.google.com + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/O54PEswFQAC7ZZDLSBZ5 + mark: '' + categories: + primary: Advertising + secondary: '' + additional: [] + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: false + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: eventMappings + display_name: Event Mappings + type: MIXED + deprecated: false + required: false + description: AdWords behavior for each of your Segment Events is defined here. + settings: + - name: eventName + display_name: Event Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Segment Event Name + settings: [] + - name: label + display_name: Label + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: AdWords recognizes labels, not custom events. When you analytics.track(event, + properties) an event that represents an AdWords conversion, you'll need to + map the event name to its corresponding label here. + settings: [] + - name: conversionId + display_name: Conversion ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: You can opt to override the default conversion ID by setting one + here + settings: [] + - name: remarketing + display_name: Send Remarketing Tag + type: BOOLEAN + deprecated: false + required: false + description: Enable this to send a remarketing tag in addition to the conversion + tag (if you leave the label field blank only a remarketing tag will be sent) + settings: [] + - name: linkId + display_name: Link Id + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: |- + The AdWords Link Id associated with Segment. The process for obtaining this can be found [here](https://support.google.com/adwords/answer/7365001). To create this Link Id, you must input Segment's Provider Id: **7552494388** + + **Important:** this setting is required only if you are using the new AdWords for mobile implementations. + settings: [] + - name: pageRemarketing + display_name: Page Remarketing + type: BOOLEAN + deprecated: false + required: false + description: Enable this to send a remarketing tag with your page calls + settings: [] + - name: trackAttributionData + display_name: Track Attribution Data + type: BOOLEAN + deprecated: false + required: false + description: |- + If this setting is enabled, Segment will send successfully attributed `Application Installed` events from AdWords as `Install Attributed` events back into this source. These events will contain data about the AdWords campaign that lead to the conversion. You can learn more about these events [here](https://segment.com/docs/spec/mobile/#install-attributed). + + **Important:** this feature is only available if you are using the new AdWords version. + settings: [] + - name: version + display_name: Version + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - '1' + - '2' + description: The current version of your AdWords account. If you have migrated + your AdWords account to the **new** AdWords interface at any point, you are + using version 2. Otherwise, please select version 1. + settings: [] + - name: conversionId + display_name: Conversion ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Your AdWords conversion identifier. It looks like `983265867`. You + can opt to override this on a per-event basis but at the very least this conversion + ID will serve as the ID used in page calls. + settings: [] + - name: correctLat + display_name: Correct LAT Behavior + type: BOOLEAN + deprecated: false + required: false + description: Enable this to set Limit Ad Tracking to `true` when context.device.adTrackingEnabled + is `false`. + settings: [] +- name: catalog/destinations/adwords-remarketing-lists + display_name: AdWords Remarketing Lists + description: The Google Adwords audience destination syncs your Segment audiences + into your Adwords account. + type: STREAMING + website: https://www.google.com/adwords + status: PUBLIC_BETA + logos: + logo: https://cdn.filepicker.io/api/file/EBKkKkQWKYb472vQVp9w + mark: https://cdn.filepicker.io/api/file/9VImDdjKTFWSWvdsPLxh + categories: + primary: Advertising + secondary: '' + additional: [] + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: false + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: account + display_name: Account + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Choose an account. + settings: [] + - name: appId + display_name: App ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Optionally enter a mobile app ID. This is only needed if you plan + to export mobile IDs to AdWords. + settings: [] +- name: catalog/destinations/airship + display_name: Airship + description: Airship gives brands the data, channels, orchestration and services + they need to deliver push notifications, emails, SMS, in-app messages, mobile + wallet cards and more to the right person in the right moment. + type: STREAMING + website: https://www.airship.com/ + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/ba6dde79-7795-4244-866f-bad97143ad19.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/d2db5588-db19-4296-bd6e-087d33218657.svg + categories: + primary: SMS & Push Notifications + secondary: Email Marketing + additional: + - Marketing Automation + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: appKey + display_name: App Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Airship generated string identifying the app setup. Used in the application + bundle. + settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Airship generated string identifying the Bearer token. + settings: [] +- name: catalog/destinations/airtable-segment-function + display_name: Airtable Segment Function + description: Segment Function template for Airtable User Feedback Template + type: STREAMING + website: https://www.segment.com + status: PUBLIC + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/76439964-4cb4-49b5-836c-bd5f168f4985.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/a15d0038-c731-469d-9f01-857835cb3bbc.svg + categories: + primary: '' + secondary: '' + additional: [] + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: You can find + settings: [] + - name: appId + display_name: App ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The ID of your Airtable base you're storing data + settings: [] +- name: catalog/destinations/alexa + display_name: Alexa + description: Get an insider's edge with Alexa's Competitive Intelligence toolkit. + Uncover opportunities for competitive advantage, benchmark any site against its + competitors and track companies over time. + type: STREAMING + website: https://www.alexa.com + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/taHbRV4TsGP64UN7upNv + mark: https://cdn.filepicker.io/api/file/jplK0HFyT5CKTc6FHkfP + categories: + primary: Analytics + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: domain + display_name: Domain + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'You can find your Domain in the Javascript snippet, it appears as + `domain: ''example.com''`' + settings: [] + - name: account + display_name: Account ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'You can find your Account ID in the Javascript snippet, it appears + as `atrk_acct: ''XXXXXXX''`.' + settings: [] +- name: catalog/destinations/algolia + display_name: Algolia + description: Send events to Algolia Insights API + type: STREAMING + website: https://www.algolia.com + status: PUBLIC + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/38fb02a2-f548-453f-9cad-34b63a833849.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/d68cb0b0-03ca-4f66-be46-dea5117b9d93.svg + categories: + primary: A/B Testing + secondary: Analytics + additional: + - Personalization + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: appId + display_name: App ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The ID of your Algolia Application + settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: The Search API Key of your Algolia Application + settings: [] +- name: catalog/destinations/amazon-eventbridge + display_name: Amazon EventBridge + description: AWS EventBridge is a set of APIs for AWS CloudWatch Events that make + it easy for SaaS providers to inject events for their customers to process inside + AWS. + type: STREAMING + website: https://aws.amazon.com/eventbridge + status: PUBLIC_BETA + logos: + logo: https://cdn.filepicker.io/api/file/dP7fEclnT0Gq6Rq2FIZC + mark: https://cdn.filepicker.io/api/file/aOyvwBpXRUOoeEPETStK + categories: + primary: Raw Data + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: accountId + display_name: AWS Account ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The ID of the AWS Account you'd like us to send data to. + settings: [] + - name: region + display_name: Region + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The EventBridge Firehose AWS region key. + settings: [] +- name: catalog/destinations/amazon-kinesis + display_name: Amazon Kinesis + description: Amazon Kinesis Streams enables you to build custom applications that + process or analyze streaming data for specialized needs. Amazon Kinesis Streams + can continuously capture and store terabytes of data per hour from hundreds of + thousands of sources such as website clickstreams, financial transactions, social + media feeds, IT logs, and location-tracking events. + type: STREAMING + website: https://aws.amazon.com/kinesis/streams/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/qr7D6jkLQvd1KAJlY8Zp + mark: https://cdn.filepicker.io/api/file/zLZbfcBeSZTfX4CsgBvA + categories: + primary: Analytics + secondary: Raw Data + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: region + display_name: AWS Kinesis Stream Region + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The Kinesis Stream's AWS region key + settings: [] + - name: roleAddress + display_name: Role Address + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: 'The address of the AWS role that will be writing to Kinesis (ex: + arn:aws:iam::874699288871:role/example-role)' + settings: [] + - name: secretId + display_name: Secret ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: If you have so many sources that it's impractical to attach all of + their source IDs as external IDs to your IAM role, you can specify a single + external ID here instead and attach that as an external ID to your IAM role. + This value is a secret and should be treated as a password. + settings: [] + - name: stream + display_name: AWS Kinesis Stream Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The Kinesis Stream Name + settings: [] + - name: useMessageId + display_name: Use Segment Message ID + type: BOOLEAN + deprecated: false + required: false + description: You can enable this option if you want to use the Segment generated + `messageId` for the **Partition Key**. If you have issues with too many `provisionedthroughputexceededexceptions` + errors, this means that your Segment events are not being evenly distributed + across your buckets as you do not have even user event distribution (*default + partition key is `userId` or `anonymousId`*). This option should provide much + more stable and even distribution. + settings: [] +- name: catalog/destinations/amazon-kinesis-firehose + display_name: Amazon Kinesis Firehose + description: Amazon Kinesis Firehose is the easiest way to load streaming data into + AWS. It can capture, transform, and load streaming data into Amazon Kinesis Analytics, + Amazon S3, Amazon Redshift, and Amazon Elasticsearch Service, enabling near real-time + analytics with existing business intelligence tools and dashboards you’re already + using today. It is a fully managed service that automatically scales to match + the throughput of your data and requires no ongoing administration. It can also + batch, compress, and encrypt the data before loading it, minimizing the amount + of storage used at the destination and increasing security. + type: STREAMING + website: https://aws.amazon.com/kinesis/firehose/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/dwrqx5y3SkWpwizgNrsA + mark: https://cdn.filepicker.io/api/file/nIQL5EGWQqe7MIMWO0kX + categories: + primary: Analytics + secondary: Raw Data + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: mappedStreams + display_name: Map Segment Events to Firehose Delivery Streams + type: MIXED + deprecated: false + required: false + description: Please input the Segment **event names** or **event types** on the + left and the desired Firehose delivery stream destinations on the right. This + mapping is required for all events you would like in Firehose + settings: + - name: mappings + display_name: Map Segment Events to Firehose Delivery Streams + type: MAP + deprecated: false + required: false + description: Please input the Segment **event names** or **event types** on + the left and the desired Firehose delivery stream destinations on the right. + This mapping is required for all events you would like in Firehose + settings: [] + - name: region + display_name: AWS Kinesis Firehose Region + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The Kinesis Firehose AWS region key + settings: [] + - name: roleAddress + display_name: Role Address + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'The address of the AWS role that will be writing to Kinesis Firehose + (ex: arn:aws:iam::874699288871:role/example-role)' + settings: [] + - name: secretId + display_name: Secret ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: If you have so many sources that it's impractical to attach all of + their source IDs as external IDs to your IAM role, you can specify a single + external ID here instead and attach that as an external ID to your IAM role. + This value is a secret and should be treated as a password. + settings: [] +- name: catalog/destinations/amazon-lambda + display_name: Amazon Lambda + description: Amazon Lambda lets you run code without provisioning or managing servers. + You pay only for the compute time you consume - there is no charge when your code + is not running. + type: STREAMING + website: https://aws.amazon.com/lambda/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/4R854M1aSqS8Ulpmzs6v + mark: https://cdn.filepicker.io/api/file/gRmECESRRZiqkIxjbjeq + categories: + primary: Raw Data + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: externalId + display_name: External ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: This is an optional string Segment will use to assume the role provided + to invoke the Lambda function. If this setting is not defined, we'll use the + Source ID. For more information about external IDs while assuming AWS roles, + check [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html). + settings: [] + - name: function + display_name: Lambda + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: |- + The name of the Lambda function to invoke. These are the supported name formats: + + * Function name (`my-function`) or with alias (`my-function:v1`). + * Function ARN (`arn:aws:lambda:us-west-2:123456789012:function:my-function`). + * Partial ARN (`123456789012:function:my-function`). + + You can append a version number or alias to any of the formats. + settings: [] + - name: region + display_name: Region + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: AWS Region where the lambda lives. E.G. `us-west-2`, `eu-west-3` + settings: [] + - name: clientContext + display_name: Client Context + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: [] + description: An optional map to pass to the Lambda function. See [AWS Lambda documentation](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) + for more information. + settings: [] + - name: logType + display_name: Log Type + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - None + - Tail + description: |- + Lambda [log type](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax). By default `None`. + + Select `Tail` if you would like to see detailed logs in Cloud Watch. + settings: [] + - name: roleAddress + display_name: Role Address + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'The address of the AWS role that will be invoking Lambda (ex: `arn:aws:iam::874699288871:role/example-role`).' + settings: [] +- name: catalog/destinations/amazon-personalize + display_name: Amazon Personalize + description: Amazon Personalize is a machine learning service that makes it easy + for developers to create individualized recommendations for customers using their + applications. + type: STREAMING + website: https://aws.amazon.com/personalize/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/qlQiTGC9QVOAdSGSgvES + mark: https://cdn.filepicker.io/api/file/xq0IiYdQL6fTigF2XkSC + categories: + primary: Personalization + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: roleAddress + display_name: Role Address + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'The address of the AWS role that will be invoking Lambda (ex: `arn:aws:iam::874699288871:role/example-role`).' + settings: [] + - name: function + display_name: Lambda + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: |- + The name of the Lambda function to invoke. These are the supported name formats: + + * Function name (`my-function`) or with alias (`my-function:v1`). + * Function ARN (`arn:aws:lambda:us-west-2:123456789012:function:my-function`). + * Partial ARN (`123456789012:function:my-function`). + + You can append a version number or alias to any of the formats. + settings: [] + - name: logType + display_name: Log Type + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - None + - Tail + description: |- + Lambda [log type](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax). By default `None`. + + Select `Tail` if you would like to see detailed logs in Cloud Watch. + settings: [] + - name: region + display_name: Region + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: AWS Region where the lambda lives. If it is not defined, we'll use + `us-west-2` by default. + settings: [] + - name: externalId + display_name: External ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: This is an optional string Segment will use to assume the role provided + to invoke the Lambda function. If this setting is not defined, we'll use the + Source ID. For more information about external IDs while assuming AWS roles, + check [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html). + settings: [] + - name: clientContext + display_name: Client Context + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: [] + description: An optional map to pass to the Lambda function. See [AWS Lambda documentation](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) + for more information. + settings: [] +- name: catalog/destinations/amazon-s3 + display_name: Amazon S3 + description: Our Amazon S3 copies our log files of your raw API calls from our S3 + bucket to yours, where you can then perform custom analysis on them. + type: STREAMING + website: http://aws.amazon.com/s3 + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/amazon-s3-default.svg + mark: https://cdn.filepicker.io/api/file/R1EKddJ1SnGECiHtdUlY + categories: + primary: Analytics + secondary: Raw Data + additional: [] + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: bucket + display_name: Bucket Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your S3 bucket name. + settings: [] + - name: useServerSideEncryption + display_name: Use Server Side Encryption? + type: BOOLEAN + deprecated: false + required: false + description: If you enable this setting, the data we copy to your bucket will + be encrypted at rest using S3-Managed encryption keys. For more information, + see [here](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html). + settings: [] +- name: catalog/destinations/ambassador + display_name: Ambassador + description: Ambassador allows companies to easily create, track & manage custom + incentives that drive referrals and evangelize their users. + type: STREAMING + website: https://www.getambassador.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/ambassador-default.svg + mark: https://cdn.filepicker.io/api/file/jQNYYdyGQGqLZ6sLPs41 + categories: + primary: Referrals + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: campaigns + display_name: Campaigns + type: MAP + deprecated: false + required: false + description: Each campaign runs at a specific url like /share or /invite. Map + that url on the left to the Ambassador campaign for that page on the right. + settings: [] + - name: events + display_name: Events + type: MAP + deprecated: false + required: false + description: A mapping of custom events you'd like to pass through to Ambassador + to the corresponding Ambassador event type. For example, if you want to track + an Ambassador conversion, add your event name on the left and "conversion" on + the right. + settings: [] + - name: uid + display_name: Client ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'You can find your Client ID in your Ambassador dashboard by clicking + on Editor in the navigation pane along the left-hand side of the page. On the + following page, click the ''Here you go'' link next to ''Need the code snippet + or credentials?'' and copy the value shown under ID. It should be 32 characters + long, and look something like this: 012345ab-c0d1-110e-1f0g-h1234ij5kl6m.' + settings: [] +- name: catalog/destinations/amplitude + display_name: Amplitude + description: Amplitude is an event tracking and segmentation platform for your web + and mobile apps. By analyzing the actions your users perform, you can gain a better + understanding to drive retention, engagement, and conversion. + type: STREAMING + website: http://amplitude.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/amplitude-default.svg + mark: https://cdn.filepicker.io/api/file/Nmj7LgOQR62rdAmlbnLO + categories: + primary: Analytics + secondary: '' + additional: [] + components: + - type: WEB + - type: IOS + - type: ANDROID + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: true + browserUnbundlingPublic: true + settings: + - name: trackNamedPages + display_name: Track Named Pages to Amplitude + type: BOOLEAN + deprecated: false + required: false + description: This will track events to Amplitude for [`page` method](https://segment.io/libraries/analytics.js#page) + calls that have a `name` associated with them. For example `page('Signup')` + would translate to **Viewed Signup Page**. Remember that `name` includes `category`, + so `page('Conversion', 'Signup')` would translate to a **Viewed Conversion Signup + Page** event in Amplitude. + settings: [] + - name: useLogRevenueV2 + display_name: Use Log Revenue V2 API + type: BOOLEAN + deprecated: false + required: false + description: 'Use Amplitude''s logRevenueV2 API, which allows for the tracking + of event properties with the revenue event. Track an event with "price" and + "quantity" properties, and it will log total revenue = price * quantity. You + may also set a revenueType property to designate the type of revenue (ex: purchase, + refund, etc). Negative prices can be used to indicate revenue lost.' + settings: [] + - name: deviceIdFromUrlParam + display_name: Set Device ID From URL Parameter amp_device_id + type: BOOLEAN + deprecated: false + required: false + description: If true, the SDK will parse device ID values from url parameter `amp_device_id` + if available. + settings: [] + - name: preferAnonymousIdForDeviceId + display_name: Prefer Anonymous ID for Device ID + type: BOOLEAN + deprecated: false + required: false + description: |- + By default, Segment will use `context.device.id` as the Amplitude `device_id`, using `anonymousId` if `context.device.id` isn't present. + + Enable this setting to flip this behavior; `anonymousId` will be used as the `device_id`, falling back to `context.device.id` if it isn't present. + + In browsers, enabling this setting means the user's anonymous ID, which you can set using `analytics.user().anonymousId('ID_GOES_HERE')`, will be set as the Amplitude device ID. Otherwise, Amplitude's default logic for determining device IDs will be used. + settings: [] + - name: mapQueryParams + display_name: Map Query Params to Custom Property + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - user_properties + - event_properties + description: When sending data via server side or Cloud Mode, you can send the + custom query params that are automatically collected by `analytics.js` (or whatever + you manually send under `context.page.search`), by entering a custom property + name you would like to map that under on the left hand side. On the right hand + side, please choose whether you want the query params to be set on the user + profile or event metadata level. Whatever you put on the left hand side we will + map the entire query parameters string from the `context.page.url`. + settings: [] + - name: appendFieldsToEventProps + display_name: Append Fields To Event Properties + type: MAP + deprecated: false + required: false + description: Web and server-side only. Configure event fields to be appended to + `event_props` for all track calls. For example, entering `context.page.title` + on the left and `pageTitle` on the right will set the value of `context.page.title` + at `event_properties.pageTitle`. + settings: [] + - name: eventUploadPeriodMillis + display_name: Event Upload Period Millis (for batching events) + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: Amount of time in milliseconds that the SDK waits before uploading + events if `batchEvents` is `true`. + settings: [] + - name: forceHttps + display_name: Force Https + type: BOOLEAN + deprecated: false + required: false + description: If true, the events will always be uploaded to HTTPS endpoint. Otherwise + the SDK will use the embedding site's protocol. + settings: [] + - name: groupValueTrait + display_name: Group Value Trait + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: What trait Segment should use as your Amplitude "group value" in + group calls. If, for example, you set this to be `plan`, then `traits["plan"]` + will be sent as `groupValue` to Amplitude. + settings: [] + - name: trackGclid + display_name: Track GCLID + type: BOOLEAN + deprecated: false + required: false + description: If true, captures the gclid url parameter as well as the user's initial_gclid + via a set once operation. + settings: [] + - name: trackRevenuePerProduct + display_name: Track Revenue Per Product + type: BOOLEAN + deprecated: false + required: false + description: Client and server only. This setting allows you to specify whether + you would like to track an Amplitude Revenue event per individual product in + a user transaction or a single Revenue event for the combined revenue of all + products. This setting is only relevant if you are using our eCommerce spec + and passing us an Order Completed event with a list of products. + settings: [] + - name: traitsToAppend + display_name: Traits to Append + type: LIST + deprecated: false + required: false + description: 'Server-Side and Mobile Only. Configure values to be appended to + the user property array via identify.traits. ' + settings: [] + - name: enableLocationListening + display_name: Enable Location Listening + type: BOOLEAN + deprecated: false + required: false + description: 'Mobile Only. If a user has granted your app location permissions, + enable this setting so that the SDK will also grab the location of the user. + Amplitude will never prompt the user for location permission, so this must be + done by your app. ' + settings: [] + - name: eventUploadThreshold + display_name: Event Upload Threshold (for batching events) + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: Minimum number of events to batch together per request if `batchEvents` + is `true`. + settings: [] + - name: trackUtmProperties + display_name: Track UTM Properties to Amplitude. + type: BOOLEAN + deprecated: false + required: false + description: This will track UTM properties found in the querystring to Amplitude + (only for Device mode). + settings: [] + - name: traitsToIncrement + display_name: Traits To Increment + type: LIST + deprecated: false + required: false + description: Server-Side and Mobile Only. Configure `trait` to increment on identify. + If the trait is present, it will increment the trait given the numerical value + passed in when you call `identify` with the trait. + settings: [] + - name: useCustomAmplitudeProperties + display_name: Send Custom Language and Country Properties + type: BOOLEAN + deprecated: false + required: false + description: 'Enable this option if you want to send additional ''language'' and + ''country'' parameters inside of event_properties. This is separate from the + language and country collected from your user''s context. (For example, you + want to send the language that a video is played in). You can send these in + your properties, for example: `analytics.track(''Video Played'', {language: + ''Japanese''});`' + settings: [] + - name: secretKey + display_name: Secret Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Your Amplitude Secret Key (Only needed for user deletion) + settings: [] + - name: sendAlias + display_name: Enable Alias + type: BOOLEAN + deprecated: false + required: false + description: Server-Side Only. Enabling this setting allows your Amplitude destination + instance to send `alias` events to Amplitude's `usermap` endpoint. By default, + Segment's Amplitude integration does not support `alias`, so when this setting + is disabled, your Segment Amplitude destination will reject `alias` events as + unsupported. + settings: [] + - name: trackCategorizedPages + display_name: Track Categorized Pages to Amplitude + type: BOOLEAN + deprecated: false + required: false + description: This will track events to Amplitude for [`page` method](https://segment.io/libraries/analytics.js#page) + calls that have a `category` associated with them. For example `page('Docs', + 'Index')` would translate to **Viewed Docs Page**. + settings: [] + - name: traitsToPrepend + display_name: Traits to Prepend + type: LIST + deprecated: false + required: false + description: 'Server-Side and Mobile Only. Configure values to be prepended to + the user property array via identify.traits. ' + settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[a-z0-9]{32}$" + description: You can find your API Key on your Amplitude [Settings page](https://amplitude.com/settings). + settings: [] + - name: saveParamsReferrerOncePerSession + display_name: Save Referrer, URL Params, GCLID Once Per Session + type: BOOLEAN + deprecated: false + required: false + description: If true then includeGclid, includeReferrer, and includeUtm will only + track their respective properties once per session. New values that come in + during the middle of the user's session will be ignored. Set to false to always + capture new values. + settings: [] + - name: groupTypeTrait + display_name: Group Type Trait + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: What trait Segment should use as your Amplitude "group type" in group + calls. If, for example, you set this to be `industry`, then `traits["industry"]` + will be sent as `groupType` to Amplitude. + settings: [] + - name: sendToBatchEndpoint + display_name: Send To Batch Endpoint + type: BOOLEAN + deprecated: false + required: false + description: 'Server-Side Only. If true, events are sent to Amplitude''s `batch` + endpoint rather than to their `httpapi` endpoint. Because Amplitude''s `batch` + endpoint throttles traffic less restrictively than the Amplitude `httpapi` endpoint, + enabling this setting may help to reduce 429s - or throttling errors - from + Amplitude. Amplitude''s `batch` endpoint throttles data only when the rate of + events sharing the same `user_id` or `device_id` exceeds an average of 1,000/second + over a 30-second period. More information about Amplitude''s throttling is available + here in their docs: https://developers.amplitude.com/#429s-in-depth.' + settings: [] + - name: traitsToSetOnce + display_name: Traits to Set Once + type: LIST + deprecated: false + required: false + description: 'Server-Side and Mobile Only. Configure values to be set only once + via identify.traits. ' + settings: [] + - name: trackAllPages + display_name: Track All Pages to Amplitude + type: BOOLEAN + deprecated: false + required: false + description: This will track **Loaded a Page** events to Amplitude for all [`page` + method](https://segment.io/libraries/analytics.js#page) calls. We keep this + disabled by default, since Amplitude isn't generally used for pageview tracking. + settings: [] + - name: trackAllPagesV2 + display_name: Track All Screens + type: BOOLEAN + deprecated: false + required: false + description: Mobile only. Sends a "Loaded Screen" event and the screen name as + a property to Amplitude. Moving forward, this is the preferred method of tracking + screen events in Amplitude. + settings: [] + - name: trackSessionEvents + display_name: Track Session Events to Amplitude + type: BOOLEAN + deprecated: false + required: false + description: "(Optional) This enables the sending of start and end session events + for mobile products. Amplitude's libraries track sessions automatically and + this option is not necessary for session tracking. " + settings: [] + - name: useAdvertisingIdForDeviceId + display_name: Use AdvertisingId for DeviceId + type: BOOLEAN + deprecated: false + required: false + description: Mobile Only (will *not* work in cloud-mode). Allows users to use + advertisingIdentifier instead of identifierForVendor as the Device ID. + settings: [] + - name: batchEvents + display_name: Batch Events + type: BOOLEAN + deprecated: false + required: false + description: If true, events are batched together and uploaded only when the number + of unsent events is greater than or equal to `eventUploadThreshold` or after + `eventUploadPeriodMillis` milliseconds have passed since the first unsent event + was logged. + settings: [] + - name: trackReferrer + display_name: Track Referrer to Amplitude + type: BOOLEAN + deprecated: false + required: false + description: Enabling this will send referrer information as a user property to + Amplitude when you call Segment's `page` method. + settings: [] +- name: catalog/destinations/app-one-img-src-onerroralert41 + display_name: app-one-img-src-onerroralert41 + description: App description '"> + type: STREAMING + website: http://www.segment.com + status: PUBLIC + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/58077d0e-952b-4bba-8e10-6993c9ae1488.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/ef322aac-4098-41d0-889d-ebe4d6105209.svg + categories: + primary: '' + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Find your API key in '">{{1338-1}}! + settings: [] +- name: catalog/destinations/app-three + display_name: app-three + description: Third App + type: STREAMING + website: https://www.segment.com + status: PUBLIC + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/51028925-3f53-4c2b-9668-8f1637c12f51.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/61936a1f-4a8e-4229-9e1e-4d42d1bdd5e5.svg + categories: + primary: '' + secondary: '' + additional: [] + components: [] + platforms: + browser: false + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Instructionz + settings: [] +- name: catalog/destinations/app-two + display_name: app-two + description: Testing, please disregard! Testing, please disregard! Testing, please + disregard! Testing, please disregard! Testing, please disregard! + type: STREAMING + website: https://www.segment.com + status: PUBLIC + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/f25b256a-8363-4e97-a59f-185829ca04fc.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/cf465178-f082-4914-864d-f01348746b58.svg + categories: + primary: '' + secondary: '' + additional: [] + components: [] + platforms: + browser: false + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: API Key Instructions + settings: [] +- name: catalog/destinations/appboy + display_name: Braze + description: Braze lets you understand, engage, monetize and maximize the lifetime + value of your app users. + type: STREAMING + website: https://www.braze.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/9kBQvmLRR22d365ZqKRK + mark: https://cdn.filepicker.io/api/file/HrjOOkkLR8WrUc1gEeeG + categories: + primary: SMS & Push Notifications + secondary: CRM + additional: + - Email Marketing + components: + - type: WEB + - type: IOS + - type: ANDROID + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: true + browserUnbundlingPublic: true + settings: + - name: enableHtmlInAppMessages + display_name: Enable HTML In-App Messages + type: BOOLEAN + deprecated: false + required: false + description: "**Web only**: Enabling this option will allow Braze dashboard users + to write HTML In-App messages. Check out [Braze Documentation](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#.initialize) + for more information on this setting. **This setting is only applicable if you + are using version 2 of the Braze Web SDK.**" + settings: [] + - name: enableLogging + display_name: Enable Logging + type: BOOLEAN + deprecated: false + required: false + description: "**Web Only:** Set to true to enable logging by default. Note that + this will cause Braze to log to the javascript console, which is visible to + all users! You should probably remove this or provide an alternate logger with + [appboy.setLogger()](https://js.appboycdn.com/web-sdk/2.0/doc/module-appboy.html#.setLogger) + before you release your page to production. **This setting is only applicable + if you are using version 2 of the Braze Web SDK.**" + settings: [] + - name: openInAppMessagesInNewTab + display_name: Open In-App Messages In New Tab + type: BOOLEAN + deprecated: false + required: false + description: By default, links from in-app message clicks load in the current + tab or a new tab as specified in the dashboard on a message-by-message basis. + Set this option to true to force all links from in-app message clicks open in + a new tab or window. **This setting is only applicable if you are using version + 2 of the Braze Web SDK.** + settings: [] + - name: openNewsFeedCardsInNewTab + display_name: Open News Feed Cards In New Tab + type: BOOLEAN + deprecated: false + required: false + description: By default, links from news feed cards load in the current tab or + window. Set this option to true to make links from news feed cards open in a + new tab or window. **This setting is only applicable if you are using version + 2 of the Braze Web SDK.** + settings: [] + - name: sessionTimeoutInSeconds + display_name: Session Timeout In Seconds + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: "**Web Only:** By default, sessions time out after 30 minutes of + inactivity. Provide a value for this configuration option to override that default + with a value of your own. **This setting is only applicable if you are using + version 2 of the Braze Web SDK.**\n" + settings: [] + - name: trackNamedPages + display_name: Track Only Named Pages + type: BOOLEAN + deprecated: false + required: false + description: This will send only [`page` calls](https://segment.com/docs/spec/page/) + to Braze that have a `name` associated with them. For example, `page('Signup')` + would translate to **Viewed Signup Page** in Braze. + settings: [] + - name: apiKey + display_name: App Identifier + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: The API key found in your Braze dashboard, used to identify your + application as the app identifier. (Formerly 'API Key') + settings: [] + - name: automaticallyDisplayMessages + display_name: Automatically Send In-App Messages + type: BOOLEAN + deprecated: false + required: false + description: "**Web Only**: When this is enabled, all In-App Messages that a user + is eligible for are automatically delivered to the user. If you'd like to register + your own display subscribers or send soft push notifications to your users, + make sure to disable this option." + settings: [] + - name: customEndpoint + display_name: Custom API Endpoint + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: 'If you''ve been assigned an API endpoint by the Braze team specifically + for use with their Mobile or Javascript SDKs, please input that here. It should + look something like: sdk.api.appboy.eu. Otherwise, leave this blank.' + settings: [] + - name: minimumIntervalBetweenTriggerActionsInSeconds + display_name: Minimum Interval Between Trigger Actions In Seconds + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: "**Web Only:** By default, a trigger action will only fire if at + least 30 seconds have elapsed since the last trigger action. Provide a value + for this configuration option to override that default with a value of your + own. We do not recommend making this value any smaller than 10 to avoid spamming + the user with notifications. **This setting is only applicable if you are using + version 2 of the Braze Web SDK.**" + settings: [] + - name: allowCrawlerActivity + display_name: Allow Crawler Activity + type: BOOLEAN + deprecated: false + required: false + description: "**Web Only:** By default, the Braze Web SDK ignores activity from + known spiders or web crawlers, such as Google, based on the user agent string. + This saves datapoints, makes analytics more accurate, and may improve page rank. + However, if you want Braze to log activity from these crawlers instead, you + may set this option to true." + settings: [] + - name: automatic_in_app_message_registration_enabled + display_name: Enable Automatic In-App Message Registration + type: BOOLEAN + deprecated: false + required: false + description: "**Mobile Only:** Every activity in your app must be registered with + Braze to allow it to add in-app message views to the view hierarchy. By default, + Braze's Segment integration automatically registers every activity. However, + if you would like to manually register activities, you may do so by disabling + this setting. For more information, see the Braze [documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/android/in-app_messaging/integration/#step-1-braze-in-app-message-manager-registration)." + settings: [] + - name: doNotLoadFontAwesome + display_name: Do Not Load Font Awesome + type: BOOLEAN + deprecated: false + required: false + description: "**Web Only:** Braze uses [FontAwesome](https://fontawesome.com/) + for in-app message icons. By default, Braze will automatically load FontAwesome + from https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css. + To disable this behavior (e.g. because your site uses a customized version of + FontAwesome), set this option to true. Note that if you do this, you are responsible + for ensuring that FontAwesome is loaded on your site - otherwise in-app messages + may not render correctly. **This setting is only applicable if you are using + version 2 of the Braze Web SDK.**" + settings: [] + - name: logPurchaseWhenRevenuePresent + display_name: Log Purchase when Revenue is present + type: BOOLEAN + deprecated: false + required: false + description: When this option is enabled, all Track calls with a property called + `revenue` will trigger Braze's LogRevenue event. + settings: [] + - name: safariWebsitePushId + display_name: Safari Website Push ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: "**Web Only**: To send push notifications on Safari, Braze needs + your Website Push Id. To get your Webite Push ID, check out the first two bullet + points [here](https://www.braze.com/documentation/Web/#step-5-configure-safari-push)." + settings: [] + - name: updateExistingOnly + display_name: Update Existing Users Only + type: BOOLEAN + deprecated: false + required: false + description: "**Server Side only**: A flag to determine whether to update existing + users only, defaults to false" + settings: [] + - name: version + display_name: Braze Web SDK Version + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - '1' + - '2' + description: "**Web Only:** The [major](https://semver.org/) version of the Braze + web SDK you would like to use. Please reference their [changelog](https://github.com/Appboy/appboy-web-sdk/blob/master/CHANGELOG.md) + for more info. **Please ensure you read [this](https://segment.com/docs/destinations/braze/#migrating-to-v2-of-the-braze-web-sdk) + section of our documentation carefully before changing this setting.**" + settings: [] + - name: appGroupId + display_name: REST API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: This can be found in your Braze dashboard under App Settings > Developer + Console. (Formerly 'App Group Identifier') + settings: [] + - name: datacenter + display_name: Appboy Datacenter + type: SELECT + deprecated: false + required: true + select_validators: + select_options: + - us + - us02 + - us03 + - us04 + - eu + description: Choose your Appboy Gateway (ie. US 01, US 02, EU 01, etc.). + settings: [] + - name: restCustomEndpoint + display_name: Custom REST API Endpoint + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: If you've been assigned an API endpoint by the Braze team specifically + for use with their REST API, please input that here. It should look something + like "https://foo.bar.braze.com". Otherwise, leave this blank. + settings: [] + - name: serviceWorkerLocation + display_name: Service Worker Location + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: 'Specify your `serviceWorkerLocation` as defined in the Braze Web + SDK documentation: https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html' + settings: [] + - name: trackAllPages + display_name: Track All Pages + type: BOOLEAN + deprecated: false + required: false + description: This will send all [`page` calls](https://segment.com/docs/spec/page/) + to Braze as a Loaded/Viewed a Page event. This option is disabled by default + since Braze isn't generally used for page view tracking. + settings: [] +- name: catalog/destinations/appcues + display_name: Appcues + description: Create personalized user onboarding flows without changing any code + that will improve your product's adoption and retention rates. + type: STREAMING + website: http://www.appcues.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/RO2CSvXiRZyZWIoUuh6A + mark: https://cdn.filepicker.io/api/file/lDwvVrfTG6yHeZnaV2QX + categories: + primary: Personalization + secondary: '' + additional: [] + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: "**Required for server-side integration functionality**. You can + find your API Key in your [Appcues account page](https://my.appcues.com/account)." + settings: [] + - name: appcuesId + display_name: Appcues Id + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: "**Required for client-side integration functionality**. You can + find your Appcues ID in your [Appcues account page](https://my.appcues.com/account)." + settings: [] +- name: catalog/destinations/appnexus + display_name: AppNexus + description: '' + type: STREAMING + website: http://www.appnexus.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/appnexus-default.svg + mark: https://cdn.filepicker.io/api/file/A3YvNdKgTuaEWDfebPFF + categories: + primary: Advertising + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: events + display_name: Events + type: MIXED + deprecated: false + required: false + description: Configure a pixel + settings: + - name: event + display_name: Event Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: AppNexus allows you to track both conversions and segments, when + you `analytics.track('my event')` we will map that custom event to `segment-id` + or `pixel-id` that you provided, when `conversion` is ticked we will track + a `conversion` otherwise we will track a `segment` otherwise we will track + a conversion. + settings: [] + - name: pixelId + display_name: Pixel ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Enter a Pixel ID that you want us to map to the custom event + settings: [] + - name: segmentId + display_name: Segment ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Enter a Segment ID that you want us to map to the custom event + settings: [] + - name: parameters + display_name: Query Parameters + type: MAP + deprecated: false + required: false + description: 'Enter any event properties you want to map to query parameters + in the AppNexus url. Two parameters are sent automatically: `order_id` and + the monetary `value`.' + settings: [] +- name: catalog/destinations/appsflyer + display_name: AppsFlyer + description: Mobile app measurement and tracking. + type: STREAMING + website: http://www.appsflyer.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/appsflyer-default.svg + mark: https://cdn.filepicker.io/api/file/AnJUEBvxRouLLOvIeQuK + categories: + primary: Attribution + secondary: '' + additional: [] + components: + - type: IOS + - type: ANDROID + - type: CLOUD + platforms: + browser: false + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: androidAppID + display_name: Android App ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Your Android App's ID. Find this in your AppsFlyer's 'My App' dashboard. + It should look something like 'com.appsflyer.myapp'. This is required for Android + projects if you want to send events using the server side integration. + settings: [] + - name: appleAppID + display_name: Apple App ID (iOS) + type: STRING + deprecated: false + required: false + string_validators: + regexp: "^[0-9]*$" + description: Your App's ID, which is accessible from iTunes or in AppsFlyer's + 'My App' dashboard. This is optional for Android projects, and only required + for iOS projects. + settings: [] + - name: appsFlyerDevKey + display_name: AppsFlyer Dev Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[a-zA-Z0-9]{10,30}$" + description: Your unique developer ID from AppsFlyer, which is accessible from + your AppsFlyer account. + settings: [] + - name: httpFallback + display_name: Enable HTTP fallback (Android) + type: BOOLEAN + deprecated: false + required: false + description: If selected, HTTPS calls will fallback on HTTP + settings: [] + - name: rokuAppID + display_name: Roku App ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: "**IMPORTANT**: In order to send Roku data, you **must** contact + your AppsFlyer representative as this type of data stream requires a full server + to server integration which is available but is gated as a AppsFlyer Enterprise + Customer feature. Without AppsFlyer's consent we are unable to forward your + Roku data. Your Roku App's ID. Find this in your AppsFlyer's 'My App' dashboard. + This is required for Roku projects if you want to send events using the server + side integration." + settings: [] + - name: trackAttributionData + display_name: Track Attribution Data + type: BOOLEAN + deprecated: false + required: false + description: Send attribution data to Segment and other tools as a track call + (mobile libraries only). + settings: [] +- name: catalog/destinations/apptimize + display_name: Apptimize + description: Apptimize is a technology enabling users to A/B test their native applications + on Android and iOS platforms. + type: STREAMING + website: https://apptimize.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/apptimize-default.svg + mark: https://cdn.filepicker.io/api/file/HNGcnPQ4QsCttRhPdvcR + categories: + primary: A/B Testing + secondary: Feature Flagging + additional: [] + components: + - type: IOS + - type: ANDROID + platforms: + browser: false + server: false + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: appkey + display_name: App Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your App Key on the Apptimize [settings page](https://apptimize.com/admin/settings/apps) + settings: [] + - name: listen + display_name: Send experiment data to other tools (as a track call) + type: BOOLEAN + deprecated: false + required: false + description: Sends the experiment and variation information as properties on a + track call. + settings: [] +- name: catalog/destinations/aptrinsic + display_name: Gainsight PX + description: Acquire, retain and grow customers by creating real-time, personalized + experiences driven by product usage. + type: STREAMING + website: https://www.gainsight.com/product-experience/demo/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/uhB7WUOiSDqcXXR7ittl + mark: https://cdn.filepicker.io/api/file/Zb8MLg5xRXXPLtjiHK5A + categories: + primary: Analytics + secondary: Customer Success + additional: + - Personalization + - Surveys + - Email Marketing + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: true + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Aptrinsic API Key + settings: [] +- name: catalog/destinations/asayer + display_name: Asayer + description: Asayer is session replay tool for developers. It lets you catch every + bug, improve performance and kill regressions, all in one place. + type: STREAMING + website: https://asayer.io + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/2bddafb8-3db1-40b5-879c-02029348140a.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/a354d977-7cff-4dab-a5e5-7bc616341a96.svg + categories: + primary: Analytics + secondary: Customer Success + additional: + - Performance Monitoring + - Raw Data + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The ID associated with your website. You can find in Preferences + -> Sites -> Tracking Code in your Asayer app. + settings: [] +- name: catalog/destinations/atatus + display_name: Atatus + description: Atatus provides Real User Monitoring (RUM) and advanced error tracking + for modern websites. + type: STREAMING + website: https://www.atatus.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/atatus-default.svg + mark: https://cdn.filepicker.io/api/file/SXUMgP7bQmmrG0iU5PKU + categories: + primary: Performance Monitoring + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: true + page_view: true + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: disableAjaxMonitoring + display_name: Disable AJAX Monitoring + type: BOOLEAN + deprecated: false + required: false + description: If you don't want to track the AJAX(XHR) requests in your app, then + select this option. + settings: [] + - name: enableOffline + display_name: Enable Offline Errors and Metrics + type: BOOLEAN + deprecated: false + required: false + description: Enable offline errors and metrics tracking when network connectivity + is not available. + settings: [] + - name: allowedDomains + display_name: Allowed Domains + type: LIST + deprecated: false + required: false + description: Track errors and performance metrics only from specific domains. + If this blacklist is empty, all domains will track metrics. + settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'To find your API Key, create a project in your Atatus dashboard. + The key should look something like this: `16ae323d8b3244733a981215c9d66e67d`' + settings: [] +- name: catalog/destinations/attribution + display_name: Attribution + description: Track spending and conversions across marketing channels. + type: STREAMING + website: http://attributionapp.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/attribution-default.svg + mark: https://cdn.filepicker.io/api/file/sybdw0htTTKBmrgD1jJI + categories: + primary: Attribution + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: projectId + display_name: Attribution Project Id + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your unique project ID from Attribution, which is accessible from + your Attribution account. + settings: [] +- name: catalog/destinations/auryc + display_name: Auryc + description: Auryc's visual intelligence platform empowers organizations to create + exceptional customer journeys and increase revenue. + type: STREAMING + website: https://www.auryc.com/ + status: PUBLIC_BETA + logos: + logo: https://cdn.filepicker.io/api/file/AbQFDKdStegWI8eGmZAg + mark: https://cdn.filepicker.io/api/file/rzwwg1OeRXOOxkyijkta + categories: + primary: Analytics + secondary: Heatmaps & Recordings + additional: + - Surveys + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: siteid + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your Site ID in your Auryc account. + settings: [] +- name: catalog/destinations/autopilothq + display_name: AutopilotHQ + description: Autopilot is easy-to-use software for multi-channel marketing automation + type: STREAMING + website: https://autopilothq.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/7oQp8BXS5akzQm9XINIQ + mark: https://cdn.filepicker.io/api/file/2wLIOq1URP6JDqk5dioG + categories: + primary: Email Marketing + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'Get your API key from [here](https://login.autopilothq.com/login#settings/app-connections/segment-sync) + or go to Autopilot: Settings -> App Connections -> Segment and copy/paste the + API key which is listed there.' + settings: [] +- name: catalog/destinations/azure-function + display_name: Azure Function + description: Azure Functions is a serverless compute service that enables you to + run code on-demand without having to explicitly provision or manage infrastructure. + Use Azure Functions to run a script or piece of code in response to a variety + of events. + type: STREAMING + website: https://azure.microsoft.com/en-us/services/functions + status: PUBLIC_BETA + logos: + logo: https://cdn.filepicker.io/api/file/YTpUj9JHQlWB3IZTshij + mark: https://cdn.filepicker.io/api/file/R2lShT3T7e5Gru53ZxIg + categories: + primary: Raw Data + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: httpTrigger + display_name: HTTP Trigger + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The URL to call the Google Cloud Function. It must follow the ` https://{function + app name}.azurewebsites.net/api/{function name}?code={function key}` pattern. + settings: [] +- name: catalog/destinations/batch + display_name: Batch + description: Batch is a very high-throughput push notifications and mobile CRM platform + that lets you deliver personalized content to your app and mobile websites users + via push notifications, in-app push and web push. + type: STREAMING + website: http://www.batch.com + status: PUBLIC_BETA + logos: + logo: https://cdn.filepicker.io/api/file/8G2ACsPKQAKXd7PimVmt + mark: https://cdn.filepicker.io/api/file/dIf53pwHTBWYHmzaPHPY + categories: + primary: SMS & Push Notifications + secondary: '' + additional: [] + components: + - type: IOS + - type: ANDROID + platforms: + browser: false + server: false + mobile: true + methods: + alias: false + group: true + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: canUseAdvancedDeviceInformation + display_name: Allow collection of advanced device information. + type: BOOLEAN + deprecated: false + required: false + description: Toggles whether Batch can use all of the device information it supports. + All of this info is anonymous, but some might want to disable it under strict + privacy rules. If disabled, some targeting options in your Batch.com dashboard + will stop working correctly. + settings: [] + - name: canUseAdvertisingID + display_name: Allow advertising ID collection. + type: BOOLEAN + deprecated: false + required: false + description: Toggles whether Batch is allowed to collect advertising IDs + settings: [] + - name: gcmSenderID + display_name: GCM Sender ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: 'Android only. You can find out how to get your GCM sender ID [here](https://batch.com/doc/android/prerequisites.html#_getting-your-sender-id-and-server-api-key). + Note that you shouldn''t change this value once you''ve set it: doing so will + end up in push delivery issues.' + settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: You can find your API Key in your app's settings, in the [Batch.com + dashboard](https://dashboard.batch.com) + settings: [] +- name: catalog/destinations/bing-ads + display_name: Bing Ads + description: Create campaigns and advertise your product in Bing search + type: STREAMING + website: https://advertise.bingads.microsoft.com/en-us/home + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/bing-ads-default.svg + mark: https://cdn.filepicker.io/api/file/Do3bOQnYSGmiixtUuxIY + categories: + primary: Advertising + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: tagId + display_name: Tag ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Bing Universal Event Tracking Tag ID + settings: [] +- name: catalog/destinations/blendo + display_name: Blendo + description: |- + Blendo is an ETL platform which allows you to send all your Segment data + directly to your data warehouse, for any analytics purposes. + type: STREAMING + website: https://www.blendo.co + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/2da68145-d850-425c-98b6-b622dc193c1b.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/9259828c-c40c-44e7-acd7-d8474a919782.svg + categories: + primary: Raw Data + secondary: Analytics + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Select your Segment pipeline and preview its settings for the API + Key. + settings: [] +- name: catalog/destinations/blueshift + display_name: Blueshift + description: Blueshift's predictive marketing automates behavioral messaging on + email, push notifications, display, Facebook and more + type: STREAMING + website: http://getblueshift.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/Blueshift-default.svg + mark: https://cdn.filepicker.io/api/file/Fqsz0q3QPujUyMACLPLr + categories: + primary: SMS & Push Notifications + secondary: Advertising + additional: + - Email Marketing + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your API key can be found in Account Profile > API Keys + settings: [] + - name: retarget + display_name: Retarget + type: BOOLEAN + deprecated: false + required: false + description: This will retarget page calls on the client-side + settings: [] +- name: catalog/destinations/branch-metrics + display_name: Branch Metrics + description: Branch helps mobile apps grow with deep links that power referral systems, + sharing links and invites with full attribution and analytics. + type: STREAMING + website: https://branch.io/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/Svc4UAgORe668HOiiyjd + mark: https://cdn.filepicker.io/api/file/MfCJKP6VRoaLMG7sMY5m + categories: + primary: Deep Linking + secondary: Attribution + additional: [] + components: + - type: IOS + - type: ANDROID + - type: CLOUD + platforms: + browser: false + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiSecret + display_name: Branch Secret + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Required for server-side calls. Your Branch secret can be retrieved + on the settings page of the [Branch dashboard](https://dashboard.branch.io/#/settings). + settings: [] + - name: branch_key + display_name: Branch Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Branch app key can be retrieved on the settings page of the + [Branch dashboard](https://dashboard.branch.io/#/settings). + settings: [] +- name: catalog/destinations/bronto + display_name: Bronto + description: Bronto is an advanced marketing automation platform for commerce. + type: STREAMING + website: http://www.bronto.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/MX76Rk9zS023YkjYRJq2 + mark: https://cdn.filepicker.io/api/file/nEGQhEixQlSGYOQS9TE2 + categories: + primary: Email Marketing + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your Site ID in your Bronto [Account Page](https://app.bronto.com/login/index/login/) + settings: [] + - name: host + display_name: Domain + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: You can use your own domain with Bronto + settings: [] +- name: catalog/destinations/bugherd + display_name: BugHerd + description: BugHerd is a bug tracking software that lets users report bugs right + in your interface. Once reported, you get a Trello-like management interface for + taking care of the issues. + type: STREAMING + website: http://bugherd.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/bugherd-default.svg + mark: https://cdn.filepicker.io/api/file/JlCHETRSFKLsgb9pEdHh + categories: + primary: Performance Monitoring + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[a-z0-9]{22}$" + description: You can find your API Key under the **Install BugHerd** tab on your + BugHerd [Project page](http://bugherd.com/). It will appear in your tracking + code as `?apikey=...` + settings: [] + - name: showFeedbackTab + display_name: Show the Default Feedback Tab + type: BOOLEAN + deprecated: false + required: false + description: You should only disable this setting if you want to [build your own + feedback tab](http://support.bugherd.com/entries/21497629-Create-your-own-Send-Feedback-tab) + with the BugHerd API. + settings: [] +- name: catalog/destinations/bugsnag + display_name: Bugsnag + description: Bugsnag is an error tracking service for websites and mobile apps. + It automatically captures any errors in your code so that you can find them and + resolve them as quickly as possible. + type: STREAMING + website: http://bugsnag.com + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/GoTtwMELTeWGtu44SBUh + mark: https://cdn.filepicker.io/api/file/1ttsQcwwRDGHBG3XjVFT + categories: + primary: Performance Monitoring + secondary: '' + additional: [] + components: + - type: WEB + - type: IOS + - type: ANDROID + platforms: + browser: true + server: false + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[a-z0-9]{32}$" + description: You can find your API Key on your Bugsnag [Project Settings page](https://bugsnag.com/dashboard). + settings: [] + - name: releaseStage + display_name: Release Stage + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Distinguish errors that happen in different stages of your app's + release process e.g 'production', 'development', etc. + settings: [] + - name: useSSL + display_name: Use SSL + type: BOOLEAN + deprecated: false + required: false + description: Use SSL When Sending Data to Bugsnag + settings: [] +- name: catalog/destinations/burstsms + display_name: burstsms + description: Australia’s smartest online SMS service. + type: STREAMING + website: https://www.burstsms.com.au/ + status: PUBLIC + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/f3791b90-5fd7-4686-9dd5-90e8e5e9b0ee.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/e22ba0ad-d53c-4b11-ad43-1933aaf5b20b.svg + categories: + primary: Email Marketing + secondary: Marketing Automation + additional: + - SMS & Push Notifications + - Surveys + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: The format of API Key here is equal to : which + can be found in your BurstSMS Account Setting tab + settings: [] +- name: catalog/destinations/bytegain + display_name: ByteGain + description: Send events to the ByteGain, a predictive analytics platform, leveraging + machine learning to automate retargeting, personalization and recommendations + for e-commerce, ad & marketing agencies, real estate and many other industries. + type: STREAMING + website: https://bytegain.com/ + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/62ebf847-589f-433a-a507-9489a9055e28.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/f440ae0b-f94c-42be-8391-f82050d69557.svg + categories: + primary: Personalization + secondary: Advertising + additional: + - Analytics + - CRM + - Marketing Automation + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Retrieve your ByteGain API Key from the Setup tab in the ByteGain + Dashboard + settings: [] +- name: catalog/destinations/callingly + display_name: Callingly + description: Callingly automatically gets your sales team on the phone with your + incoming leads within seconds. + type: STREAMING + website: https://callingly.com + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/dabc2fee-742d-4515-a8f6-d9325d072152.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/32e1ad5a-85fc-4d3f-b48e-16c49ea071a5.svg + categories: + primary: Marketing Automation + secondary: Performance Monitoring + additional: + - SMS & Push Notifications + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Go to the Integrations page in the Callingly Dashboard and click + Connect on the Segment integration to get your API key. + settings: [] +- name: catalog/destinations/calq + display_name: Calq + description: Advanced custom analytics for mobile and web applications + type: STREAMING + website: https://calq.io/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/calq-default.svg + mark: https://cdn.filepicker.io/api/file/lVoOHitVTsCb57PTPImA + categories: + primary: Analytics + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: false + server: true + mobile: true + methods: + alias: true + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: writeKey + display_name: Write Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your Write Key in the top left corner of the page under + Project Settings + settings: [] +- name: catalog/destinations/candu + display_name: Candu + description: Candu is a learning platform in your app. Candu embeds courses and + just-in-time training in web apps, enabling you to upskill and retain your customers. + type: STREAMING + website: https://candu.ai + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/809b7fb8-9644-44f1-8396-817ab2b74929.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/03f0c75f-6fa8-44e9-96b2-8c6a13ea24f3.svg + categories: + primary: Customer Success + secondary: Personalization + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: '' + settings: [] +- name: catalog/destinations/castle + display_name: Castle + description: Castle uses customer behavioral data to predict which users are likely + a security or fraud risk. + type: STREAMING + website: http://www.castle.io/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/castle-default.svg + mark: https://cdn.filepicker.io/api/file/C8J91fmdTveqfSKgWXuB + categories: + primary: Security & Fraud + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: autoPageview + display_name: Automatic Page tracking + type: BOOLEAN + deprecated: false + required: false + description: When you enable automatic page tracking, Castle will track a page + view whenever the url of the site changes as opposed to mapping explicitly to + your implementation of Segment `.page()` calls. + settings: [] + - name: cookieDomain + display_name: Custom Cookie Domain + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: If your authenticated area is located at a different domain, use + the cookie domain setting to change on which url the cookie is set. + settings: [] + - name: publishableKey + display_name: API Publishable Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'You can find your publishable key under **Settings** in the Castle + dashboard. It should look something like this: `pk_KmoUyttyEiHCdFTWSqhAF1SL1z9Fi1yg`. + This is required and will be used to initialize Castle''s library on your device + as well as when you make mobile/server calls through our server side integration.' + settings: [] +- name: catalog/destinations/chameleon + display_name: Chameleon + description: Chameleon is a platform to build better user onboarding without writing + code. You can create, test, personalize and measure product tours for your web + application. + type: STREAMING + website: http://www.trychameleon.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/chameleon-default.svg + mark: https://cdn.filepicker.io/api/file/wYJH1fRTS06duZylIuwa + categories: + primary: Personalization + secondary: '' + additional: [] + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: '' + settings: [] + - name: accountId + display_name: Account Id + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: '' + settings: [] +- name: catalog/destinations/chartbeat + display_name: Chartbeat + description: Chartbeat is a real-time dashboard for your team. It lets you see how + many users are browsing around the different parts of your site in real-time! + type: STREAMING + website: http://chartbeat.com + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/mUlDNhZOSZG1oxxWN5i3 + mark: https://cdn.filepicker.io/api/file/0b6B4tpjRtW8TD3K6FsA + categories: + primary: Analytics + secondary: Video + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: domain + display_name: Domain + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^(?!www\\.)" + description: The same domain name you entered when adding your site's dashboard + to Chartbeat. Don't include the `www.` because Chartbeat handles that for you + automatically. + settings: [] + - name: sendNameAndCategoryAsTitle + display_name: sendNameAndCategoryAsTitle + type: BOOLEAN + deprecated: false + required: false + description: "[Chartbeat expects](http://support.chartbeat.com/docs/#titles) the + `document.title` ( Segment `page`'s `props.title`) to populate as *title*. \n
\n
\n\nThis + setting respects Segment's legacy behavior of setting the page name and category + as *title* for existing users, but defaults new users to the correct behavior + of sending `document.title` as *title* to Chartbeat, and allows current users + to opt-in to the correct behavior if they chose. \n\n" + settings: [] + - name: uid + display_name: UID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^\\d+$" + description: You can find your UID on the Chartbeat [Adding The Code](https://chartbeat.com/docs/adding_the_code/) + page. + settings: [] + - name: video + display_name: Use Chartbeat Video Script + type: BOOLEAN + deprecated: false + required: false + description: If you select this option, we'll load `chartbeat_video.js` instead + of `chartbeat.js`. The video library has the ability to listen for play/pause + events from HTML5 `video` tags and common 3rd party video players. + settings: [] +- name: catalog/destinations/churnzero + display_name: ChurnZero + description: ChurnZero is the Customer Success Platform built for growing SaaS and + subscription businesses. + type: STREAMING + website: https://churnzero.net/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/MMeQCmLyQEeSDnw1fYnT + mark: https://public-segment-devcenter-production.s3.amazonaws.com/637c618b-e08d-4e02-8715-3011a112421c.svg + categories: + primary: Customer Success + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: You can find it under the side nav bar, Admin -> Application Keys + section. + settings: [] +- name: catalog/destinations/clearbit-enrichment + display_name: Clearbit Enrichment + description: Clearbit Enrichment automatically enriches any user with data about + the person and company. Use the data to automatically add valuable insights to + your analytics and power marketing automation. + type: STREAMING + website: https://clearbit.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/5YSUaVUbSsmkOmLsoS2u + mark: https://cdn.filepicker.io/api/file/i0PsWtFJSGS5LmpQhIt1 + categories: + primary: Enrichment + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your secret key (prepended with `sk_`) associated with your + Clearbit account. + settings: [] +- name: catalog/destinations/clearbit-reveal + display_name: Clearbit Reveal + description: Clearbit Reveal automatically enriches anonymous web traffic by linking + visitor IP addresses with specific companies. See which companies are browsing + your site in real-time, and use that data for analytics, advertising, and attribution. + type: STREAMING + website: https://clearbit.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/gshHBRZ5QUCklVYRJCfc + mark: https://cdn.filepicker.io/api/file/gOzgg71MRjWXEX7RlI3D + categories: + primary: Enrichment + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: false + page_view: true + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: writeKeyAllowed + display_name: writeKeyAllowed + type: BOOLEAN + deprecated: false + required: false + description: '' + settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your API Key associated with your Clearbit Reveal account. + settings: [] +- name: catalog/destinations/clearbrain + display_name: ClearBrain + description: 'ClearBrain provides self-serve predictive analytics for growth marketers. + Enable this destination to automatically transform your data for predictive modeling + and automated audience insights. + +' + type: STREAMING + website: https://clearbrain.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/IJUcy6zeTe6vwxccSSZr + mark: https://cdn.filepicker.io/api/file/l7pkhoSQXCdWUCwWYk4j + categories: + primary: Personalization + secondary: Marketing Automation + additional: + - Analytics + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: false + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: The API key can be found in your ClearBrain account, by clicking + on your active Segment connection in the "Connections" page. + settings: [] +- name: catalog/destinations/clevertap + display_name: CleverTap + description: CleverTap lets you understand behavior down to the individual, segment + based on activity, and reach each user in the moment, as they interact with your + App. Deliver personalized messaging with Push, InApp, Web, Email or retargeting + campaigns. + type: STREAMING + website: https://clevertap.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/clevertap-default.svg + mark: https://cdn.filepicker.io/api/file/7B58uDCOTwGBRTFbcDek + categories: + primary: SMS & Push Notifications + secondary: Analytics + additional: [] + components: + - type: WEB + - type: IOS + - type: ANDROID + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: region + display_name: Region + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - '' + - in. + description: "**Server Only**: Your dedicated Clevertap region." + settings: [] + - name: clevertap_account_id + display_name: Account ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Add your CleverTap Account ID which you can find in the CleverTap + Dashboard under Settings. + settings: [] + - name: clevertap_account_token + display_name: Account Token + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: "**Mobile Only:**Add your CleverTap Account Token which you can find + in the CleverTap Dashboard under Settings." + settings: [] +- name: catalog/destinations/clicky + display_name: Clicky + description: Clicky is a general-purpose, free analytics tool that gives you access + to lots of the same features as Google Analytics. It also comes with a real-time + dashboard. + type: STREAMING + website: http://clicky.com/100566366 + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/clicky-default.svg + mark: https://cdn.filepicker.io/api/file/RFbSlcFXTviwsah6T6Je + categories: + primary: Analytics + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^\\d+$" + description: You can find your Site ID under the **Preferences** tab on your [Clicky + account](http://clicky.com/100566366). + settings: [] +- name: catalog/destinations/clientsuccess + display_name: ClientSuccess + description: ClientSuccess develops a customer success management platform to revolutionize + the way companies manage, retain, and grow their existing customer base + type: STREAMING + website: http://clientsuccess.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/clientsuccess-default.svg + mark: https://cdn.filepicker.io/api/file/7wqqN8ZPTxnOjzm0uhRZ + categories: + primary: Customer Success + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your API key in ClientSuccess under the top right menu, + Apps & Integrations > Usage + settings: [] + - name: apiSecret + display_name: Project Id + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your Project Id in ClientSuccess under the top right + menu, Apps & Integrations > Usage + settings: [] +- name: catalog/destinations/comscore + display_name: comScore + description: comScore's Media Metrix Multi-Platform is an audience measurement and + planning tool that lets you see demographic data about your website or mobile + app visitors. MMx MP helps you to know what your visitor audiences look like, + making them known to advertisers and agencies. + type: STREAMING + website: http://comscore.com + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/XM2ggMweTkliGImSg1Td + mark: https://cdn.filepicker.io/api/file/1722B3EeQ6wPETOvS5ZA + categories: + primary: Video + secondary: Analytics + additional: [] + components: + - type: WEB + - type: IOS + - type: ANDROID + platforms: + browser: true + server: false + mobile: true + methods: + alias: false + group: false + identify: false + page_view: true + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: c2 + display_name: c2 ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^\\d+$" + description: You can find your `c2` option when you enter your domain and press + **Get Tag** at [comScore Direct](http://direct.comscore.com/clients/Default.aspx). + The `c2` option is on line 4 of the **Tag Code**. + settings: [] + - name: foregroundOnly + display_name: Only Auto Update when app in foreground. + type: BOOLEAN + deprecated: false + required: false + description: When Auto Update is Enabled, this setting determines whether usage + date will be sent only when the app is in the foreground. If your app can provide + a user experience from the background, like Push Notifications, then you'll + want to set this to false. + settings: [] + - name: publisherSecret + display_name: Publisher Secret + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: You can find your `Publisher Secret` option when you enter your domain + and press **Get Tag** at [comScore Direct](http://direct.comscore.com/clients/Default.aspx). + settings: [] + - name: useHTTPS + display_name: Use HTTPS + type: BOOLEAN + deprecated: false + required: false + description: If true, this will ensure all data is sent to comScore via HTTPS. + settings: [] + - name: appName + display_name: App Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: This parameter will be sent along with payloads to identify which + app the tags and data are coming from. + settings: [] + - name: autoUpdate + display_name: Auto Update + type: BOOLEAN + deprecated: false + required: false + description: Auto Update allows the comScore SDK to automatically send usage updates + to comScore. + settings: [] + - name: autoUpdateInterval + display_name: Auto Update Interval + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: If Auto Update is enabled, this sets how many seconds in between + auto updates. + settings: [] + - name: beaconParamMap + display_name: Beacon Param Map + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: c + select_options: [] + description: Map Segment event properties to comScore Beacon parameters. + settings: [] +- name: catalog/destinations/convertflow + display_name: ConvertFlow + description: ConvertFlow is the all-in-one platform for converting your website + visitors. From one builder, you can create, personalize and launch dynamic website + content, forms, popups, sticky bars, surveys, quizzes and landing pages, without + coding. + type: STREAMING + website: https://www.convertflow.com/ + status: PUBLIC_BETA + logos: + logo: https://cdn.filepicker.io/api/file/HpCep88TuOZuYHPAl4DA + mark: https://cdn.filepicker.io/api/file/Nr3TkYzsT1GuPO4muFNK + categories: + primary: Personalization + secondary: A/B Testing + additional: + - Surveys + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: true + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: websiteId + display_name: Website ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can retrieve your Website ID from your [ConvertFlow Account](https://app.convertflow.com/) + by selecting a website and copying the ID within your URL (eg. https://app.convertflow.com/websites/4915/) + settings: [] +- name: catalog/destinations/convertro + display_name: Convertro + description: Convertro helps marketers understand where to allocate budget across + channels at the most granular level, to maximize ad performance and accelerate + growth + type: STREAMING + website: http://www.convertro.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/convertro-default.svg + mark: https://cdn.filepicker.io/api/file/MOlYccb5SUapWfpFuoFB + categories: + primary: Attribution + secondary: '' + additional: [] + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: events + display_name: Events + type: MAP + deprecated: false + required: false + description: Convertro only wants to receive specific events. For each conversion + event you want to send to Convertro, put the event name you send to Segment + on the left, and the name you want Convertro to receive it as on the right. + settings: [] + - name: hybridAttributionModel + display_name: Hybrid Attribution Model + type: BOOLEAN + deprecated: false + required: false + description: This will make **Completed Order** events always send a `sale` event + in addition to a `sale.new` or `sale.repeat` event if it has a boolean `repeat` + property. + settings: [] + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: If you'd like to send mobile data to Convertro's server side integration, + please enter your Convertro Site ID + settings: [] + - name: account + display_name: Account + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your Convertro Account Name + settings: [] + - name: clientName + display_name: Client Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: If you'd like to send mobile data to Convertro's server side integration, + please enter your Convertro Client Name + settings: [] + - name: domain + display_name: Domain + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: If you'd like to send mobile data to Convertro's server side integration, + please enter your Convertro Domain + settings: [] +- name: catalog/destinations/countly + display_name: Countly + description: Countly is a general-purpose analytics tool for your mobile apps, with + reports like traffic sources, demographics, event tracking and segmentation. + type: STREAMING + website: http://count.ly + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/countly-default.svg + mark: https://cdn.filepicker.io/api/file/Go3hSbicQqOAoatz7lQc + categories: + primary: Analytics + secondary: '' + additional: [] + components: + - type: IOS + - type: ANDROID + platforms: + browser: false + server: false + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: appKey + display_name: App Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[a-z0-9]{40}$" + description: 'You can find your App Key on your Countly server. It should be 40 + characters long, and look something like this: `c801156663bfcc4694aafc0dd26023a6d9b9544a`.' + settings: [] + - name: serverUrl + display_name: Server URL + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You'll need to add your own Countly Server URL here. + settings: [] +- name: catalog/destinations/crazy-egg + display_name: Crazy Egg + description: Crazy Egg is a user testing tool that gives you heatmaps, clickmaps + and scrollmaps of your visitors interacting with your site. It helps you learn + where your users are having trouble. + type: STREAMING + website: http://crazyegg.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/crazy-egg-default.svg + mark: https://cdn.filepicker.io/api/file/UVZIeUbXQheT5qLBmaHF + categories: + primary: Heatmaps & Recordings + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: true + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: accountNumber + display_name: Account Number + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^\\d+$" + description: You can find your Account Number by going to the [Crazy Egg Setup + Instructions](http://www.crazyegg.com/instructions) and clicking **I use Segment.** + Your account number will appear in bold. It should be a series of numbers, like + `00938301`. + settings: [] +- name: catalog/destinations/criteo + display_name: Criteo + description: 'Criteo uses state of the art machine learning to transform digital + advertising into a personal experience. Please Note: Our web integration with + Criteo is currently in Beta.' + type: STREAMING + website: http://www.criteo.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/Xpr2w809To69w76BoxCv + mark: '' + categories: + primary: Advertising + secondary: '' + additional: [] + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: false + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: account + display_name: Account ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Criteo Account ID + settings: [] + - name: eventMappings + display_name: Event Mappings + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - viewList + - viewItem + - viewBasket + - trackTransaction + description: 'Specify the events you would like to map to Criteo''s [OneTag event + types](https://support.criteo.com/hc/en-us/articles/202726972-Criteo-OneTag-explained). + Input your event name (case sensitive) on the left and choose the event type + from the dropdown. If you do not define these mappings we will fall back on + the default mappings defined in our [documentation](https://segment.com/docs/destinations/criteo/#track). ' + settings: [] + - name: homeUrl + display_name: Home Page URL + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: The full URL of your website's Home page. This settings is only necessary + if the path of your home url is not the standard root path (ie. '/'). Navigation + to this page will trigger Criteo's viewHome tag. + settings: [] + - name: supportingPageData + display_name: Supporting Page Data + type: MAP + deprecated: false + required: false + description: Specify the property names of your Segment page event on the left + and the corresponding Criteo data parameter you would like us to map it to on + the right. Please reference our [documentation](/docs/integrations/criteo/#extra-data) + for more info on this feature. **Please note, this setting is only applicable + if you are using our web integration with Criteo which is currently in beta.** + settings: [] + - name: supportingUserData + display_name: Supporting User Data + type: MAP + deprecated: false + required: false + description: Specify the Segment trait names on the left and the corresponding + Criteo data parameter you would like us to map it to on the right. Please reference + our [documentation](/docs/integrations/criteo/#extra-data) for more info on + this feature. **Please note, this setting is only applicable if you are using + our web integration with Criteo which is currently in beta.** + settings: [] +- name: catalog/destinations/crittercism + display_name: Crittercism + description: Crittercism is a performance monitoring solution for your mobile apps. + Crittercism provides real-time monitoring of crashes, exceptions, network service + calls, and other critical mobile workflows. + type: STREAMING + website: http://crittercism.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/crittercism-default.svg + mark: https://cdn.filepicker.io/api/file/TaVJ7QIUQEaMDEiChNio + categories: + primary: Performance Monitoring + secondary: '' + additional: [] + components: + - type: IOS + - type: ANDROID + platforms: + browser: false + server: false + mobile: true + methods: + alias: false + group: true + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: appId + display_name: App ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^([a-z0-9]{40}|[a-z0-9]{24})$" + description: 'You can find your App ID on the Crittercism [Settings page](https://app.crittercism.com/developers). + It should be 24 characters long, and look something like this: `93ac1026a7928a581c000002`.' + settings: [] + - name: customVersionName + display_name: Custom Version Name (Android) + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Override the default version name of your app that is reported to + Crittercism (Android only). Check out the [Crittercism docs](http://docs.crittercism.com/android/android.html#customizing-the-version-reported-to-crittercism) + for more info. + settings: [] + - name: enableServiceMonitoring + display_name: Enable Service Monitoring (Android) + type: BOOLEAN + deprecated: false + required: false + description: Whenever an app makes a network call, Crittercism monitors and captures + certain information automatically (Android only). Check out the [Crittercism + docs](http://docs.crittercism.com/overview/overview.html#service-monitoring) + for more info. + settings: [] + - name: includeVersionCode + display_name: Include the Version Code (Android) + type: BOOLEAN + deprecated: false + required: false + description: This will include the version code from the manifest file in your + app's version name (Android only). Check out the [Crittercism docs](https://app.crittercism.com/developers/docs-optional-android#include_version_code) + for more info. + settings: [] + - name: monitorWebView + display_name: Monitor Web View (iOS) + type: BOOLEAN + deprecated: false + required: false + description: Monitor network traffic generated by UIWebViews (iOS only). Check + out the [Crittercism docs](http://docs.crittercism.com/ios/ios.html#monitoring-web-views) + for more info. + settings: [] + - name: shouldCollectLogcat + display_name: Collect Logcat Data (Android) + type: BOOLEAN + deprecated: false + required: false + description: If you want to include system log data in your crash logs, enable + this setting (Android only). Check out the [Crittercism docs](https://app.crittercism.com/developers/docs-optional-android#including_logcat) + for more info. + settings: [] +- name: catalog/destinations/cruncher + display_name: Cruncher + description: "Cruncher provides an end-to-end data crunching platform with a focus + on data science and advanced analytics for analysts and business people. It lets + you bring all your siloed data sources in one place and empowers you to extract + deep insights using a powerful, yet simple interface. \n" + type: STREAMING + website: https://www.cruncherlabs.com + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/b1f773e2-2309-4dee-b396-030fb235212c.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/7c7c0148-a4b5-4de2-a92e-7b8bb03c0b8a.svg + categories: + primary: Analytics + secondary: Enrichment + additional: + - Performance Monitoring + - Personalization + - Raw Data + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: 'You can find your API key under your connector''s detail page. ' + settings: [] +- name: catalog/destinations/curebit + display_name: Talkable + description: Talkable is a social marketing platform for ecommerce stores that increases + revenue through referrals. + type: STREAMING + website: https://www.talkable.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/EzWjPU1jRIy2aWxGIqlr + mark: https://cdn.filepicker.io/api/file/ywvoCzPhRHCrPkEi3NnF + categories: + primary: Referrals + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: campaigns + display_name: Campaigns + type: MAP + deprecated: false + required: false + description: Each campaign runs at a specific url like /share or /invite. Map + that url to the Talkable campaign_tags for that page. + settings: [] + - name: iframeBorder + display_name: IFrame Border + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Your IFrame Border, if you're not sure see this [Help Page](https://talkable.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) + from Talkable. + settings: [] + - name: iframeHeight + display_name: IFrame Height + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Your IFrame Height, if you're not sure see this [Help Page](https://talkable.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) + from Talkable. + settings: [] + - name: iframeWidth + display_name: IFrame Width + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Your IFrame Width, if you're not sure see this [Help Page](https://talkable.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) + from Talkable. + settings: [] + - name: responsive + display_name: Use a Responsive IFrame + type: BOOLEAN + deprecated: false + required: false + description: Should the IFrame be responsive? If you're not sure see this [Help + Page](https://talkable.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) + from Talkable. + settings: [] + - name: customUrl + display_name: Custom Script URL + type: STRING + deprecated: false + required: false + string_validators: + regexp: "^//" + description: If Talkable supplies a custom URL from which to load your script, + enter it here and we'll use that instead of the default. Please include the + `//` prefix. + settings: [] + - name: device + display_name: Device Sizing + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: What device should it be sized for? If you're not sure see this [Help + Page](https://talkable.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) + from Talkable. + settings: [] + - name: insertIntoId + display_name: ID to Insert Talkable + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: The ID of the HTML element where you would like to insert the Talkable + IFrame. + settings: [] + - name: server + display_name: Server + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: You can use your own domain if you have an enterprise Talkable account + settings: [] + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Site ID, if you can't find it see this [Help Page](https://talkable.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) + from Talkable. + settings: [] +- name: catalog/destinations/custify + display_name: Custify + description: Next-Generation Customer Success Software For B2B SaaS + type: STREAMING + website: https://www.custify.com/ + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/9873ccd2-76af-4491-9940-42016a404fd5.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/afa31837-ecdd-415c-ab0b-98f4678c4626.svg + categories: + primary: Analytics + secondary: Performance Monitoring + additional: + - Surveys + - Customer Success + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: true + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Go to Settings > Developer and copy your API key + settings: [] +- name: catalog/destinations/custom---kickbox-email-validation + display_name: Custom - Kickbox Email Validation + description: Kickbox Email Validation + type: STREAMING + website: https://www.mongodb.com + status: PUBLIC + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/4114d585-1fe3-435d-8f46-e6d2e8e15ffe.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/22397909-ece7-4636-843a-db1d94c18395.svg + categories: + primary: CRM + secondary: Raw Data + additional: [] + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Add the kickbox API key + settings: [] + - name: segmentWriteKey + display_name: Segment Write Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter a description. + settings: [] +- name: catalog/destinations/custom-datadog-destination + display_name: Custom DataDog Destination + description: A very online piece of infrastructure software + type: STREAMING + website: https:///www.com + status: PUBLIC + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/f560c669-0022-47e1-b440-163ee099970d.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/c73312a8-947d-493d-a286-42e93a638441.svg + categories: + primary: Performance Monitoring + secondary: '' + additional: [] + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: in data dog + settings: [] + - name: sendLogs + display_name: Send Logs + type: BOOLEAN + deprecated: false + required: false + description: Enter a description. + settings: [] + - name: sendMetrics + display_name: Send Metrics + type: BOOLEAN + deprecated: false + required: false + description: Enter a description. + settings: [] + - name: tags + display_name: Tags + type: MAP + deprecated: false + required: false + description: Enter a description. + settings: [] +- name: catalog/destinations/customer.io + display_name: Customer.io + description: Customer.io is an automated email tool. It lets you set up rules to + automatically send emails to your users after they perform actions, making drip + email campaigns really easy. + type: STREAMING + website: http://customer.io + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/GyZ581zaSTmv9T1ivLE0 + mark: https://cdn.filepicker.io/api/file/w8zEnnazRwaPhGG4lLux + categories: + primary: Email Marketing + secondary: SMS & Push Notifications + additional: [] + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: true + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: "^([a-z0-9]{20})?([a-z0-9]{64})?$" + description: 'You can find your API Key on the Customer.io [Integration page](https://fly.customer.io/account/customerio_integration). + It should be 20 or 64 characters long, and look something like this: `91837a6c9e8b49d0ef71`. + An API Key is required if you''re using our server-side or mobile libraries.' + settings: [] + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^([a-z0-9]{20})?([a-z0-9]{64})?$" + description: You can find your Site ID on the Customer.io [Integration page](https://fly.customer.io/account/customerio_integration). + settings: [] +- name: catalog/destinations/customersuccessbox + display_name: CustomerSuccessBox + description: Customer Success platform for B2B SaaS businesses. + type: STREAMING + website: https://customersuccessbox.com + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/e9d17e14-057b-45f9-b4b6-f68c16cbbae1.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/abba03a0-aa1a-4858-8467-ee36bb1d15dc.svg + categories: + primary: Customer Success + secondary: Analytics + additional: + - Customer Success + - Performance Monitoring + - Surveys + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Settings (Gear icon) > Developer Console > API Key > API key for + POST request + settings: [] +- name: catalog/destinations/customfitai + display_name: CustomFit.ai + description: Chisel Hyper Customized App Experiences & Intelligent Alternative User + Journeys to increase market reach & App usage + type: STREAMING + website: https://customfit.ai/ + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/1edc90a4-779c-4087-b53d-8d833887daea.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/3a389224-a62c-48c5-b322-4080eb4500e7.svg + categories: + primary: A/B Testing + secondary: Analytics + additional: + - Customer Success + - Marketing Automation + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Paste the server key of your app here. (Refer https://docs.customfit.ai/customfit-ai/keys) + settings: [] +- name: catalog/destinations/delighted + display_name: Delighted + description: Delighted is the fastest and easiest way to gather actionable feedback + from your customers. Delighted automates sending the survey, gathering responses, + and calculating your Net Promoter Score(NPS) for you. Leaving you to do what you + do best– growing your business. + type: STREAMING + website: https://delighted.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/fgNxQploS3i3ndgfisKr + mark: '' + categories: + primary: Surveys + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: To connect Delighted with Segment, all you need is your Delighted + API Key + settings: [] +- name: catalog/destinations/dev-center-slack-notifications + display_name: Dev Center Slack Notifications + description: Send notifications about dev center. + type: STREAMING + website: https://app.segment.com + status: PUBLIC + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/e34c8f5d-9921-42e1-9678-77812817df73.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/1b630009-05d4-48fe-8bc1-add7011e1ddd.svg + categories: + primary: A/B Testing + secondary: Advertising + additional: + - Analytics + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: workspaceName + display_name: Workspace Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'The name of the workspace you want to test. ' + settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: api key + settings: [] + - name: configApiKey + display_name: Config Api Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter a description. + settings: [] + - name: slackWebhookUrl + display_name: Slack Webhook Url + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: The slack channel you want to make announcements in. + settings: [] + - name: testSourceName + display_name: Test Source Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Partner submitted destinations will be added to this source automatically. + settings: [] +- name: catalog/destinations/doubleclick-floodlight + display_name: DoubleClick Floodlight + description: Floodlight allows advertisers to capture and report on the actions + of users who visit their website after viewing or clicking on one of the advertiser's + ads. + type: STREAMING + website: https://www.doubleclickbygoogle.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/Db0885H4QDtMOAoTNVut + mark: https://cdn.filepicker.io/api/file/ulUiqB4SSqO9aVl1vhsD + categories: + primary: Advertising + secondary: '' + additional: [] + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: false + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: groupTag + display_name: Group Tag + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: This setting maps to the Doubleclick Floodlight container group tag + (the `type` parameter) string. You can choose to use this setting to define + the same value for this parameter across all conversion events or you can define + this value for each of your conversion event mappings below. + settings: [] + - name: events + display_name: Conversion events + type: MIXED + deprecated: false + required: false + description: Use these fields to map your Segment event names to Floodlight tags. + We'll only send Floodlight the conversion events you specify. + settings: + - name: customVariable + display_name: Custom Variables + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 150 + map_prefix: u + select_options: [] + description: Map Segment event properties (on the *left*) to Floodlight custom + variables and we'll insert the value of that property in the corresponding + Floodlight custom variables like `u1,u2,..etc` (on the *right*). You may also + define the event properties you would like to use using JSON style dot notation + accessors wrapped as handlebars style expressions. For example `{{context.campaign.name}}` + or `{{context.userAgent}}`. Please reference our [docs](/docs/destinations/doubleclick-floodlight/) + for more info. + settings: [] + - name: event + display_name: Segment Event Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Our Floodlight integration allows you to map the event names you + track in Segment to Floodlight tags. + settings: [] + - name: cat + display_name: Floodlight Activity Tag + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: This should be the `cat` of your tag string, which Floodlight servers + use to identify the activity group to which the activity belongs. If you leave + this option blank, we will fall back to whatever you define in the top level + Activity Tag setting. + settings: [] + - name: type + display_name: Floodlight Group Tag + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: This should be the `type` of your tag string, which identifies + the activity group with which the Floodlight activity is associated. If you + leave this option blank, we will fall back to whatever you define in the top + level Group Tag setting. + settings: [] + - name: isSalesTag + display_name: Fire as Sales Tag + type: BOOLEAN + deprecated: false + required: false + description: Check this box if this tag is a **Sales** tag. Leave it unchecked + if this is a **Counter** tag. + settings: [] + - name: ordKey + display_name: Set Ord Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: 'For **Sales** tags only, please specify which property value should + be used for the `ord`. You must enable reporting on `ord` inside DoubleClick + Floodlight if you decide to use this feature. A good example key would be + something like `properties.order_id`. Please include the `properties.` prefix + to the key to ensure we can find the associated value in your properties object. ' + settings: [] + - name: source + display_name: DoubleClick Advertiser ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your advertiser ID that is the source of the Floodlight activity. + This should be the `src` of your tag string. + settings: [] + - name: activityTag + display_name: Activity Tag + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: This setting maps to the Doubleclick Floodlight container activity + tag (or `cat`) string. You can choose to use this setting to define the same + value for this parameter across all conversion events or you can define this + value for each of your conversion event mappings below. + settings: [] + - name: token + display_name: Authorization Token for server-to-server requests + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Please add the Token to send your conversions using the server-to-server + endpoint from DisplayVideo 360. + settings: [] +- name: catalog/destinations/dreamdata-io + display_name: Dreamdata IO + description: Dreamdata IO enables B2B companies to understand the impact on revenue + of every touch in their customer journey. Dreamdata IO uses your Segment data + to deliver multitouch, account-based attribution. + type: STREAMING + website: https://dreamdata.io + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/75c94dfe-cda8-4544-be2d-8e67bb3e8d5f.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/72592d03-7475-4a82-ab80-bbd5e8f68d9e.svg + categories: + primary: Attribution + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: You can find your API key in your settings page. + settings: [] +- name: catalog/destinations/drift + display_name: Drift + description: Drift is a customer communication and growth platform. + type: STREAMING + website: http://www.drift.com/segment/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/drift-default.svg + mark: https://cdn.filepicker.io/api/file/lx1HlXvFRxusbOpm4lGy + categories: + primary: Livechat + secondary: '' + additional: [] + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: true + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Head right to this page in [Drift](https://app.drift.com/setup/segment) + and click connect to setup Drift in Segment. + settings: [] + - name: embedId + display_name: Embed ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Head right to this page in [Drift](https://app.drift.com/setup/segment) + and click connect to setup Drift in Segment. + settings: [] +- name: catalog/destinations/drip + display_name: Drip + description: Drip is an automated email tool that lets you set up a drip campaign + on your site in a few minutes. After a user signs up, it'll send them the next + email in your series every few days. + type: STREAMING + website: https://www.drip.co/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/drip-default.svg + mark: https://cdn.filepicker.io/api/file/WE9VRNdaSWGS2h3jtQHA + categories: + primary: Email Marketing + secondary: '' + additional: [] + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: token + display_name: API Token + type: STRING + deprecated: false + required: false + string_validators: + regexp: "^[a-zA-Z0-9]{20}$|[a-zA-Z0-9]{32}" + description: 'Your API Token can be found in your [User Settings](https://www.getdrip.com/user/edit). + It should be 20 character alphanumeric string, like: `bmrdc6hczyn8yss8o8td`.' + settings: [] + - name: account + display_name: Account Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[0-9]{7,9}$" + description: 'Your account ID can be found on your [Site Setup](https://www.getdrip.com/settings/site) + page under **3rd-Party Integrations**. It should be a 7, 8, or 9 character numerical + string, like this: `83702741`.' + settings: [] + - name: campaignId + display_name: Campaign ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: "^[0-9]{7,9}$" + description: 'Your campaign ID can be found in your [Campaigns](https://www.getdrip.com/campaigns) + page. Copy a campaign URL, the campaign ID will be the last segment of that + url e.g (https://www.getdrip.com/account_id/campaigns/campaign_id). If you need + to set this value dynamically, you can pass `integrations.Drip.campaignId` as + an integration specific option and we will respect that. **IMPORTANT**: If you + put a value in here, we will by default try to subscribe every user to this + campaign ID.' + settings: [] +- name: catalog/destinations/elevio + display_name: Elevio + description: Use elevio to show an entire knowledge base, on every page of your + site. + type: STREAMING + website: http://elev.io + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/elevio-default.svg + mark: https://cdn.filepicker.io/api/file/tKeulSfoQfWSrtzKw3V6 + categories: + primary: Customer Success + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: true + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: accountId + display_name: Account Id + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your account ID on your elevio widget settings page. + settings: [] +- name: catalog/destinations/eloqua + display_name: Eloqua + description: Transform the way you approach sales and marketing with Eloqua's leading + marketing automation and revenue performance management solution. + type: STREAMING + website: http://www.eloqua.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/eloqua-default.svg + mark: '' + categories: + primary: Email Marketing + secondary: '' + additional: [] + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: password + display_name: Password + type: PASSWORD + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your login passord + settings: [] + - name: sendGroup + display_name: Create or Update Account on Group + type: BOOLEAN + deprecated: false + required: false + description: "*Server Side Only*: Enable this setting to create or update an Eloqua + account on a `group` event." + settings: [] + - name: createContactOnTrack + display_name: Create or Update Contact on Track + type: BOOLEAN + deprecated: false + required: false + description: "*Server Side Only*: Enable this setting to create or update an Eloqua + `contact` with traits from your `track` events' `context.traits` object. *Note + that when this setting is enabled, the destination will only process `track` + events and will reject `identify` events.* This is to reduce the number of potentially + repetitive API calls sent downstream to Eloqua." + settings: [] + - name: mappedEvents + display_name: Map Track Events to Custom Objects + type: MAP + deprecated: false + required: false + description: "Please input the Segment event names on the left and their corresponding + Eloqua Custom Object names on the right. This mapping is required for all events + you would like in Eloqua as Custom Objects. \n\n**Note:** If you have set up + Custom Object Fields in Eloqua, please ensure the corresponding Segment payload + property values are of the same data type specified in Eloqua's dashboard. Eloqua + will reject any event containing a Custom Object Field with an incorrect data + type. Segment automatically attempts to match property names to Custom Object + Field names in Eloqua." + settings: [] + - name: mappedGroupTraits + display_name: Map Custom Traits to Accounts + type: MAP + deprecated: false + required: false + description: "Please input the Segment trait names on the left and their corresponding + Eloqua Custom Account Field names on the right. The traits must be set up in + the Eloqua dashboard prior to instantiating this mapping. \n\n**Note:** If you + have set up Custom Account Fields in Eloqua, please ensure the corresponding + Segment payload property values are of the same data type specified in Eloqua's + dashboard. Eloqua will reject any event containing a Custom Account Field with + an incorrect data type. " + settings: [] + - name: mappedIdentifyTraits + display_name: Map Custom Traits to Contacts + type: MAP + deprecated: false + required: false + description: "Please input the Segment trait names on the left and their corresponding + Eloqua Custom Contact Field names on the right. The traits must be set up in + the Eloqua dashboard prior to instantiating this mapping. \n\n**Note:** If you + have set up Custom Contact Fields in Eloqua, please ensure the corresponding + Segment payload property values are of the same data type specified in Eloqua's + dashboard. Eloqua will reject any event containing a Custom Contact Field with + an incorrect data type. " + settings: [] + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your Site ID + settings: [] + - name: username + display_name: Username + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your login username + settings: [] + - name: companyName + display_name: Company Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your login company name + settings: [] +- name: catalog/destinations/email-aptitude + display_name: Email Aptitude + description: Email Aptitude is a professional services company and SaaS product + that helps large ecommerce brands with their email strategy. + type: STREAMING + website: http://www.emailaptitude.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/email-aptitude-default.svg + mark: https://cdn.filepicker.io/api/file/FBle3qouTVWC2mxLuacM + categories: + primary: Email Marketing + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: accountId + display_name: Account ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^EA-[a-zA-Z0-9]+$" + description: Your Account ID from Email Aptitude, provided to you by your Email + Aptitude account manager. + settings: [] +- name: catalog/destinations/emarsys + display_name: Emarsys + description: Emarsys is the largest independent marketing platform company in the + world. Our software enables truly personalized, one-to-one interactions between + marketers and customers across all channels — building loyalty, enriching the + customer journey, and increasing revenue. This enables companies to scale marketing + decisions and actions beyond human capabilities. + type: STREAMING + website: http://www.emarsys.com + status: PUBLIC_BETA + logos: + logo: https://cdn.filepicker.io/api/file/iUXhg5t0T0kjdov1iYrk + mark: https://cdn.filepicker.io/api/file/mIFPy3UATLi6pc20BZoM + categories: + primary: Email Marketing + secondary: Analytics + additional: + - CRM + - Customer Success + - SMS & Push Notifications + - Marketing Automation + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Please consult your Emarsys account manager for your API Key. + settings: [] +- name: catalog/destinations/emma + display_name: EMMA + description: 'The most advanced Mobile Marketing Automation tool with just one goal: + to get you more, best and recurrent sales from your users.' + type: STREAMING + website: https://emma.io + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/fa4f8272-478c-4654-a709-21e3d77d364f.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/cb9f503a-bb4b-4f8f-a981-1be198e74bc0.svg + categories: + primary: Analytics + secondary: Attribution + additional: + - SMS & Push Notifications + - Deep Linking + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: https://support.emma.io/hc/en-us/articles/360019026214-How-to-find-you-API-Key + settings: [] +- name: catalog/destinations/epica + display_name: EPICA + description: EPICA is the world's first prediction-as-a-service platform. Powered + by industry-specific machine learning algorithms, EPICA accurately predicts customer + behavior + type: STREAMING + website: https://www.epica.ai/ + status: PUBLIC_BETA + logos: + logo: https://cdn.filepicker.io/api/file/dbhPstf6SAiZDDn5C7rc + mark: https://public-segment-devcenter-production.s3.amazonaws.com/b4c0f21a-8046-4cad-99cd-4948db7e911e.svg + categories: + primary: Analytics + secondary: Advertising + additional: + - Marketing Automation + - Personalization + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: You can find your API key in your account settings page + settings: [] +- name: catalog/destinations/errorception + display_name: Errorception + description: Errorception is a simple way to discover Javascript errors on your + website. Any error that occurs will get sent to Errorception, so you can find + out what's causing them. + type: STREAMING + website: http://errorception.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/errorception-default.svg + mark: https://cdn.filepicker.io/api/file/m4pC634pTDdxa8z4mfQA + categories: + primary: Performance Monitoring + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: meta + display_name: Include custom user data with Errorception's error tracking + type: BOOLEAN + deprecated: false + required: false + description: When this option is enabled we will store metadata about the user + on `identify` calls, using the [Errorception `meta` API](http://blog.errorception.com/2012/11/capture-custom-data-with-your-errors.html). + settings: [] + - name: projectId + display_name: Project ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[a-z0-9]{24}$" + description: 'You can find your Project ID under the **Settings** tab on the [Project + page]() of your Errorception account. Your Project ID is the long hexadecimal + number inside `_errs[''PROJECT_ID'']`. You can also just copy it out of your + Errorception URL, `/projects/PROJECT_ID`. It should be 24 characters long and + look something like this: `326b76b52f52c3f662000140`.' + settings: [] +- name: catalog/destinations/evergage + display_name: Evergage + description: Evergage is a tool that lets you add personalization to your website + depending on what segments a user falls into, so you can show people custom messages + when they need them. + type: STREAMING + website: http://evergage.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/evergage-default.svg + mark: https://cdn.filepicker.io/api/file/VOK4H4ciSiiv2DimOtMQ + categories: + primary: A/B Testing + secondary: Personalization + additional: + - Analytics + - Email Marketing + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: dataset + display_name: Dataset + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Evergage Dataset + settings: [] + - name: account + display_name: Account + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Evergage account + settings: [] +- name: catalog/destinations/facebook-app-events + display_name: Facebook App Events + description: Facebook is the world's leading ad publisher for mobile app marketers. + type: STREAMING + website: https://developers.facebook.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/facebook-app-events-default.svg + mark: https://cdn.filepicker.io/api/file/k1fi9InSu6eint2IHilP + categories: + primary: Advertising + secondary: Analytics + additional: [] + components: + - type: IOS + - type: CLOUD + platforms: + browser: false + server: true + mobile: true + methods: + alias: false + group: false + identify: false + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: trackScreenEvents + display_name: Use Screen Events as Track Events + type: BOOLEAN + deprecated: false + required: false + description: This setting allows you to track your Segment screen events as though + they were track events. If enabled, we will being routing screen events from + this source to Facebook App Events formatted as Viewed `name` Screen (where + `name` is the [screen name](https://segment.com/docs/spec/screen/) you specify). + settings: [] + - name: appEvents + display_name: Map your events to Standard FB App Events + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - fb_mobile_level_achieved + - fb_mobile_activate_app + - fb_mobile_add_payment_info + - fb_mobile_add_to_cart + - fb_mobile_add_to_wishlist + - fb_mobile_complete_registration + - fb_mobile_tutorial_completion + - fb_mobile_initiated_checkout + - fb_mobile_purchase + - fb_mobile_rate + - fb_mobile_search + - fb_mobile_spent_credits + - fb_mobile_achievement_unlocked + - 'fb_mobile_content_view ' + - Subscribe + - StartTrial + - AdClick + - AdImpression + description: |- + Enter your events on the left and the Facebook standard event to map to on the right. Facebook recognizes certain [standard events](https://developers.facebook.com/docs/marketing-api/app-event-api/v2.6) that can be used across Custom Audiences, custom conversions, conversion tracking, and conversion optimization. When you map an event to a standard Facebook event, we'll send the event by that name. Any unmapped events will still be sent as Custom Events. + + + **Facebook Recommended Events** + + The most important events that can help advertisers improve campaign ROI are the conversion events or events closest to the conversion. Those events are marked with an *. + + In addition, there are special requirements for dynamic ads. These events are marked with "m" for dynamic ads for mobile, and "t" for dynamic ads for travel. + settings: [] + - name: appId + display_name: App ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Facebook App ID can be retrieved from your [Facebook Apps dashboard](https://developers.facebook.com/apps/). + settings: [] + - name: eventParameterWhitelist + display_name: Event Parameter Whitelist + type: LIST + deprecated: false + required: false + description: |- + Facebook App Events limits the number of event parameters to 25. You may choose to put a whitelist of properties which we will send to Facebook instead. This whitelist will be respected exactly (or not at all, if you choose not to use it), the only exception being that we will automatically send `_eventName` to ensure all events are valid. Top-level properties will be mapped exactly. (For example, if you whitelist `someProp` then we will send `someProp`'s value). We otherwise make the following conversions for Facebook-spec'd events. Use the value on the `right-hand` side if you wish to send these properties as we calculate them. + + ``` + revenue: _valueToSum + price: _valueToSum + currency: fb_currency + name: fb_description + id: fb_content_id + product_id: fb_content_id + productId: fb_content_id + category: fb_content_type + The version of your app: _appVersion + The timestamp of the event: _logTime + query: fb_search_string + quantity: fb_num_items + number of items in products: fb_num_items + list of ids in products: fb_content_id + ``` + settings: [] +- name: catalog/destinations/facebook-offline-conversions + display_name: Facebook Offline Conversions + description: 'With offline conversion measurement on Facebook, you can track when + transactions occur in your physical retail store and other offline channels (ex: + orders made over the phone) after people see or engage with your Facebook ad.' + type: STREAMING + website: https://www.facebook.com/business/help/1782327938668950 + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/MjCkA4RSTm7BQMFAcy8N + mark: https://cdn.filepicker.io/api/file/TP1ONlaTGaF8fjL5XWhI + categories: + primary: Advertising + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: false + server: true + mobile: false + methods: + alias: false + group: false + identify: false + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: oauth + display_name: oauth + type: BOOLEAN + deprecated: false + required: false + description: 'Authorize Segment to oauth ' + settings: [] + - name: valueIdentifier + display_name: Value Field Identifier + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - price + - value + description: 'For pre-purchase events such as `Product Viewed`, `Product Added`, + and `Product List Viewed`, choose which Segment property you would like to map + to Facebook''s `value` property. ' + settings: [] + - name: completeRegistrations + display_name: Map Track Events as CompleteRegistration Conversions to Event Set + IDs + type: MAP + deprecated: false + required: false + description: Enter your Segment `.track()` event names on the left that you want + to send as `CompleteRegistration` conversions. On the right hand side, put the + ID of the Facebook Offline Event Set where you want to send these conversions. + settings: [] + - name: events + display_name: Map Track Events to Event Set IDs + type: MAP + deprecated: false + required: false + description: Enter your Segment `.track()` event names on the left that you want + to send as conversions. On the right hand side, put the ID of the Facebook Offline + Event Set where you want to send these conversions. + settings: [] + - name: leads + display_name: Map Track Events as Lead Conversions to Event Set IDs + type: MAP + deprecated: false + required: false + description: Enter your Segment `.track()` event names on the left that you want + to send as `Lead` conversions. On the right hand side, put the ID of the Facebook + Offline Event Set where you want to send these conversions. + settings: [] +- name: catalog/destinations/facebook-pixel + display_name: Facebook Pixel + description: The Facebook Pixel integration lets you measure and optimize the performance + of your Facebook Ads. + type: STREAMING + website: https://developers.facebook.com/docs/facebook-pixel + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/facebook-Pixel-default.svg + mark: https://cdn.filepicker.io/api/file/YmPSqN04QvGRGBkNgkUB + categories: + primary: Advertising + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: contentTypes + display_name: Map Categories to FB Content Types + type: MAP + deprecated: false + required: false + description: Enter your category value on the left, and the Facebook content type + to map to on the right. Facebook recognizes certain event types that can help + deliver relevant ads. If no category values are mapped we'll default to `product` + and `product_group`, depending on the event. + settings: [] + - name: valueIdentifier + display_name: Value Field Identifier + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - price + - value + description: 'For pre-purchase events such as `Product Viewed` and `Product Added`, + choose which Segment property you would like to map to Facebook''s value property. ' + settings: [] + - name: whitelistPiiProperties + display_name: Whitelist PII Properties + type: LIST + deprecated: false + required: false + description: By default, Segment will strip any PII from the properties of `track` + events that get sent to Facebook. If you would like to override this functionality, + you can input each property you would like to whitelist as a line item in this + setting. **Please reference our [documentation](https://segment.com/docs/destinations/facebook-pixel/#pii-blacklisting) + for the exact property names we filter out.** + settings: [] + - name: blacklistPiiProperties + display_name: Blacklist PII Properties + type: MIXED + deprecated: false + required: false + description: Facebook has a strict policy prohibiting any personally identifiable + information (PII) from being sent as properties of events to their API. By default, + this integration will scan `track` events for [these](https://segment.com/docs/destinations/facebook-pixel/#pii-blacklisting) + properties and strip them from the payload that gets sent to Facebook. If your + events contain other properties with PII values, you can use this setting to + append to this default list. You can also use this setting to optionally hash + any PII values instead of dropping them. + settings: [] + - name: initWithExistingTraits + display_name: Enable Advanced Matching + type: BOOLEAN + deprecated: false + required: false + description: If true, we will initialize Facebook Pixel with any user traits that's + been cached in the Segment cookies from your previous `.identify()` calls. + settings: [] + - name: legacyEvents + display_name: Legacy Conversion Pixel IDs + type: MAP + deprecated: false + required: false + description: These are your **[deprecated](https://developers.facebook.com/docs/ads-for-websites)** + Conversion Pixel IDs from Facebook Conversion Tracking. Facebook will still + accept data in this format, though it's no longer possible to create conversion + Pixel IDs. Now you create conversions based on standard and custom events inside + their interface. Enter your event name in the left column and your pixel ID + in the right column. + settings: [] + - name: pixelId + display_name: Pixel ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Pixel ID, from the snippet created on the [Facebook Pixel creation + page](https://www.facebook.com/ads/manager/pixel/facebook_pixel/). + settings: [] + - name: standardEvents + display_name: Map Your Events to Standard FB Events + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - ViewContent + - Search + - AddToCart + - AddToWishlist + - InitiateCheckout + - AddPaymentInfo + - Purchase + - Lead + - CompleteRegistration + - Contact + - CustomizeProduct + - Donate + - FindLocation + - Schedule + - StartTrial + - SubmitApplication + - Subscribe + description: Enter your event on the left, and the Facebook standard event to + map to on the right. Facebook recognizes certain [standard events](https://developers.facebook.com/docs/marketing-api/facebook-pixel/v2.5#standardevents) + that can be used across Custom Audiences, custom conversions, conversion tracking, + and conversion optimization. When you map an event to a standard Facebook event, + we'll send the event by that name. Any unmapped events will still be sent as + Custom Events. + settings: [] + - name: standardEventsCustomProperties + display_name: Standard Events custom properties + type: LIST + deprecated: false + required: false + description: Add here all the custom properties you want to send as part of your + Standard Events (Order Completed, Checkout Started, etc) as `cd[property] = + event[property]`. + settings: [] +- name: catalog/destinations/factorsai + display_name: FactorsAI + description: Goal Driven Analytics + type: STREAMING + website: https://www.factors.ai + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/7f0c5fbb-79c5-4df3-bf26-ae352b560dd3.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/9a3f1dcd-557f-4231-9a9e-c31e9f7581ad.svg + categories: + primary: Analytics + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Go to https://app.factors.ai/#/settings/segment. Choose your Project + on the top dropdown. Enable Segment and Copy the API Key. + settings: [] + - name: publishableApiKey + display_name: Publishable API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Enter a description. + settings: [] +- name: catalog/destinations/firebase + display_name: Firebase + description: Firebase is a mobile platform that helps you quickly develop high-quality + apps, grow your user base, and earn more money. Firebase is made up of complementary + features that you can mix-and-match to fit your needs. + type: STREAMING + website: https://firebase.google.com/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/W6teayYkRmKgb8SMqxIn + mark: https://cdn.filepicker.io/api/file/ztKtaLBUT7GUZKius5sa + categories: + primary: Analytics + secondary: Advertising + additional: + - CRM + components: + - type: IOS + - type: ANDROID + platforms: + browser: false + server: false + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: deepLinkURLScheme + display_name: Deep Link URL Scheme (iOS) + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: For iOS, if you're using Firebase for Deep Linking, we'll set this + as the deepLinkURLScheme before initializing Firebase. + settings: [] +- name: catalog/destinations/flurry + display_name: Flurry + description: Flurry is the most popular analytics tool for mobile apps because it + has a wide assortment of features. It also helps you advertise to the right audiences + with your apps. + type: STREAMING + website: http://flurry.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/flurry-default.svg + mark: https://cdn.filepicker.io/api/file/yxc3XuGQA2btML7kyWJg + categories: + primary: Analytics + secondary: Advertising + additional: + - SMS & Push Notifications + components: + - type: IOS + - type: ANDROID + platforms: + browser: false + server: false + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[A-Z0-9]{20}$" + description: You can find your API Key on the Flurry [Manage App Info page](https://dev.flurry.com/secure/login.do). + settings: [] + - name: captureUncaughtExceptions + display_name: Log Uncaught Exceptions to Flurry + type: BOOLEAN + deprecated: false + required: false + description: Enabling this will log uncaught exceptions. + settings: [] + - name: reportLocation + display_name: Collect User Location + type: BOOLEAN + deprecated: false + required: false + description: Enabling this will send tell the Flurry SDK to automatically collect + the user location. + settings: [] + - name: screenTracksEvents + display_name: Screen Tracks As Events + type: BOOLEAN + deprecated: false + required: false + description: Enabling this will send data through screen calls as events (in addition + to pageviews). + settings: [] + - name: sessionContinueSeconds + display_name: Session Continue Seconds + type: NUMBER + deprecated: false + required: false + number_validators: + min: 1 + max: 10000 + description: The number of seconds the app can be in the background before starting + a new Flurry session upon resume. Default from Flurry is 10 seconds. + settings: [] + - name: useHttps + display_name: Send Data to Flurry Over HTTPS + type: BOOLEAN + deprecated: false + required: false + description: Enabling this will send data to Flurry securely. This option is ignored + for the latest versions of the Flurry SDK, which use HTTPS by default. + settings: [] +- name: catalog/destinations/foxmetrics + display_name: FoxMetrics + description: FoxMetrics is a general purpose analytics tool that lets you track + traffic sources, user actions, marketing campaigns, Ecommerce purchases and SaaS + subscriptions. + type: STREAMING + website: http://foxmetrics.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/foxmetrics-default.svg + mark: https://cdn.filepicker.io/api/file/eGJ6e8ZjREWpyaV15zyo + categories: + primary: Analytics + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: appId + display_name: App ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[a-z0-9]{24}$" + description: You can find your App ID (also listed as your API Key) in your FoxMetrics + [Applications List](http://dashboard.foxmetrics.com/MyAccount/Applications) + under **My Account > Applications**. + settings: [] +- name: catalog/destinations/freshmarketer + display_name: Freshmarketer + description: Freshmarketer, a complete marketing automation solution to convert + visitors, engage with contacts, drive retention. By enabling this destination, + send data(identify) from segment to perform smart segmentation, engage with customers + based on their behaviour. + type: STREAMING + website: https://www.freshmarketer.com + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/60c55b1f-91bd-4375-9c15-bb5bebd7b1e4.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/8f946c77-4df2-42d9-80e1-123e66a0a130.svg + categories: + primary: Email Marketing + secondary: A/B Testing + additional: + - Email Marketing + - Heatmaps & Recordings + - Marketing Automation + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Settings > API Settings > Your API Key + settings: [] +- name: catalog/destinations/freshsales + display_name: Freshsales + description: Freshsales is the CRM for high velocity sales teams, packed with features + such as integrated email, built-in phone, user behavior tracking, lead score, + deal management, sales force automation, reports, customizations, integrations + and more. + type: STREAMING + website: https://freshsales.io/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/plSwMhtyT3mIzDnPoRoX + mark: https://cdn.filepicker.io/api/file/aomSTmKCQ4mAnNVkvU6j + categories: + primary: CRM + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API token + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your Freshsales API token on the Integrations page under + Profile Settings -> API Settings. + settings: [] + - name: apiSecret + display_name: Freshsales subdomain + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Provide the subdomain of your Freshsales account. So if your domain + is segment.freshsales.io, then your subdomain is ‘segment’. + settings: [] +- name: catalog/destinations/friendbuy + display_name: Friendbuy + description: Referral tracking and campaign optimization. + type: STREAMING + website: http://www.friendbuy.com + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/ZkStZnT0qg7CyY2wiVgi + mark: https://cdn.filepicker.io/api/file/rRjOUuTtRePNf1AAgnkA + categories: + primary: Referrals + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: This is your **Site ID**. It is used to identify your account in + our platform so we can properly attribute referral data. You can find your Site + ID in the in Friendbuy web application at **Settings > Integration Code** + settings: [] + - name: siteWideWidgets + display_name: Site Wide Widgets + type: MIXED + deprecated: false + required: false + description: 'By default, Friendbuy recommends you add a site wide overlay widget. + You can enter any of these site wide widgets here and we will load them any + time we receive a `.page()` call. *Note*: If you have custom widgets mapped + to named pages in the *Widgets* setting and you have provided a site wide widget, + we will load both.' + settings: [] + - name: widgets + display_name: Page Widgets + type: MIXED + deprecated: false + required: false + description: Map your page calls to specific FriendBuy Widgets. + settings: + - name: id + display_name: Widget ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: If you created a FriendBuy widget, you can enter your **Widget + ID** here to load it onto your webpages. + settings: [] + - name: autoDelay + display_name: Widget Auto Delay + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: This optional `auto_delay` property determines the auto-popup + behavior of a widget. It is specified as an integer with the number of milliseconds + to wait before the widget appears automatically. A value of 0 indicates manual + widget invocation. + settings: [] + - name: selector + display_name: Widget Selector + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: The optional selector is an optional string identifying the HTML + element where the widget is to be placed. For example, `'div.my-widget'` + settings: [] + - name: parameters + display_name: Widget Parameters + type: MAP + deprecated: false + required: false + description: 'The parameters option is a collection of key-value pairs. These + values are added to referral links for the associated widget to facilitate + tracking and reporting on referral traffic. You can put any key on the right + hand side and a Segment page property key on the left hand side. For example, + if you wanted your widget to append `survey=true` or `survey=false` dynamically, + you can enter `''isSurvey'': ''survey''` assuming `isSurvey` is a valid property + on your `.page()` calls.' + settings: [] + - name: name + display_name: Page Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter the `name` of your `.page()` calls. ie. `'Home'` if you are + calling `.page('Home')`. + settings: [] +- name: catalog/destinations/fullstory + display_name: FullStory + description: FullStory lets product and support teams easily understand everything + about the customer experience. + type: STREAMING + website: http://fullstory.com + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/BkhitkDEQCTz9RVFV5PA + mark: https://cdn.filepicker.io/api/file/agRznVcSl2VKC7hagAAH + categories: + primary: Heatmaps & Recordings + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: true + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: debug + display_name: Enter FS debug mode + type: BOOLEAN + deprecated: false + required: false + description: This will enable FullStory's debug mode + settings: [] + - name: org + display_name: FS Org + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your _fs_org on the FullStory settings page by logging + into your account, clicking the settings icon on the bottom left, and looking + in the recording snippet for window['_fs_org'] + settings: [] +- name: catalog/destinations/funnelenvy + display_name: FunnelEnvy + description: 'FunnelEnvy: Predictive Revenue Optimization' + type: STREAMING + website: https://www.funnelenvy.com + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/e40aee2b-f8e2-4ad4-8601-81945b3f1389.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/6d2bec7e-8a71-4bd3-89ae-5d5ccbaebb72.svg + categories: + primary: A/B Testing + secondary: Marketing Automation + additional: + - Personalization + - Tag Managers + components: + - type: WEB + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: Log in to FunnelEnvy, navigate to Integrations left menu item. Under + Sources, select and activate Segment and the API key will be visible. + settings: [] +- name: catalog/destinations/funnelfox + display_name: FunnelFox + description: Integrate your sales stack and eliminate data entry + type: STREAMING + website: https://www.funnelfox.com + status: PUBLIC_BETA + logos: + logo: https://public-segment-devcenter-production.s3.amazonaws.com/eb5cf988-a25f-463c-8313-42c0072a873f.svg + mark: https://public-segment-devcenter-production.s3.amazonaws.com/05ed6a0a-2d70-4357-97c7-567bba8f5590.svg + categories: + primary: Analytics + secondary: Performance Monitoring + additional: + - Personalization + - Raw Data + - CRM + components: [] + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^.{8,}$" + description: On your personal homepage locate the website destination and click + on it to find your personal API Key. + settings: [] +- name: catalog/destinations/gainsight + display_name: Gainsight + description: Gainsight helps businesses reduce churn, increase up-sell and drive + customer success. It integrates with salesforce to evaluate various sources of + customer intelligence. + type: STREAMING + website: http://www.gainsight.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/gainsight-default.svg + mark: https://cdn.filepicker.io/api/file/y4s2lX9GTfe1LcRlPmyG + categories: + primary: Customer Success + secondary: Surveys + additional: + - Analytics + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: true + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: accessKey + display_name: Access Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[a-z0-9-]{36}$" + description: 'It should be 36 characters long, and look something like this: `35a84f9e-7084-47a1-b8a5-593444e9e862`.' + settings: [] + - name: events + display_name: Whitelist Track Events + type: MIXED + deprecated: false + required: false + description: Whitelist Segment `.track()` events you'd like to send to Gainsight. + By **default**, if you do not whitelist _any_ events, we will send all `.track()` + events. If you do whitelist any events, we will **only** send those events through. + Put the name of your `.track()` events here, ie. 'Order Completed' + settings: + - name: event + display_name: Whitelist Segment Event Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Whitelist Segment `.track()` events you'd like to send to Gainsight. + By **default**, if you do not whitelist _any_ events, we will send all `.track()` + events. If you do whitelist any events, we will **only** send those events + through. Put the name of your `.track()` events here, ie. 'Order Completed' + settings: [] +- name: catalog/destinations/gauges + display_name: Gauges + description: Gauges is a simple, friendly analytics tool that is perfect for the + basic tracking needs of small projects or personal blogs. And all of it's data + is queried in real-time. + type: STREAMING + website: http://gaug.es + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/gauges-default.png + mark: https://cdn.filepicker.io/api/file/uRw6QeVTeuOk5UKbmSIu + categories: + primary: Analytics + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: true + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^([a-z0-9]{24})(,[a-z0-9]{24})?$" + description: 'You can find your Site ID under **Management > Tracking Code** in + your [Gauges Dashboard](https://secure.gaug.es/dashboard). It should be 24 + characters long, and look something like this: `93f0e8b9f5a1f530a7000001`.' + settings: [] +- name: catalog/destinations/goedle + display_name: goedle.io + description: Predict your customer’s behavior. Increase conversions and retention + with powerful AI and intelligent marketing automation. + type: STREAMING + website: http://www.goedle.io/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/6vtAy6hSbeg4QMelSuJp + mark: https://cdn.filepicker.io/api/file/Cawq9gmyQXmFPZvuXT6o + categories: + primary: Analytics + secondary: Personalization + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: APP Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your goedle.io APP Key is available in the goedle.io interface. + settings: [] +- name: catalog/destinations/google-adwords-new + display_name: Google Ads (Gtag) + description: Advertise on Google and put your message in front of potential customers + right when they're searching for what you have to offer. + type: STREAMING + website: https://adwords.google.com + status: PUBLIC_BETA + logos: + logo: https://cdn.filepicker.io/api/file/xD85G8KNQhupxDbqnbHe + mark: https://cdn.filepicker.io/api/file/uOqd5KSBaYTXQk22gQzs + categories: + primary: Advertising + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: sendPageView + display_name: Send Page View + type: BOOLEAN + deprecated: false + required: false + description: If you want to prevent the global site tag from automatically sending + a remarketing hit to your AdWords accounts when the page is viewed, you can + disable this setting. Otherwise, by default all properties sent with the conversions + will be sent as remarketing hits which will allow you to create audiences based + on those properties. + settings: [] + - name: accountId + display_name: Google Conversion ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^AW-.+" + description: 'Enter your GOOGLE-CONVERSION-ID. You can get this value from your + global site tag snippet. It should look something like `AW-901243031` ' + settings: [] + - name: clickConversions + display_name: Click Conversions + type: MIXED + deprecated: false + required: false + description: You can map your `.track()` events to specific AdWords Click Conversions + by providing your event `name` and the Conversion ID. + settings: [] + - name: conversionLinker + display_name: Conversion Linker + type: BOOLEAN + deprecated: false + required: false + description: If you don’t want the global site tag to set first-party cookies + on your site’s domain, you should disable this setting. Disabling this is *NOT* + recommended by Google as it can lead to less accurate conversion measurements. + settings: [] + - name: defaultPageConversion + display_name: Default Page Conversion + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: 'If you want to map all your default `.page()` calls that do not + explicitly pass in a `name` to a conversion event, you can enter it here. ' + settings: [] + - name: pageLoadConversions + display_name: Page Load Conversions + type: MIXED + deprecated: false + required: false + description: You can map your `.page()` calls to specific AdWords Page Load Conversions + by providing your page `name` and the Conversion ID. + settings: [] +- name: catalog/destinations/google-analytics + display_name: Google Analytics + description: Google Analytics is the most popular analytics tool for the web. It’s + free and provides a wide range of features. It’s especially good at measuring + traffic sources and ad campaigns. + type: STREAMING + website: http://google.com/analytics + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/anFgceQJTGeMxChCgiyU + mark: https://cdn.filepicker.io/api/file/zebLRcY3RtOlynDXTgNk + categories: + primary: Analytics + secondary: '' + additional: [] + components: + - type: WEB + - type: IOS + - type: ANDROID + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: true + browserUnbundlingPublic: true + settings: + - name: enableServerIdentify + display_name: Enable Server Side Identify + type: BOOLEAN + deprecated: false + required: false + description: 'If you are sending `.identify()` calls from your server side libraries + or have Segment Cloud Apps that send back `.identify()` calls with enriched + user traits, you can send that data to your GA account via custom dimensions + and metrics. Unlike the client side integration which has the luxury of browsers + and the global window `ga` tracker, for server side we will check your `traits` + and your settings for custom dimension/metric mappings and send it with an explicit + event. ' + settings: [] + - name: metrics + display_name: Custom Metrics + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 200 + map_prefix: metric + select_options: [] + description: Because Google Analytics cannot accept arbitrary data about users + or events, when you use `analytics.identify(userId, traits)` with custom numerical + traits or `analytics.track('event', properties)` with custom numerical properties, + you need to map those traits and properties to Google Analytics custom metrics + if you want them to be sent to GA. Enter a trait or property name on the left. + Choose the Google Analytics metric you want on the right. Google Analytics only + accepts numbered metrics (e.g. metric3). We suggest using user-scoped metrics + for trait mappings and hit-scoped metrics for properties. [Contact us](https://segment.com/contact) + if you need help! + settings: [] + - name: serversideTrackingId + display_name: Serverside Tracking ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: "^UA-\\d+-\\d+$" + description: Your Serverside Tracking ID is the UA code for the Google Analytics + property you want to send server-side calls to. Leave it blank if you don't + have a server-side client library that you want to send data from. Remember + that data tracked from mobile integrations that are not bundled in your app + send data to Google Analytics server side, since Segment sends data to them + via our own servers. + settings: [] + - name: trackingId + display_name: Website Tracking ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: "^UA-\\d+-\\d+$" + description: Your website's Tracking ID is in the **Tracking Info** tab on the + [Admin Page](https://www.google.com/analytics/web/#management/Property) of Google + Analytics. Leave it blank if you don't have a website property. + settings: [] + - name: anonymizeIp + display_name: Anonymize IP Addresses + type: BOOLEAN + deprecated: false + required: false + description: For client side libraries. Read more about anonymizing IP addresses + from the [Google support documentation](https://support.google.com/analytics/answer/2763052?hl=en). + settings: [] + - name: trackNamedPages + display_name: Track Named Pages + type: BOOLEAN + deprecated: false + required: false + description: Tracks events to Google Analytics for [`page` method](https://segment.io/libraries/analytics.js#page) + calls that have a `name` associated with them. E.g. `page('Signup')` translates + to **Viewed Signup Page**. + settings: [] + - name: typeOverride + display_name: Send Segment "Product List" Events to GA as "Event" Hits + type: BOOLEAN + deprecated: false + required: false + description: By default, Segment sends "Product List Viewed" and "Product List + Filtered" ecommerce events to GA as "pageview" hit types. Enable this setting + to instead map these two specced Segment track events to GA as "event" hit types. + settings: [] + - name: classic + display_name: Use Classic Analytics on Your Site + type: BOOLEAN + deprecated: false + required: false + description: "**Important:** When creating your Google Analytics profile, you + can choose between **Classic** and **Universal** Analytics. After March 2013, + new profiles default to Universal, while earlier ones are Classic. An easy test: + if you see `_gaq.push` in your code you're using Classic, so enable this." + settings: [] + - name: identifyCategory + display_name: Server Side Identify Event Category + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: If you have **Enabled Server Side Identify**, you can specify the + trait you want to look up for setting the event category will be since all custom + metrics/dimensions for server side `.identify()` calls will be sent via an event + hit to GA. The default value will be `'All'`. For example, if you are sending + `traits.category`, you can put 'category' in the setting above and we will send + the value of this trait as the event category. + settings: [] + - name: identifyEventName + display_name: Server Side Identify Event Action + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: If you have **Enabled Server Side Identify**, you can specify what + the event action will be since all custom metrics/dimensions for server side + `.identify()` calls will be sent via an event hit to GA. The default value will + be `'User Enriched'` + settings: [] + - name: nonInteraction + display_name: Add the non-interaction flag to all events + type: BOOLEAN + deprecated: false + required: false + description: 'Adds a _noninteraction: true flag_ to every event tracked to Google + Analytics. If you''re seeing unusually low bounce rates this will solve that + issue.' + settings: [] + - name: sendUserId + display_name: Send User-ID to GA + type: BOOLEAN + deprecated: false + required: false + description: 'User-ID enables the analysis of groups of sessions across devices, + using a unique and persistent ID. This only works with Google Analytics Universal. + IMPORTANT: Sending email or other personally identifiable information (PII) + violates Google Analytics Terms of Service.' + settings: [] + - name: setAllMappedProps + display_name: Set Custom Dimensions & Metrics to the Page + type: BOOLEAN + deprecated: false + required: false + description: Google Analytics allows users to either pass custom dimensions / + metrics as properties of specific events or as properties for all events on + a given page (or the lifetime of the global tracker object). The default Segment + behavior is the latter. Any metrics / dimensions that are mapped to a given + property will be set to the page and sent as properties of all subsequent events + on that page. You can disable this functionality with this setting. If disabled, + Segment will only pass custom dimensions / metrics as part of the payload of + the event with which they are explicitly associated. Please reference the Google + Analytics [documentation](https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets#implementation) + for more info. + settings: [] + - name: useGoogleAmpClientId + display_name: Use Google AMP Client ID + type: BOOLEAN + deprecated: false + required: false + description: Google’s AMP Client ID API lets you uniquely identify users who engage + with your content on AMP and non-AMP pages. If you opt-in, Google Analytics + will use the user's AMP Client ID to determine that multiple site events belong + to the same user when those users visit AMP pages via a [Google viewer](https://support.google.com/websearch/answer/7220196). + Associating events and users provides features like user counts and session-based + metrics. *Enabling this feature will affect your reporting.* Please carefully + reference Google's [documentation](https://support.google.com/analytics/answer/7486764?hl=en&ref_topic=7378717) + for more info before you enable it. + settings: [] + - name: domain + display_name: Cookie Domain Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: "^none$|^[a-zA-Z0-9_-]+\\.[.a-zA-Z0-9_-]+$" + description: _Only data sent from visitors on this domain_ will be recorded. By + default Google Analytics automatically resolves the domain name, so you should + **leave this blank unless you know you want otherwise**! This option is useful + if you need to ignore data from other domains, or explicitly set the domain + of your Google Analytics cookie. This is known as Override Domain Name in [GA + Classic](https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingSite). + If you are testing locally, you can set the domain to `none`. [Read more about + this setting in our docs](/docs/integrations/google-analytics/#cookie-domain-name). + settings: [] + - name: ignoredReferrers + display_name: Ignored Referrers + type: MULTI_LINE_STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: 'Add any domains you want to ignore, separated by line breaks. You + might use this if you want Google Analytics to ignore certain referral domains + (e.g. to prevent your subdomains from showing up as referrers in your analytics). + _Note: this only works for Classic profiles. Universal profiles can_ [edit their + ignored referrers](https://support.google.com/analytics/answer/2795830?hl=en&ref_topic=2790009) + _directly inside Google Analytics._' + settings: [] + - name: optimize + display_name: Optimize Container ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Integrate with Google Analytics Optimize plugin. Please enter your + Optimize Container ID + settings: [] + - name: protocolMappings + display_name: Map Traits or Properties to Measurement Protocol Params + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - plt + - pdt + - gclid + description: If you are using the *server side* GA integration, you can map your + custom traits or properties to known [measurement protocol params](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters). + settings: [] + - name: doubleClick + display_name: Remarketing, Display Ads and Demographic Reports. + type: BOOLEAN + deprecated: false + required: false + description: Works with both Universal and Classic tracking methods. + settings: [] + - name: siteSpeedSampleRate + display_name: Site Speed Sample Rate + type: NUMBER + deprecated: false + required: false + number_validators: + min: 1 + max: 100 + description: Defines the sample size for Site Speed data collection. If you have + a small number of visitors you might want to adjust the sampling to a larger + rate for your [site speed stats](https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration?hl=en#_gat.GA_Tracker_._setSiteSpeedSampleRate). + settings: [] + - name: nameTracker + display_name: Name Tracker + type: BOOLEAN + deprecated: false + required: false + description: 'Name the tracker ''segmentGATracker''. Enable this if you''re working + with additional Google Analytics trackers and want to ensure that your Segment + tracker has a distinct name. If this is enabled you must prepend this tracker + name to any native Google Analytics (except for create) that you call, e.g. + ''segmentGATracker.require(....)'' ' + settings: [] + - name: includeSearch + display_name: Include the Querystring in Page Views + type: BOOLEAN + deprecated: false + required: false + description: The querystring doesn't usually affect the content of the page in + a significant way (like sorting), so we disable this by default. + settings: [] + - name: reportUncaughtExceptions + display_name: Send Uncaught Exceptions to GA (Mobile) + type: BOOLEAN + deprecated: false + required: false + description: This lets you study errors and exceptions in your iOS and Android + apps in Google Analytics. + settings: [] + - name: enhancedEcommerce + display_name: Enable Enhanced Ecommerce + type: BOOLEAN + deprecated: false + required: false + description: If you want more detailed reports on ecommerce, you might want to + enable this feature. Read more about it [here](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce). + settings: [] + - name: dimensions + display_name: Custom Dimensions + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 200 + map_prefix: dimension + select_options: [] + description: Because Google Analytics cannot accept arbitrary data about users + or events, when you use `analytics.identify(userId, traits)` with custom traits + or `analytics.track('event', properties)` with custom properties, you need to + map those traits and properties to Google Analytics custom dimensions if you + want them to be sent to GA. Enter a trait or property name on the left. Choose + the Google Analytics dimension you want on the right. Google Analytics only + accepts numbered dimensions (e.g. dimension3). We suggest using user-scoped + dimensions for trait mappings and hit-scoped dimensions for properties [Contact + us](https://segment.com/contact) if you need help! + settings: [] + - name: mobileTrackingId + display_name: Mobile Tracking ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: "^UA-\\d+-\\d+$" + description: Google Analytics tracks mobile apps separately, so you'll want to + create a separate Google Analytics mobile app property. Remember to only add + a mobile tracking ID if you're tracking from a mobile library. If you're tracking + from a hybrid app, fill in your website tracking ID instead. Leave it blank + if you don't have a mobile app property. + settings: [] + - name: sampleRate + display_name: Sample Rate + type: NUMBER + deprecated: false + required: false + number_validators: + min: 1 + max: 100 + description: Specifies what percentage of users should be tracked. This defaults + to 100 (no users are sampled out) but large sites may need to use a lower sample + rate to stay within Google Analytics processing limits as [seen here](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#sampleRate). + Currently only available in the browser - mobile coming soon. + settings: [] + - name: serversideClassic + display_name: Use Classic Analytics for Your Serverside Tracking + type: BOOLEAN + deprecated: false + required: false + description: "**Important:** When creating your Google Analytics profile, you + can choose between **Classic** and **Universal** Analytics. After March 2013, + new profiles default to Universal, while earlier profiles are Classic. An easy + test: if you see `_gaq.push` in your code you're using Classic, so enable this." + settings: [] + - name: contentGroupings + display_name: Content Groupings + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 5 + map_prefix: contentGroup + select_options: [] + description: Enter a property name on the left. Choose the Google Analytics content + grouping you want on the right. Google Analytics only accepts numbered content + groupings (e.g. contentGrouping3). When you use `analytics.page(name, properties)` + with custom properties, we'll use the value of the property you designate as + the value of the specified content grouping. + settings: [] + - name: trackCategorizedPages + display_name: Track Categorized Pages + type: BOOLEAN + deprecated: false + required: false + description: Tracks events to Google Analytics for [`page` method](https://segment.io/libraries/analytics.js#page) + calls that have a `category` associated with them. E.g. `page('Docs', 'Index')` + translates to **Viewed Docs Page**. + settings: [] + - name: enhancedLinkAttribution + display_name: Enable Enhanced Link Attribution + type: BOOLEAN + deprecated: false + required: false + description: Provides more detailed reports on the links clicked on your site. + Read more about it in the [Google support documentation](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-link-attribution). + settings: [] +- name: catalog/destinations/google-cloud-function + display_name: Google Cloud Function + description: Google Cloud Functions is a lightweight compute solution for developers + to create single-purpose, stand-alone functions that respond to Cloud events without + the need to manage a server or runtime environment. + type: STREAMING + website: https://cloud.google.com/function + status: PUBLIC_BETA + logos: + logo: https://cdn.filepicker.io/api/file/xpi1OZczTee4HGiecrEM + mark: https://cdn.filepicker.io/api/file/WiFQdbz0Q1mTNVov0YSh + categories: + primary: Raw Data + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: httpTrigger + display_name: HTTP Trigger + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The URL to call the Google Cloud Function. + settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: The api key used to identify request performed by Segment. + settings: [] +- name: catalog/destinations/google-cloud-pubsub + display_name: Google Cloud PubSub + description: 'Ingest event streams from anywhere, at any scale, for simple, reliable, + real-time stream analytics. Google Cloud Pub/Sub is a simple, reliable, scalable + foundation for stream analytics and event-driven computing systems. ' + type: STREAMING + website: https://cloud.google.com/pubsub/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/Z66JAyLSXW9liZiZVqgI + mark: https://cdn.filepicker.io/api/file/4ovy1EpqSDm0yDnfL2kI + categories: + primary: Raw Data + secondary: '' + additional: [] + components: + - type: WEB + - type: IOS + - type: ANDROID + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: mappedTopics + display_name: Mapped Topics + type: MIXED + deprecated: false + required: false + description: Map your Segment events / event types to your Google Cloud Pub/Sub + topics. + settings: [] +- name: catalog/destinations/google-tag-manager + display_name: Google Tag Manager + description: Google Tag Manager lets you add or update your website tags, easily + and for free. + type: STREAMING + website: https://www.google.com/analytics/tag-manager/ + status: PUBLIC + logos: + logo: https://cdn.filepicker.io/api/file/M6fnhTBxTT6chfCz5G2Q + mark: https://cdn.filepicker.io/api/file/JL6sFm7tTlq2915HPGQj + categories: + primary: Tag Managers + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: containerId + display_name: Container ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your Container ID in your [Accounts page](https://www.google.com/tagmanager/web/#management/Accounts/). + settings: [] + - name: environment + display_name: Environment + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: 'If you''re using an ''environment'' variable for gtm_preview in + your tag''s query string, you can put that string here. **IMPORTANT**: make + sure the string includes `gtm_auth`. For example, your string should look like + `env-xx>m_auth=xxxxxx`' + settings: [] + - name: trackAllPages + display_name: Track All Pages + type: BOOLEAN + deprecated: false + required: false + description: This will track events titled **'Loaded A Page'** to Google Tag Manager + whenever you call our [`page` method](https://segment.io/libraries/analytics.js#page) + settings: [] + - name: trackCategorizedPages + display_name: Track Categorized Pages + type: BOOLEAN + deprecated: false + required: false + description: This will track events to Google Tag Manager for [`page` method](https://segment.io/libraries/analytics.js#page) + calls that have a `category` associated with them. For example `page('Docs', + 'Index')` would translate to **Viewed Docs Index Page**. + settings: [] + - name: trackNamedPages + display_name: Track Named Pages + type: BOOLEAN + deprecated: false + required: false + description: This will track events to Google Tag Manager for [`page` method](https://segment.io/libraries/analytics.js#page) + calls that have a `name` associated with them. For example `page('Signup')` + would translate to **Viewed Signup Page**. + settings: [] +- name: catalog/destinations/gosquared + display_name: GoSquared + description: GoSquared offers real-time user-level analytics for sites and apps. + With people analytics, powerful filtering, events and e-commerce tracking, GoSquared + puts all your user data in one place. + type: STREAMING + website: http://gosquared.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/gosquared-default.svg + mark: https://cdn.filepicker.io/api/file/diKY2MkjRVsXAVJVWi2w + categories: + primary: Analytics + secondary: Livechat + additional: + - CRM + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiSecret + display_name: Site Token + type: STRING + deprecated: false + required: false + string_validators: + regexp: "^GSN-\\d{6}-[A-Z]$" + description: You can find your Site Token by viewing the GoSquared [Integration + guide](https://www.gosquared.com/integration/). It should look something like + `GSN-123456-A`. + settings: [] + - name: trackParams + display_name: Track Parameters + type: BOOLEAN + deprecated: false + required: false + description: Disable to ignore URL querystring parameters from the page URL, for + example `/home?my=query&string=true` will be tracked as `/home` if this is set + to disabled. + settings: [] + - name: useCookies + display_name: Use Cookies + type: BOOLEAN + deprecated: false + required: false + description: Disable this if you don't want to use cookies + settings: [] + - name: anonymizeIP + display_name: Anonymize IP + type: BOOLEAN + deprecated: false + required: false + description: Enable if you need to anonymize the IP address of visitors to your + website. + settings: [] + - name: apiKey + display_name: API Key (Server-side) + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: 'Generate your server-side API key here: https://www.gosquared.com/settings/api' + settings: [] + - name: cookieDomain + display_name: Cookie Domain + type: STRING + deprecated: false + required: false + string_validators: + regexp: "^[.a-zA-Z0-9_-]+\\.[.a-zA-Z0-9_-]+$" + description: Use this if you wish to share GoSquared’s tracking cookies across + subdomains, `.example.com` will enable shared tracking across all example’s + subdomains. By default, cookies are set on the current domain (including subdomain) + only. + settings: [] + - name: trackHash + display_name: Track Hash + type: BOOLEAN + deprecated: false + required: false + description: Enable if you'd like page hashes to be tracked alongside the page + URL. By default, `example.com/about#us` will be tracked as `example.com/about`. + settings: [] + - name: trackLocal + display_name: Track Local + type: BOOLEAN + deprecated: false + required: false + description: Enable to track data on local pages/sites (using the `file://` protocol, + or on `localhost`). This helps prevent local development from polluting your + stats. + settings: [] +- name: catalog/destinations/hasoffers + display_name: HasOffers + description: HasOffers helps networks, advertisers, and media buyers to measure, + analyze, and optimize their mobile and online marketing campaigns—in real time. + type: STREAMING + website: http://www.hasoffers.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/hasoffers-default.svg + mark: https://cdn.filepicker.io/api/file/P2aIrSIQwifJjqA5PaAG + categories: + primary: Advertising + secondary: '' + additional: [] + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: true + group: true + identify: true + page_view: true + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: Network Id + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your HasOffers Network Id can be found under Support > API + settings: [] +- name: catalog/destinations/heap + display_name: Heap + description: Heap is an analytics tool that automatically tracks all of the actions + your users perform just by flipping a switch, instead of after adding custom tracking + code. + type: STREAMING + website: http://heapanalytics.com + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/heap-default.svg + mark: https://cdn.filepicker.io/api/file/jhJBfmjkQIuqEEOhqNEW + categories: + primary: Analytics + secondary: '' + additional: [] + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + methods: + alias: false + group: false + identify: true + page_view: false + track: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: appId + display_name: App ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^\\d+$" + description: You can find the snippet containing your app ID in Heap's [QuickStart + docs](https://heapanalytics.com/docs#quickstart). It's inside the `heap.load('YOUR_APP_ID')` + function call. + settings: [] +- name: catalog/destinations/hello-bar + display_name: Hello Bar + description: Hello Bar is a free optimization tool that allows you to show the right + message at the right time to your website visitors. + type: STREAMING + website: https://www.hellobar.com/ + status: PUBLIC + logos: + logo: https://d3hotuclm6if1r.cloudfront.net/logos/hellobar-default.svg + mark: https://cdn.filepicker.io/api/file/ygF17BmtTYKma8wWHKfg + categories: + primary: Personalization + secondary: '' + additional: [] + components: + - type: WEB + platforms: + browser: true + server: false + mobile: false + methods: + alias: false + group: false + identify: false + page_view: false + track: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: "^[A-Za-z0-9]{40}$" + description: 'You can find your Hello Bar API Key, in the provided `