From b13f43abc74778a66b974bf6f4e4fc086dbe3b51 Mon Sep 17 00:00:00 2001 From: Sneha Shashidhar Date: Wed, 23 Mar 2022 16:02:45 +0000 Subject: [PATCH 1/2] Groundswell doc --- .../destinations/catalog/groundswell/index.md | 68 +++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 src/connections/destinations/catalog/groundswell/index.md diff --git a/src/connections/destinations/catalog/groundswell/index.md b/src/connections/destinations/catalog/groundswell/index.md new file mode 100644 index 0000000000..9593f26a31 --- /dev/null +++ b/src/connections/destinations/catalog/groundswell/index.md @@ -0,0 +1,68 @@ +--- +title: Groundswell Destination +rewrite: true +--- + +[Groundswell](https://www.trygroundswell.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) empowers sales teams with just-in-time notifications and account prioritization based on product usage insights. + +This destination is maintained by Groundswell. For any issues with the destination, [contact the Groundswell Support team](mailto:support@trygroundswell.com). + + +## Getting Started + +{% include content/connection-modes.md %} + +1. From the Destinations catalog page in the Segment App, click **Add Destination**. +2. Search for "Groundswell" in the Destinations Catalog, and select the Groundswell destination. +3. Choose which Source should send data to the Groundswell destination. +4. Connect Segment from the ["Integrations" page](https://app.trygroundswell.com/integrations) of the Groundswell web app, then copy the "API Key". +5. Enter the "API Key" in the Groundswell destination settings in Segment. +6. When you return to the Groundswell web app, you’ll be prompted to select mappings between Segment traits and Groundswell properties. You'll be able to use these later to define workflows and send data to other tools. + - Select whether you are identifying Companies via `Group` or `Identify` traits. + - Provide the names of Segment traits for all required Groundswell properties for both Companies and People. + - Add any additional mappings you wish to provide for Companies and People. +7. As Groundswell begins receiving events from Segment... + - You'll be able to add Signals from the "Signals" page. + - People and Companies identified by Groundswell will appear on the People and Companies pages, respectively. This is a good way to confirm your mappings are configured properly. + + +## Supported methods + +Groundswell supports the following methods, as specified in the [Segment Spec](/docs/connections/spec). + + +### Identify + +Send [Identify](/docs/connections/spec/identify) calls to identify individual users of your product, called "People" in Groundswell. For example: + +```js +analytics.identify('userId123', { + email: 'john.doe@example.com', + name: 'John Doe' +}); +``` + +The `email` trait is required and will be used to identify People everywhere in Groundswell. The `name` trait is optional. + + +### Group + +Send [Group](/docs/connections/spec/group) calls to associate individual users with groups, called "Companies" in Groundswell. For example: + +```js +analytics.group('userId123', { + name: 'Example, Inc.', + website: 'https://www.example.com' +}); +``` + +The `name` trait is required and will be used to identify Companies everywhere in Groundswell. The `website` trait is optional. + + +### Track + +Send [Track](/docs/connections/spec/track) calls to track individual product usage events, called "Signals" in Groundswell. For example: + +```js +analytics.track('User Signed In') +``` From fea761c73d1323ac2701be093c5f92a236b6af2d Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Thu, 24 Mar 2022 10:04:30 -0700 Subject: [PATCH 2/2] catalog and edits --- src/_data/catalog/destination_categories.yml | 2 +- src/_data/catalog/destinations.yml | 186 +++++++++++++++++- src/_data/catalog/regional-supported.yml | 26 ++- src/_data/catalog/source_categories.yml | 2 +- src/_data/catalog/sources.yml | 2 +- .../destinations/catalog/groundswell/index.md | 3 +- 6 files changed, 213 insertions(+), 8 deletions(-) diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index e7c6fc13f8..2574b4b579 100644 --- a/src/_data/catalog/destination_categories.yml +++ b/src/_data/catalog/destination_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination categories last updated 2022-03-18 +# destination categories last updated 2022-03-24 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index a4a2ca5603..c696f5afa6 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -1,6 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT - -# destination data last updated 2022-03-18 +# destination data last updated 2022-03-24 items: - id: 60b5d0a01f3726b85dc05aab display_name: 2mee @@ -7170,7 +7169,8 @@ items: type: string defaultValue: '' description: >- - The API key is your app's Tracking Key. Locate it under Setting when signed in. + The API key is your app's Tracking Key. Locate it under Settings when + signed in. required: true label: API Key actions: [] @@ -9349,6 +9349,74 @@ items: label: Collect Logcat Data (Android) actions: [] presets: [] +- id: 602c595c1cdf37acb79bb5d5 + display_name: Crossing Minds + name: Crossing Minds + slug: crossing-minds + hidden: true + endpoints: + - us + regions: + - us + url: connections/destinations/catalog/crossing-minds + previous_names: + - Crossing Minds + website: https://crossingminds.com + status: PUBLIC_BETA + categories: + - Customer Success + - Email Marketing + - Personalization + logo: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/4627d30a-f09f-4345-82aa-f3f99de5e34e.svg + mark: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/2a3b85cc-5db2-4702-b8ec-c471bac35ae7.svg + methods: + track: true + identify: true + group: false + alias: false + page: false + platforms: + browser: true + mobile: true + server: true + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + settings: + - name: apiDatabaseId + type: string + defaultValue: '' + description: The Crossing Minds Database ID + required: true + label: API Database ID + - name: apiKey + type: string + defaultValue: '' + description: The Crossing Minds API Service Account Name + required: true + label: API Key + - name: apiPassword + type: string + defaultValue: '' + description: The Crossing Minds API password + required: true + label: API Password + actions: [] + presets: [] - id: 5e59dad99437ab152550ce1f display_name: CrowdPower name: CrowdPower @@ -21344,6 +21412,61 @@ items: label: API Key actions: [] presets: [] +- id: 60be57310e36edd15805ca36 + display_name: Groundswell + name: Groundswell + slug: groundswell + hidden: false + endpoints: + - us + regions: + - us + url: connections/destinations/catalog/groundswell + previous_names: + - Groundswell + website: https://www.trygroundswell.com/ + status: PUBLIC_BETA + categories: + - Analytics + - Customer Success + logo: + url: https://cdn.filepicker.io/api/file/ROmXHfj9SfyP7TeOAvvL + mark: + url: https://cdn.filepicker.io/api/file/iRqS7cicR7yWuTz6wIe8 + methods: + track: true + identify: true + group: true + alias: false + page: false + platforms: + browser: true + mobile: true + server: true + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + settings: + - name: apiKey + type: string + defaultValue: '' + description: >- + You'll receive your API Key when you connect Segment from the + "Integrations" page of the Groundswell web app. + required: true + label: API Key + actions: [] + presets: [] - id: 55d37a3f0a20f4e22f0fb3ea display_name: HasOffers name: HasOffers @@ -29762,6 +29885,63 @@ items: label: Username actions: [] presets: [] +- id: 6205293e7095075d8ce71a74 + display_name: Retentive + name: Retentive + slug: retentive + hidden: true + endpoints: + - us + regions: + - us + url: connections/destinations/catalog/retentive + previous_names: + - Retentive + website: https://retentive.io + status: PUBLIC_BETA + categories: + - CRM + - Marketing Automation + - Personalization + - Customer Success + logo: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/7584495a-5b9f-42e0-aa1e-d41f82d81dcb.svg + mark: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/eed0a7eb-6917-4f1c-bc15-a1de2d4ec72b.svg + methods: + track: false + identify: true + group: false + alias: true + page: false + platforms: + browser: true + mobile: true + server: true + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + settings: + - name: apiKey + type: string + defaultValue: '' + description: Copy your API key from the Segment section of your integrations tab. + required: true + label: API Key + actions: [] + presets: [] - id: 5eb91ce4f1eb124fa7445dce display_name: Retently name: Retently diff --git a/src/_data/catalog/regional-supported.yml b/src/_data/catalog/regional-supported.yml index eeca7ee93d..d1ad9c84bc 100644 --- a/src/_data/catalog/regional-supported.yml +++ b/src/_data/catalog/regional-supported.yml @@ -1,5 +1,5 @@ # AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL -# Last updated 2022-03-18 +# Last updated 2022-03-24 warehouses: - id: WcjBCzUGff display_name: Azure SQL Data Warehouse @@ -1395,6 +1395,14 @@ destinations: - eu endpoints: - us + - id: 602c595c1cdf37acb79bb5d5 + display_name: Crossing Minds + slug: crossing-minds + url: connections/destinations/catalog/crossing-minds + regions: + - us + endpoints: + - us - id: 5e59dad99437ab152550ce1f display_name: CrowdPower slug: crowdpower @@ -1948,6 +1956,14 @@ destinations: - eu endpoints: - us + - id: 60be57310e36edd15805ca36 + display_name: Groundswell + slug: groundswell + url: connections/destinations/catalog/groundswell + regions: + - us + endpoints: + - us - id: 55d37a3f0a20f4e22f0fb3ea display_name: HasOffers slug: hasoffers @@ -2952,6 +2968,14 @@ destinations: - eu endpoints: - us + - id: 6205293e7095075d8ce71a74 + display_name: Retentive + slug: retentive + url: connections/destinations/catalog/retentive + regions: + - us + endpoints: + - us - id: 5eb91ce4f1eb124fa7445dce display_name: Retently slug: retently diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index 0950bd9c10..b52152397f 100644 --- a/src/_data/catalog/source_categories.yml +++ b/src/_data/catalog/source_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# source cateogries last updated 2022-03-18 +# source cateogries last updated 2022-03-24 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index 569310eeec..d474338c32 100644 --- a/src/_data/catalog/sources.yml +++ b/src/_data/catalog/sources.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# sources last updated 2022-03-18 +# sources last updated 2022-03-24 items: - id: 8HWbgPTt3k display_name: .NET diff --git a/src/connections/destinations/catalog/groundswell/index.md b/src/connections/destinations/catalog/groundswell/index.md index 9593f26a31..98f0a530e7 100644 --- a/src/connections/destinations/catalog/groundswell/index.md +++ b/src/connections/destinations/catalog/groundswell/index.md @@ -1,6 +1,7 @@ --- title: Groundswell Destination rewrite: true +id: 60be57310e36edd15805ca36 --- [Groundswell](https://www.trygroundswell.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) empowers sales teams with just-in-time notifications and account prioritization based on product usage insights. @@ -18,7 +19,7 @@ This destination is maintained by Groundswell. For any issues with the destinati 4. Connect Segment from the ["Integrations" page](https://app.trygroundswell.com/integrations) of the Groundswell web app, then copy the "API Key". 5. Enter the "API Key" in the Groundswell destination settings in Segment. 6. When you return to the Groundswell web app, you’ll be prompted to select mappings between Segment traits and Groundswell properties. You'll be able to use these later to define workflows and send data to other tools. - - Select whether you are identifying Companies via `Group` or `Identify` traits. + - Select whether you are identifying Companies with `Group` or `Identify` traits. - Provide the names of Segment traits for all required Groundswell properties for both Companies and People. - Add any additional mappings you wish to provide for Companies and People. 7. As Groundswell begins receiving events from Segment...