diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index 08435dfef8..47e5e6ff2d 100644 --- a/src/_data/catalog/destination_categories.yml +++ b/src/_data/catalog/destination_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# destination categories last updated 2021-06-16 +# destination categories last updated 2021-06-22 items: - display_name: Email Marketing slug: email-marketing diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index 33971f67af..077866709c 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# destination data last updated 2021-06-16 +# destination data last updated 2021-06-22 items: - display_name: ActiveCampaign slug: activecampaign @@ -4209,6 +4209,68 @@ items: Please contact your Button representative for instructions on finding your Segment-specific API key. settings: [] +- display_name: BuzzBoard + slug: buzzboard + name: catalog/destinations/smbstream + url: connections/destinations/catalog/buzzboard + description: >- + SMBStreams provides self-serve predictive analytics for growth marketers, + leveraging machine learning to automate audience insights and + recommendations. The most comprehensive set of data is maintained, + integrated and then delivered as important insights across your sales and + marketing organization. + hidden: false + status: PUBLIC_BETA + previous_names: + - smbstream + - SMBStreams + - BuzzBoard + logo: + url: 'https://cdn.filepicker.io/api/file/0o92EgabRzupoMvB0vxc' + mark: + url: 'https://cdn.filepicker.io/api/file/DANaxSdTLSPUGagHWQmc' + categories: + - Enrichment + - Analytics + - Enrichment + methods: + alias: false + group: false + identify: true + page_view: false + track: false + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: true + mobile: true + server: true + summary: >- + accepts cloud-mode data from all Segment source types. It does not offer + device-mode connections. + cmode_type: cloud-only + case: '5' + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: You can find your API token in the SMBStreams Dashboard. + settings: [] - display_name: ByteGain slug: bytegain name: catalog/destinations/bytegain @@ -10322,6 +10384,20 @@ items: more about it in the [Google support documentation](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-link-attribution). settings: [] + - name: topLevelContextMapping + display_name: Enable Mappings from Top-Level or Context Fields - Server Side Only + type: BOOLEAN + deprecated: false + required: false + description: >- + By default, Segment allows mappings from custom traits and properties to + Google Analytics custom dimensions and metrics. If you enable this + setting, Segment will also send top-level and `context` object fields + mapped in the **Custom Dimensions** and **Custom Metrics** settings. When + evaluating mappings, Segment will prioritize properties and traits before + top-level and `context` fields. This setting only applies to server side + connections. + settings: [] - name: enableServerIdentify display_name: Enable Server Side Identify type: BOOLEAN @@ -12127,84 +12203,6 @@ items: beginning of your embed code snippet. (It's a big number.). It should be a series of numbers, like `9492461759`. settings: [] -- display_name: Interana - slug: interana - name: catalog/destinations/interana - url: connections/destinations/catalog/interana - description: Behavioral Product Analytics for the GDPR Era - hidden: false - status: PUBLIC_BETA - previous_names: - - interana - - Interana - logo: - url: >- - https://public-segment-devcenter-production.s3.amazonaws.com/aa62411e-8a50-467b-9b76-edb083819144.svg - mark: - url: >- - https://public-segment-devcenter-production.s3.amazonaws.com/97c63f06-f139-44dc-9524-ba287a1d2900.svg - categories: - - Analytics - - Attribution - - Customer Success - - Raw Data - methods: - alias: true - group: true - identify: true - page_view: true - track: true - components: [] - platforms: - browser: true - server: true - mobile: true - browserUnbundlingSupported: false - browserUnbundlingPublic: false - connection_modes: - device: - web: false - mobile: false - server: false - cloud: - web: false - mobile: false - server: false - summary: No connection mode information available. - cmode_type: none - case: '0' - settings: - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^.{8,}$' - description: >- - Enter your S3 credentials or your Azure Blob Storage Shared Access - Signature (SAS). - settings: [] - - name: bucketContainerUrl - display_name: BUCKET CONTAINER URL - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Enter URL for the AWS S3 bucket name or Azure Blob Storage container. - (e.g. 'https://my-storage.blob.core.windows.net/my-container' ). - settings: [] - - name: platform - display_name: PLATFORM - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter 'AWS' or 'Azure' - settings: [] - display_name: Intercom slug: intercom name: catalog/destinations/intercom @@ -14613,13 +14611,6 @@ items: required: false description: Map your Segment properties to the Marketo Activity Fields settings: - - name: primaryKey - display_name: Set as Primary Key - type: BOOLEAN - deprecated: false - required: false - description: Mark this property as the Primary field in Marketo. - settings: [] - name: segmentProperty display_name: Segment Property Name type: STRING @@ -14655,6 +14646,13 @@ items: - date description: Enter the Marketo Field type. settings: [] + - name: primaryKey + display_name: Set as Primary Key + type: BOOLEAN + deprecated: false + required: false + description: Mark this property as the Primary field in Marketo. + settings: [] - name: event display_name: Segment Event Name type: STRING @@ -19948,67 +19946,6 @@ items: regexp: '' description: Alert title. settings: [] -- display_name: SMBStreams - slug: smbstreams - name: catalog/destinations/smbstream - url: connections/destinations/catalog/smbstreams - description: >- - SMBStreams provides self-serve predictive analytics for growth marketers, - leveraging machine learning to automate audience insights and - recommendations. The most comprehensive set of data is maintained, - integrated and then delivered as important insights across your sales and - marketing organization. - hidden: false - status: PUBLIC_BETA - previous_names: - - smbstream - - SMBStreams - logo: - url: 'https://cdn.filepicker.io/api/file/0o92EgabRzupoMvB0vxc' - mark: - url: 'https://cdn.filepicker.io/api/file/DANaxSdTLSPUGagHWQmc' - categories: - - Enrichment - - Analytics - - Enrichment - methods: - alias: false - group: false - identify: true - page_view: false - track: false - components: - - type: CLOUD - platforms: - browser: true - server: true - mobile: true - browserUnbundlingSupported: false - browserUnbundlingPublic: true - connection_modes: - device: - web: false - mobile: false - server: false - cloud: - web: true - mobile: true - server: true - summary: >- - accepts cloud-mode data from all Segment source types. It does not offer - device-mode connections. - cmode_type: cloud-only - case: '5' - settings: - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^.{8,}$' - description: You can find your API token in the SMBStreams Dashboard. - settings: [] - display_name: SaaSquatch slug: saasquatch name: catalog/destinations/saasquatch @@ -20886,6 +20823,85 @@ items: Token that displays after you click 'Show Token' on your Segment integration panel within ScopeAI. settings: [] +- display_name: Scuba Analytics + slug: scuba-analytics + name: catalog/destinations/interana + url: connections/destinations/catalog/scuba-analytics + description: Behavioral Product Analytics for the GDPR Era + hidden: false + status: PUBLIC_BETA + previous_names: + - interana + - Interana + - Scuba Analytics + logo: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/aa62411e-8a50-467b-9b76-edb083819144.svg + mark: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/97c63f06-f139-44dc-9524-ba287a1d2900.svg + categories: + - Analytics + - Attribution + - Customer Success + - Raw Data + methods: + alias: true + group: true + identify: true + page_view: true + track: true + components: [] + platforms: + browser: true + server: true + mobile: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + summary: No connection mode information available. + cmode_type: none + case: '0' + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: >- + Enter your S3 credentials or your Azure Blob Storage Shared Access + Signature (SAS). + settings: [] + - name: bucketContainerUrl + display_name: BUCKET CONTAINER URL + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Enter URL for the AWS S3 bucket name or Azure Blob Storage container. + (e.g. 'https://my-storage.blob.core.windows.net/my-container' ). + settings: [] + - name: platform + display_name: PLATFORM + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter 'AWS' or 'Azure' + settings: [] - display_name: Seg slug: seg name: catalog/destinations/seg @@ -22476,7 +22492,7 @@ items: ready Templates available on the platform like retention, segmentation, sales forecasting and more. hidden: false - status: PUBLIC_BETA + status: PUBLIC previous_names: - Stormly logo: @@ -26157,10 +26173,10 @@ items: max: 0 description: Time interval in milliseconds between each ping settings: [] -- display_name: Wootric - slug: wootric +- display_name: Wootric by InMoment + slug: wootric-by-inmoment name: catalog/destinations/wootric - url: connections/destinations/catalog/wootric + url: connections/destinations/catalog/wootric-by-inmoment description: >- Wootric collects customer feedback inside your web application or native mobile app using the Net Promoter Score℠. Track ongoing NPS®, follow up with @@ -26169,6 +26185,7 @@ items: status: PUBLIC previous_names: - Wootric + - Wootric by InMoment logo: url: 'https://cdn.filepicker.io/api/file/oplSWcoDT8GOEP3wwczT' mark: diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index 9f84dbe391..db42e051cb 100644 --- a/src/_data/catalog/source_categories.yml +++ b/src/_data/catalog/source_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# source cateogries last updated 2021-06-16 +# source cateogries last updated 2021-06-22 items: - display_name: Server slug: server diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index 90d0d22b95..61ab6359be 100644 --- a/src/_data/catalog/sources.yml +++ b/src/_data/catalog/sources.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# sources last updated 2021-06-16 +# sources last updated 2021-06-22 items: - display_name: .NET slug: net diff --git a/src/connections/destinations/catalog/buzzboard/index.md b/src/connections/destinations/catalog/buzzboard/index.md new file mode 100644 index 0000000000..2d4a212c84 --- /dev/null +++ b/src/connections/destinations/catalog/buzzboard/index.md @@ -0,0 +1,39 @@ +--- +title: 'BuzzBoard Destination' +rewrite: true +beta: true +redirect_from: '/connections/destinations/catalog/smbstream/' +--- + +[BuzzBoard](https://www.buzzboard.com/smbstreams/solutions/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) provides self-serve predictive analytics for growth marketers, leveraging machine learning to automate audience insights and recommendations. The most comprehensive set of data is maintained, integrated and then delivered as important insights across your sales and marketing organization. + +This destination is maintained by BuzzBoard. For any issues with the destination, [contact the BuzzBoard Support team](mailto:support@buzzboard.com). + +{% include content/beta-note.md %} + +## Getting Started + +{% include content/connection-modes.md %} + +1. From the Segment web app, click **Catalog**. +2. Search for "BuzzBoard" in the Catalog, select it, and choose which of your sources to connect the destination to. +3. Enter the "API Key" into your Segment Settings UI which you can find from your BuzzBoard [Dashboard](https://sales.buzzboard.com/v5/stream-dashboard). + + +## Identify + +If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example call would look like: + +```js +analytics.identify('John123', { + email: 'john.lewis@example.com' +}); +``` + +**NOTE:** `userId` and `email` are required traits in order for BuzzBoard to enrich your data. + +Identify calls will be sent to BuzzBoard with the required traits, matching and sending the full profile with enriched data downstream through Segment to all your other enabled Destinations as a new `identify` call within your Segment Source. + +While your data is being enriched, a `track` call will appear in your Segment Debugger with event name `enrichment_in_progress`. + +In order to send back the data to your Segment source, BuzzBoard would need the write key access. For this, you would have to add the Segment write key by going into the BuzzBoard [Dashboard](https://sales.buzzboard.com/v5/stream-dashboard). diff --git a/src/connections/destinations/catalog/interana/index.md b/src/connections/destinations/catalog/scuba-analytics/index.md similarity index 69% rename from src/connections/destinations/catalog/interana/index.md rename to src/connections/destinations/catalog/scuba-analytics/index.md index 40ce38cfd6..a7b88a3d8d 100644 --- a/src/connections/destinations/catalog/interana/index.md +++ b/src/connections/destinations/catalog/scuba-analytics/index.md @@ -1,10 +1,11 @@ --- -title: Interana Destination +title: Scuba Analytics Destination rewrite: true +redirect_from: '/connections/destinations/catalog/interana/' --- -[Interana's](https://www.interana.com/segment/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) full stack solution allows you to visually explore trillions of data points from multiple data sets all in real time without the need for ETL, data aggregation, or writing any SQL. +[Scuba Analytics's](https://www.interana.com/segment/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) full stack solution allows you to visually explore trillions of data points from multiple data sets all in real time without the need for ETL, data aggregation, or writing any SQL. -This destination is maintained by Interana. For any issues with the destination, [contact the Interana Support team](mailto:support@interana.com). +This destination is maintained by Scuba Analytics. For any issues with the destination, [contact the Scuba Analytics Support team](mailto:support@interana.com). {% include content/beta-note.md %} @@ -12,14 +13,14 @@ This destination is maintained by Interana. For any issues with the destination, {% include content/connection-modes.md %} -To set up the Interana Integration, first you will need: +To set up the Scuba Analytics Integration, first you will need: The root URL for your destination cloud storage directory * For AWS S3 this is typically in the format or ``https://{your bucket}.{your region}.amazonaws.com/{your directory}`` * For Azure Blob Storage this is typically in formation of ``https://{your storage account name}.blob.core.windows.net/{your container}`` Credentials to access your cloud storage account * For AWS and S3 backed clusters you will need S3 credentials with write access to your bucket * For Azure and Blob Storage backed clusters you will need a Shared Access Signature with write access to your container -To begin sending data to Interana from the Segment portal select Interana as a new destination. +To begin sending data to Scuba Analytics from the Segment portal select Scuba Analytics as a new destination. 1. In the "API Key" field insert your Blob Shared Access Signature or your S3 credentials. For S3 credentials, comma separate the access key id & the secret access key in the format of "accessKeyId,secretAccessKey" 2. In the "Bucket Container URL" field insert the URL for the cloud storage directory. * For S3: ``https://{your bucket}.{your region}.amazonaws.com/{your directory}`` @@ -28,7 +29,7 @@ To begin sending data to Interana from the Segment portal select Interana as a n ## Methods Supported -All methods will be tracked as a new event in Interana with the associated method as an attribute of the event. +All methods will be tracked as a new event in Scuba Analytics with the associated method as an attribute of the event. ## Page @@ -48,7 +49,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th ## Identify -If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. Identify methods can be used with Actors properties and Flow Properties in Interana to update the associate with the user in the Identify method. An example call would look like: +If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. Identify methods can be used with Actors properties and Flow Properties in Scuba Analytics to update the associate with the user in the Identify method. An example call would look like: ``` analytics.identify('userId123', { diff --git a/src/connections/destinations/catalog/smbstreams/index.md b/src/connections/destinations/catalog/smbstreams/index.md deleted file mode 100644 index eb9dc78043..0000000000 --- a/src/connections/destinations/catalog/smbstreams/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: 'SMBStreams Destination' -rewrite: true -beta: true -redirect_from: '/connections/destinations/catalog/smbstream/' ---- - -[SMBStreams](https://www.buzzboard.com/smbstreams/solutions/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) provides self-serve predictive analytics for growth marketers, leveraging machine learning to automate audience insights and recommendations. The most comprehensive set of data is maintained, integrated and then delivered as important insights across your sales and marketing organization. - -This destination is maintained by SMBStreams. For any issues with the destination, [contact the SMBStreams Support team](mailto:support@buzzboard.com). - -{% include content/beta-note.md %} - -## Getting Started - -{% include content/connection-modes.md %} - -1. From the Segment web app, click **Catalog**. -2. Search for "SMBStreams" in the Catalog, select it, and choose which of your sources to connect the destination to. -3. Enter the "API Key" into your Segment Settings UI which you can find from your SMBStreams [Dashboard](https://sales.buzzboard.com/v5/stream-dashboard). - - -## Identify - -If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example call would look like: - -```js -analytics.identify('John123', { - email: 'john.lewis@example.com' -}); -``` - -**NOTE:** `userId` and `email` are required traits in order for SMBStreams to enrich your data. - -Identify calls will be sent to SMBStreams with the required traits, matching and sending the full profile with enriched data downstream through Segment to all your other enabled Destinations as a new `identify` call within your Segment Source. - -While your data is being enriched, a `track` call will appear in your Segment Debugger with event name `enrichment_in_progress`. - -In order to send back the data to your Segment source, SMBStreams would need the write key access. For this, you would have to add the Segment write key by going into the SMBStreams [Dashboard](https://sales.buzzboard.com/v5/stream-dashboard). diff --git a/src/connections/destinations/catalog/wootric-by-inmoment/index.md b/src/connections/destinations/catalog/wootric-by-inmoment/index.md new file mode 100644 index 0000000000..6436cd6581 --- /dev/null +++ b/src/connections/destinations/catalog/wootric-by-inmoment/index.md @@ -0,0 +1,74 @@ +--- +title: Wootric by InMoment by InMoment Destination +rewrite: true +redirect_from: '/connections/destinations/catalog/wootric/' +--- + +[Wootric by InMoment](https://www.wootric.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is the modern customer feedback management platform that brands around the globe use to make experience their competitive advantage. + +The Wootric by InMoment Destination is open-source. You can browse the code [on GitHub](https://github.com/segment-integrations/analytics.js-integration-wootric). + +This document was last updated on January 23, 2020. If you notice any gaps, out-dated information or simply want to leave some feedback to help us improve our documentation, [contact Wootric by InMoment Support](mailto:support@wootric.com)! + + +## Getting Started + +{% include content/connection-modes.md %} + +1. From the Segment web app, click **Catalog**. +2. Search for "Wootric by InMoment" in the Catalog, select it, and choose which of your sources to connect the destination to. +3. In the destination settings, enter your Wootric by InMoment "Account Token". + You can retrieve this from your **Wootric by InMoment Settings > Your unique Account Token**. It should look like `NPS-XXXXXXXX`. +4. If you're using Segment's client-side `analytics.js` library, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Wootric by InMoment's Javascript library onto the page and begins sending data. + +### Mobile + +1. For mobile implementations additional settings are required. Navigate to your Wootric by InMoment Settings > API to add in your "Client ID" and "Client Secret" to the respective parts of the Segment Settings UI. + +**IMPORTANT:** The incoming responses and surveys will not be tied to a user until you [identify](https://segment.com/docs/connections/destinations/catalog/wootric-by-inmoment/#identify) your user. + + +## Identify + +If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example call would look like: + +```javascript +analytics.identify('userId123', { + email: 'hello@example.com', + createdAt: '2018-08-03T15:28:46.493Z', + language: 'EN' +}); +``` + +When you call Identify, the user's information is passed to Wootric by InMoment to check eligibility during survey responses. Segment's special traits recognized as Wootric by InMoment's standard user profile fields (in parentheses) are: + +| Segment Parameter | Wootric by InMoment Parameter | Description | +| ------------------ | ------------------------------------ | ------------------------------------ | +| `email` | `wootricSettings.email` | The email of this user. | +| `createdAt` | `wootricSettings.created_at` | ISO 8610 timestamp. Wootric requires the timestamp to be rounded to the nearest second so we will make this conversion for you. | +| `language` | `wootricSettings.language` | Language for Wootric's Net Promoter Score (NPS). | + + +## Track + +When you call Track, the user’s information is passed along with the event name to Wootric by InMoment to check eligibility during survey responses. +> note "" +> **Note**: this only works if you enable Targeted Sampling in your Wootric by InMoment account. The event name must be exactly the same as the one used in the Track call. + +## Page + +If you aren't familiar with the Segment Spec, you should first read about what the [Page method](https://segment.com/docs/connections/spec/page/) does. An example call would look like: + +```js +analytics.page() +``` + +Segment sends Page calls to Wootric by InMoment as a `pageview`. + +When you call Page, Wootric by InMoment tracks the URL, page name, and page path that you are currently on. You can use this information in the Wootric by InMoment Settings to trigger surveys by using Wootric by InMoment's Targeted Sampling feature. +Wootric by InMoment recognizes the following Segment Page properties as the following page fields: + +| Segment Parameter | Wootric by InMoment Parameter | Description | +| ------------------ | ------------------------------------ | ------------------------------------ | +| `name` | `wootricSettings.email` | The name assigned to this page. | +| `path` | `wootricSettings.page_info.path` | The path portion of the URL of the page. Equivalent to the canonical path which defaults to `location.pathname` from the DOM API. | diff --git a/src/connections/destinations/catalog/wootric/index.md b/src/connections/destinations/catalog/wootric/index.md deleted file mode 100644 index 092637064e..0000000000 --- a/src/connections/destinations/catalog/wootric/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -rewrite: true -title: Wootric Destination ---- - -[Wootric](https://www.wootric.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is the modern customer feedback management platform that brands around the globe use to make experience their competitive advantage. - -The Wootric Destination is open-source. You can browse the code [on GitHub](https://github.com/segment-integrations/analytics.js-integration-wootric). - -This document was last updated on January 23, 2020. If you notice any gaps, out-dated information or simply want to leave some feedback to help us improve our documentation, [contact Wootric Support](mailto:support@wootric.com)! - - -## Getting Started - -{% include content/connection-modes.md %} - -1. From the Segment web app, click **Catalog**. -2. Search for "Wootric" in the Catalog, select it, and choose which of your sources to connect the destination to. -3. In the destination settings, enter your Wootric "Account Token". - You can retrieve this from your **Wootric Settings > Your unique Account Token**. It should look like `NPS-XXXXXXXX`. -4. If you're using Segment's client-side `analytics.js` library, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Wootric's Javascript library onto the page and begins sending data. - -### Mobile - -1. For mobile implementations additional settings are required. Navigate to your Wootric Settings > API to add in your "Client ID" and "Client Secret" to the respective parts of the Segment Settings UI. - -**IMPORTANT:** The incoming responses and surveys will not be tied to a user until you [identify](https://segment.com/docs/connections/destinations/catalog/wootric/#identify) your user. - - -## Identify - -If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example call would look like: - -```javascript -analytics.identify('userId123', { - email: 'hello@example.com', - createdAt: '2018-08-03T15:28:46.493Z', - language: 'EN' -}); -``` - -When you call Identify, the user's information is passed to Wootric to check eligibility during survey responses. Segment's special traits recognized as Wootric's standard user profile fields (in parentheses) are: - -| Segment Parameter | Wootric Parameter | Description | -| ------------------ | ------------------------------------ | ------------------------------------ | -| `email` | `wootricSettings.email` | The email of this user. | -| `createdAt` | `wootricSettings.created_at` | ISO 8610 timestamp. Wootric requires the timestamp to be rounded to the nearest second so we will make this conversion for you. | -| `language` | `wootricSettings.language` | Language for Wootric's Net Promoter Score (NPS). | - - -## Track - -When you call Track, the user’s information is passed along with the event name to Wootric to check eligibility during survey responses. -> note "" -> **Note**: this only works if you enable Targeted Sampling in your Wootric account. The event name must be exactly the same as the one used in the Track call. - -## Page - -If you aren't familiar with the Segment Spec, you should first read about what the [Page method](https://segment.com/docs/connections/spec/page/) does. An example call would look like: - -```js -analytics.page() -``` - -Segment sends Page calls to Wootric as a `pageview`. - -When you call Page, Wootric tracks the URL, page name, and page path that you are currently on. You can use this information in the Wootric Settings to trigger surveys by using Wootric's Targeted Sampling feature. -Wootric recognizes the following Segment Page properties as the following page fields: - -| Segment Parameter | Wootric Parameter | Description | -| ------------------ | ------------------------------------ | ------------------------------------ | -| `name` | `wootricSettings.email` | The name assigned to this page. | -| `path` | `wootricSettings.page_info.path` | The path portion of the URL of the page. Equivalent to the canonical path which defaults to `location.pathname` from the DOM API. |