Skip to content

Commit 664ada0

Browse files
cmastrcmastr
authored
Merge pull request #6628 from segmentio/thomas/ripe
Add updates from prev pull request for Ripe
2 parents 5416d6f + c233bf4 commit 664ada0

File tree

2 files changed

+118
-69
lines changed
  • src/connections/destinations/catalog

2 files changed

+118
-69
lines changed

‎src/connections/destinations/catalog/actions-ripe-cloud/index.md

+76-11
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,88 @@
11
---
2-
title: Ripe Cloud Mode Destination
2+
title: Ripe Cloud Mode (Actions) Destination
33
hide-boilerplate: true
44
hide-dossier: true
55
id: 63cade592992cf7052ce2e3e
66
---
77

8-
The Ripe Segment integration is an [Actions-based Destination in cloud mode](/docs/connections/destinations/#connection-modes) that lets you send your backend events directly to Ripe.
8+
[Ripe](https://www.getripe.com/){:target="_blank"} is a sales conversion tool that enables B2B revenue teams to surface and meet their best leads at the best possible time - when they are using your product.
99

10-
## Getting started
10+
The Ripe Segment integration is an [Actions Destination in cloud mode](/docs/connections/destinations/#connection-modes) that lets you send your product events data to Ripe.
1111

12-
> info ""
13-
> Since this is a [cloud-mode destination](/docs/connections/destinations/#connection-modes) it will not enable Ripe features that require access to the client, for example, live calls and calendar. To use the full Ripe feature set you need to enable the device-mode [Ripe Destination](/docs/connections/destinations/catalog/actions-ripe-web/) on one of your web sources.
12+
Ripe maintains this destination. For any issues with the destination, [contact the Ripe team](mailto:[email protected]).
1413

14+
> success ""
15+
> Set up a free account with Ripe by visiting their [website](https://www.getripe.com/){:target="_blank"}.
1516
16-
1. Sign in to your Segment Account
17-
2. Open the [Ripe Cloud Mode Destination](https://app.segment.com/goto-my-workspace/destinations/catalog/actions-ripe-cloud/){:target="_blank"}.
18-
3. Click **Configure Ripe Cloud Mode (Actions)**.
19-
4. Select an existing Source to connect to Ripe.
20-
5. Enter your Ripe API key in the API key field and click save.
21-
6. Enable the Destination
17+
## Getting Started
18+
19+
> warning "Ripe Cloud Mode (Actions) destination requires events from an Analytics.js source"
20+
> Ripe Cloud Mode is a way to send your backend events to Ripe and should be used in tandem with the client-side [Ripe Destination](/docs/connections/destinations/catalog/actions-ripe-web/). Without a Ripe Web Mode (Actions) destination receiving information from an Analytics.js source, you will not be able to interact with leads in the Ripe app.
21+
22+
1. From the Destinations catalog page in the Segment App, click Add Destination.
23+
2. Search for "Ripe Cloud Mode (Actions)" in the Destinations Catalog, and select the "Ripe Cloud Mode (Actions)" destination.
24+
3. Choose which Source should send data to the "Ripe" destination.
25+
4. Go to Ripe integrations page (or onboarding page) and click on the "Segment" integration.
26+
5. Copy the "Segment API key".
27+
6. Enter the "Segment API Key" in the "Ripe Cloud Mode" destination settings in Segment.
28+
29+
## Supported Methods
30+
31+
Ripe supports all the following methods out of the box.
32+
33+
34+
### Identify
35+
36+
Take a look at the [Identify method documentation](/docs/connections/spec/identify/) to learn about what it does. An example call would look like this:
37+
38+
```js
39+
analytics.identify('userId123', {
40+
email: '[email protected]',
41+
firstName: 'Steve',
42+
lastName: 'Jobs'
43+
});
44+
```
45+
46+
Segment sends Identify calls to Ripe as `identify` events. Ripe displays these events as `Users` by default. `Identify` event data is augmented with traits. It's important to include email as a trait, as soon as it is known. Ripe will use email to populate User views by default. Ripe fully supports [Segment's Identify Spec](https://segment.com/docs/connections/spec/identify/#traits), and recommend using the standardized names for the reserved traits covered there.
47+
48+
49+
### Track
50+
51+
Take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like:
52+
53+
```js
54+
analytics.track('Clicked Book a Demo Button')
55+
```
56+
57+
Segment sends Track calls to Ripe as `track` events. Track events should be flattened whenever possible. For example, rather than `Button Click` as a track event with `Book a Demo` as a property, use `Clicked Book a Demo Button`. Product Events can be filtered and grouped by `userId` or `groupId`. When firing track calls from a backend source you should always include the `userId` to ensure it can be attributed back to the correct user.
58+
59+
60+
### Page
61+
62+
Take a look at the [Page method documentation](https://segment.com/docs/connections/spec/page/) to learn about what it does. An example call would look like this:
63+
64+
```js
65+
analytics.page()
66+
```
67+
68+
Segment sends Page calls to Ripe as a `pageview` event. Ripe displays these events as Page views by default.
69+
70+
71+
### Group
72+
73+
Take a look at the [Group method documentation](https://segment.com/docs/connections/spec/group/) to learn about what it does. An example call would look like this:
74+
75+
```js
76+
analytics.group("0e8c78ea9d97a7b8185e8632", {
77+
name: "Apple Inc.",
78+
industry: "Technology",
79+
employees: 164000,
80+
plan: "enterprise",
81+
"total billed": 1000000,
82+
website: "apple.com"
83+
});
84+
```
85+
86+
Segment sends Group calls to Ripe as a `group` event. Group events can be augmented with group traits. Ripe displays these events as Workspaces by default. Including a name and a website (domain) as a trait is recommended, as Ripe will use the traits to populate Workspace views by default.
2287

2388
{% include components/actions-fields.html %}

‎src/connections/destinations/catalog/actions-ripe-web/index.md

+42-58
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,84 @@
11
---
2-
title: Ripe Destination
2+
title: Ripe Device Mode (Actions) Destination
33
hide-boilerplate: true
44
hide-dossier: true
55
id: 63913b2bf906ea939f153851
6-
redirect_from: '/connections/destinations/catalog/actions-ripe/'
76
---
87

9-
The Ripe Destination is an [Actions-based Destination in device mode](/docs/connections/destinations/#connection-modes) that loads and configures Ripe’s SDK script for you. If you’re already using Segment’s Analytics.js for identifying and tracking your users, either directly or through Segment source integrations that you’ve installed, you can configure Segment to send this data directly to Ripe.
8+
[Ripe](https://www.getripe.com/){:target="_blank"} is a sales conversion tool that enables B2B revenue teams to surface and meet their best leads at the best possible time - when they are using your product.
109

11-
## Getting started
10+
The Ripe Segment integration is an [Actions-based Destination in web mode](https://segment.com/docs/connections/destinations/#connection-modes) that lets you send your product events data to Ripe.
1211

13-
> info ""
14-
> Before you begin, create a free [Ripe](https://www.getripe.com/){:target="_blank"} workspace to access the API key that you'll use to configure the integration.
12+
Ripe maintains this destination. For any issues with the destination, [contact the Ripe team](mailto:[email protected]).
1513

16-
1. Sign in to your Segment Account
17-
2. Open the [Ripe Destination](https://app.segment.com/goto-my-workspace/destinations/catalog/actions-ripe/){:target="_blank"}
18-
3. Click **Configure Ripe Device Mode (Actions)**.
19-
4. Select an existing Source to connect to Ripe.
20-
5. Enter your Ripe API key in the API key field and click save.
21-
6. Enable the Destination
14+
> success ""
15+
> Set up a free account with Ripe by visiting their [website](https://www.getripe.com/){:target="_blank"}.
2216
23-
{% include components/actions-fields.html %}
17+
## Getting Started
2418

25-
{% comment %}
26-
## Ripe SDK
19+
1. From the Destinations catalog page in the Segment App, click Add Destination.
20+
2. Search for "Ripe Device Mode (Actions)" in the Destinations Catalog, and select the "Ripe Device Mode (Actions)" destination.
21+
3. Choose which Source should send data to the "Ripe Device Mode (Actions)" destination.
22+
4. Go to Ripe integrations page (or onboarding) and click on the "Segment" integration.
23+
5. Copy the "Segment API key".
24+
6. Enter the "Segment API Key" in the "Ripe" destination settings in Segment.
2725

28-
### Identify
26+
## Supported Methods
27+
28+
Ripe supports all the following methods out of the box.
2929

30-
When you have a unique identifier for a user, preferably an identifier from your database, call this method. For example, when a user logs in or updates their email. If you don't provide a `user_id` is not provided an automatically generated `anonymous_id` will be used.
30+
### Identify
3131

32-
If you aren't familiar with the Segment Spec, take a look at
33-
the [Identify method documentation](/docs/connections/spec/identify/) to learn
34-
about what it does. An example call would look like:
32+
Take a look at the [Identify method documentation](/docs/connections/spec/identify/) to learn about what it does. An example call would look like this:
3533

3634
```js
3735
analytics.identify('userId123', {
38-
email: '[email protected]'
36+
email: '[email protected]',
37+
firstName: 'Steve',
38+
lastName: 'Jobs'
3939
});
4040
```
4141

42-
Segment sends Identify calls to Ripe as an `identify` event.
42+
Segment sends Identify calls to Ripe as `identify` events. Ripe displays these events as `Users` by default. `Identify` event data is augmented with traits. It's important to include email as a trait, as soon as it is known. Ripe will use email to populate User views by default. We fully support the [Segment's Identify Spec](https://segment.com/docs/connections/spec/identify/#traits), and we recommend using the standardized names for the reserved traits covered there.
4343

44-
### Track
4544

46-
Use `track` calls to track what actions your user perform along with properties
47-
related to the `track` call.
45+
### Track
4846

49-
If you aren't familiar with the Segment Spec, take a look at
50-
the [Track method documentation](/docs/connections/spec/track/) to learn about
51-
what it does. An example call would look like:
47+
Take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like:
5248

5349
```js
54-
analytics.track('Login Button Clicked')
50+
analytics.track('Clicked Book a Demo Button')
5551
```
5652

57-
Segment sends Track calls to Ripe as a `track` event.
53+
Segment sends Track calls to Ripe as `track` events. Track events should be flattened whenever possible. For example, rather than `Button Click` as a track event with `Book a Demo` as a property, use `Clicked Book a Demo Button`. Product Events can be filtered and grouped by `userId` or `groupId`. Both of these will be appended automatically if they have been fired prior to the track call for web/client-side events.
5854

59-
---> Add comment on fast track property here?
6055

61-
### Group
56+
### Page
6257

63-
If you aren't familiar with the Segment Spec, take a look at
64-
the [Group method documentation](/docs/connections/spec/group/) to learn about
65-
what it does. An example call would look like:
58+
Take a look at the [Page method documentation](https://segment.com/docs/connections/spec/page/) to learn about what it does. An example call would look like this:
6659

6760
```js
68-
analytics.group("0e8c78ea9d97a7b8185e8632", {
69-
name: "Initech",
70-
industry: "Technology",
71-
employees: 329,
72-
plan: "enterprise",
73-
"total billed": 830
74-
});
61+
analytics.page()
7562
```
7663

77-
Group calls from Segment update `Companies` in Ripe. Each `Company` is
78-
associated with a distinct `group_id`.
64+
Segment sends Page calls to Ripe as a `pageview` event. Ripe displays these events as Page views by default.
7965

80-
### Page
8166

82-
Use page calls to track what pages your users sees. This is typically called on
83-
each page load in a traditional web page and on route changes in
84-
SPA-applications.
67+
### Group
8568

86-
If you aren't familiar with the Segment Spec, take a look at
87-
the [Page method documentation](/docs/connections/spec/page/) to learn about
88-
what it does. An example call would look like:
69+
Take a look at the [Group method documentation](https://segment.com/docs/connections/spec/group/) to learn about what it does. An example call would look like this:
8970

9071
```js
91-
analytics.page('Home')
72+
analytics.group("0e8c78ea9d97a7b8185e8632", {
73+
name: "Apple Inc.",
74+
industry: "Technology",
75+
employees: 164000,
76+
plan: "enterprise",
77+
"total billed": 1000000,
78+
website: "apple.com"
79+
});
9280
```
9381

94-
Segment sends Page calls to Ripe as a `pageview` event.
95-
96-
### Segment session
82+
Segment sends Group calls to Ripe as a `group` event. Group events can be augmented with group traits. Ripe displays these events as Workspaces by default. Including a name and a website (domain) as a trait is recommended, as Ripe will use the traits to populate Workspace views by default.
9783

98-
Ripe will use the `userId`, `anonymous` and `groupId` set in Segment and the Ripe SDK keeps track of the current ids.
99-
100-
{% endcomment %}
84+
{% include components/actions-fields.html %}

0 commit comments

Comments
 (0)