Skip to content

Commit ebd108b

Browse files
sneha-shashidharSneha Shashidharmarkzegarelli
authored
Add Groundswell Destination to Segment Doc (#2644)
* Groundswell doc * catalog and edits Co-authored-by: Sneha Shashidhar <[email protected]> Co-authored-by: markzegarelli <[email protected]>
1 parent 2f88ef1 commit ebd108b

File tree

2 files changed

+68
-5
lines changed

2 files changed

+68
-5
lines changed

src/_data/catalog/destinations.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21416,7 +21416,7 @@ items:
2141621416
display_name: Groundswell
2141721417
name: Groundswell
2141821418
slug: groundswell
21419-
hidden: true
21419+
hidden: false
2142021420
endpoints:
2142121421
- us
2142221422
regions:
Lines changed: 67 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,70 @@
11
---
2-
title: 'Groundswell Destination'
3-
hidden: true
2+
title: Groundswell Destination
3+
rewrite: true
44
id: 60be57310e36edd15805ca36
5-
published: false
6-
beta: true
75
---
6+
7+
[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.
8+
9+
This destination is maintained by Groundswell. For any issues with the destination, [contact the Groundswell Support team](mailto:[email protected]).
10+
11+
12+
## Getting Started
13+
14+
{% include content/connection-modes.md %}
15+
16+
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
17+
2. Search for "Groundswell" in the Destinations Catalog, and select the Groundswell destination.
18+
3. Choose which Source should send data to the Groundswell destination.
19+
4. Connect Segment from the ["Integrations" page](https://app.trygroundswell.com/integrations) of the Groundswell web app, then copy the "API Key".
20+
5. Enter the "API Key" in the Groundswell destination settings in Segment.
21+
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.
22+
- Select whether you are identifying Companies with `Group` or `Identify` traits.
23+
- Provide the names of Segment traits for all required Groundswell properties for both Companies and People.
24+
- Add any additional mappings you wish to provide for Companies and People.
25+
7. As Groundswell begins receiving events from Segment...
26+
- You'll be able to add Signals from the "Signals" page.
27+
- 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.
28+
29+
30+
## Supported methods
31+
32+
Groundswell supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
33+
34+
35+
### Identify
36+
37+
Send [Identify](/docs/connections/spec/identify) calls to identify individual users of your product, called "People" in Groundswell. For example:
38+
39+
```js
40+
analytics.identify('userId123', {
41+
42+
name: 'John Doe'
43+
});
44+
```
45+
46+
The `email` trait is required and will be used to identify People everywhere in Groundswell. The `name` trait is optional.
47+
48+
49+
### Group
50+
51+
Send [Group](/docs/connections/spec/group) calls to associate individual users with groups, called "Companies" in Groundswell. For example:
52+
53+
```js
54+
analytics.group('userId123', {
55+
name: 'Example, Inc.',
56+
website: 'https://www.example.com'
57+
});
58+
```
59+
60+
The `name` trait is required and will be used to identify Companies everywhere in Groundswell. The `website` trait is optional.
61+
62+
63+
### Track
64+
65+
Send [Track](/docs/connections/spec/track) calls to track individual product usage events, called "Signals" in Groundswell. For example:
66+
67+
```js
68+
analytics.track('User Signed In')
69+
```
70+

0 commit comments

Comments
 (0)