Skip to content

Commit 8595ff1

Browse files
committed
chore: fixes for batch 7.1
1 parent 69c9e30 commit 8595ff1

File tree

16 files changed

+118
-183
lines changed

16 files changed

+118
-183
lines changed

src/connections/destinations/catalog/primer/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ Since Primer needs to be initialized as early as possible, you need to supply th
1616

1717
This will initialize the Primer SDK under the hood and begin collecting events and initializing the Primer Flow.
1818

19-
- - -
20-
2119
Primer supports the `identify` and `track` methods.
2220

2321
## Identify

src/connections/destinations/catalog/promoter-io/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ hide-dossier: true
1111

1212
Once the Segment library is integrated with your service, add your Promoter API Key and enable Promoter in your Segment destinations page. You can find your API key in Promoter.io under **Accounts Settings > Segment Destination**.
1313

14-
- - -
15-
1614
Promoter supports the `identify` and `track` methods from Segment and will allow you to:
1715

1816
- Add a contact to a list

src/connections/destinations/catalog/quora-conversion-pixel/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ id: 5952698570a3e552b9575519
1313
2. Search for "Quora" in the Catalog, select it, and choose which of your sources to connect the destination to.
1414
3. Add your Quora Conversion Pixel Key to your Destination settings. To get this you will need to do the following:
1515

16-
i. Log into your [Quora Ads Manager Account](https://www.quora.com/ads/account){:target="_blank"}.
16+
1. Log into your [Quora Ads Manager Account](https://www.quora.com/ads/account){:target="_blank"}.
1717

18-
ii. Navigate to the "Quora Pixel" tab in your Quora Dashboard.
18+
2. Navigate to the "Quora Pixel" tab in your Quora Dashboard.
1919

20-
iii. Click the "Setup Pixel" button to open the installation popup modal.
20+
3. Click the "Setup Pixel" button to open the installation popup modal.
2121

22-
iv. Under "Option A: Install a JavaScript Pixel," find your Quora Conversion Pixel Key in the Quora JavaScript Pixel - the key is embedded in a tag that looks like `qp('init', '7cc5a029c2604daa8365d15ff337146e')`. In the example below, the key is `7cc5a029c2604daa8365d15ff337146e`.
22+
4. Under "Option A: Install a JavaScript Pixel," find your Quora Conversion Pixel Key in the Quora JavaScript Pixel - the key is embedded in a tag that looks like `qp('init', '7cc5a029c2604daa8365d15ff337146e')`. In the example below, the key is `7cc5a029c2604daa8365d15ff337146e`.
2323

2424

2525
## Track

src/connections/destinations/catalog/ramen/index.md

Lines changed: 50 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,20 @@
22
title: Ramen Destination
33
id: 558c9d1a0a20f4e22f0fb3bb
44
---
5+
56
## Getting Started
67

78
When you enable Ramen in the Segment web app, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Ramen's JavaScript library onto your page. This means you should remove Ramen's snippet from your page if you already have it there.
8-
9-
+ As of March 2016, Ramen supports asking questions of anonymous website visitors in addition to logged-in users. Calling [`page`](#page), [`track`](#track), and [`group`](#group) will work without calling [`identify`](#identify). However, when you call [`identify`](#identify) you _must_ pass in an `id` or else the Ramen destination will ignore the call.
10-
11-
9+
10+
- As of March 2016, Ramen supports asking questions of anonymous website visitors in addition to logged-in users. Calling [`page`](#page), [`track`](#track), and [`group`](#group) will work without calling [`identify`](#identify). However, when you call [`identify`](#identify) you _must_ pass in an `id` or else the Ramen destination will ignore the call.
11+
1212
## Identify
13-
13+
1414
When you make an [Identify call](/docs/connections/spec/identify) on Analytics.js, it identifies the logged-in user to Ramen.
15-
15+
1616
Here is a full example, which we will annotate below:
17-
17+
18+
1819
```javascript
1920
analytics.identify('314159', {
2021
email: 'ryan@charturl.com',
@@ -25,26 +26,23 @@ analytics.identify('314159', {
2526
mrr: 149.99
2627
});
2728
```
28-
29+
2930
Here is a list of the attributes we process:
30-
31+
3132
* `id` becomes the `id` of the user in Ramen.
3233
* `email` becomes the `email` of the user in Ramen.
3334
* `name` becomes the `name` of the user in Ramen.
3435
* `created_at` becomes the `customer_created_at` timestamp for the user in Ramen. It can be passed in as a `Date` or seconds since the epoch.
3536
* If `company` is an `Object` with an `id` attribute, we'll treat that information as if it was passed to [`group`](#group) and create a company in Ramen.
3637
* Attributes with names ending in `_at` will be parsed as times.
3738
* Attributes with names beginning with `is_` will be parsed as Booleans.
38-
39-
39+
4040
**Note:** Ramen will ignore any calls to `identify` that do not contain `userId`.
41-
42-
43-
41+
4442
## Group
45-
43+
4644
Segment supports Ramen Companies in Analytics.js through the [`group`](/docs/connections/spec/group) method. Users can be put into multiple groups, which will associate them to multiple companies in Ramen.
47-
45+
4846
Here is a full example, which we will annotate below:
4947
5048
```javascript
@@ -57,49 +55,44 @@ analytics.group('314159', {
5755
mrr: 149.99
5856
});
5957
```
60-
58+
6159
Here is a list of the attributes we process:
62-
60+
6361
* `id` becomes the `id` of the company in Ramen.
6462
* `url` becomes the `url` of the company in Ramen.
6563
* `name` becomes the `name` of the company in Ramen.
6664
* `created_at` becomes the `company_created_at` timestamp for the company in Ramen. It can be passed in as a `Date` or seconds since the epoch.
6765
* Other attributes can be passed in as well, and will parsed according to the same rules as denoted in the [`identify`](#identify) section.
68-
69-
66+
7067
## Page
71-
68+
7269
When you call [`page`](/docs/connections/spec/page) on Analytics.js, it registers a new pageview in Ramen and checks to see if any questions should be asked.
73-
70+
7471
Ramen does not support passing in any attributes to `page`. You can call `page({ title: "Our page" })` but the attributes (ie. `title` in this example) will be ignored.
75-
76-
72+
7773
## Track
78-
74+
7975
When you call [`track`](/docs/connections/spec/track) on Analytics.js, it registers a new event in Ramen and checks to see if any questions should be asked.
80-
76+
8177
Ramen does not support passing in any attributes to `track` beyond the event name. You can call `track('Subscribed', { plan: "Startup" })` but the attributes (ie. `plan` in this example) will be ignored.
82-
83-
84-
- - -
85-
78+
79+
8680
## Features
87-
88-
81+
8982
### Secure Mode
90-
83+
9184
If you want to enable Ramen [secure mode](http://docs.ramen.is/#secure-mode){:target="_blank"} for analytics.js, you can pass in the `timestamp` and `auth_hash` variables by rendering it in your server-side templates.
92-
85+
9386
The `timestamp` should be a Unix timestamp (epoch seconds). The `auth_hash` is a SHA256 has of several attributes. The hash is not based on the email, it is based on:
94-
95-
+ user.email - If you do not store emails for your customers, use an empty string
96-
+ user.id
97-
+ user.name - If you do not have a name for your customers, use their email address or an empty string
98-
+ timestamp
99-
+ Ramen API Secret
100-
87+
88+
- user.email - If you do not store emails for your customers, use an empty string
89+
- user.id
90+
- user.name - If you do not have a name for your customers, use their email address or an empty string
91+
- timestamp
92+
- Ramen API Secret
93+
10194
Here's an example of a Ruby web server rendering an identify call with secure mode:
102-
95+
10396
```ruby
10497
analytics.identify('<%= current_user.id %>', {
10598
email : '<%= current_user.email %>',
@@ -113,31 +106,26 @@ analytics.identify('<%= current_user.id %>', {
113106
}
114107
});
115108
```
116-
109+
117110
`RAMEN_ORGANIZATION_SECRET_KEY` is found in Ramen's RamenJS documentation.
118-
119-
120-
- - -
121-
122-
111+
123112
## Troubleshooting
124-
125-
113+
126114
### I'm seeing a `404` error
127-
115+
128116
Check to make sure your Ramen `ORGANIZATION_ID` is correct.
129-
117+
130118
### I'm seeing a `401` error
131-
119+
132120
The request you are sending is not valid. Several things can cause this:
133-
134-
+ An invalid `user.email`. It can be blank, but it cannot be an invalid email address.
135-
+ A missing `user.id`.
136-
+ Not including `timestamp` and `auth_hash` once Secure Mode has been enabled. You can see if Secure Mode is enabled by visiting your RamenJS settings page in Ramen.
137-
121+
122+
- An invalid `user.email`. It can be blank, but it cannot be an invalid email address.
123+
- A missing `user.id`.
124+
- Not including `timestamp` and `auth_hash` once Secure Mode has been enabled. You can see if Secure Mode is enabled by visiting your RamenJS settings page in Ramen.
125+
138126
If the above all look correct, and you are sending `timestamp` and `auth_hash`, check the following:
139-
140-
+ `timestamp` is being dynamically generated (ie. it is not accidentally hard-coded).
141-
+ `auth_hash` is being calculated correctly
142-
127+
128+
- `timestamp` is being dynamically generated (ie. it is not accidentally hard-coded).
129+
- `auth_hash` is being calculated correctly
130+
143131
If you are still having trouble, you can email [Ramen support](mailto:support@ramen.is).

src/connections/destinations/catalog/recombee-ai/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ This destination is maintained by Recombee. For any issues with the destination,
1818

1919
> info ""
2020
> The Recombee Destination is currently in beta, which means that the Recombee team is still actively developing the destination. If you have any feedback to help improve the Recombee Destination and its documentation, [contact the Recombee support team](mailto:support@recombee.com).
21-
>>>>>>> Stashed changes
2221
2322
Use this Segment destination to send your interaction data, like views, purchases, or plays, to Recombee.
2423

src/connections/destinations/catalog/relay/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ title: Relay Destination
77
Once the Segment library is integrated with your server, toggle Relay on in your Segment destinations.
88

99
Relay supports the `identify` and `track` methods.
10-
- - -
1110

1211
## Identify
1312

src/connections/destinations/catalog/retina/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ id: 5f287bfa332cce0b1ed18331
88

99
Retina AI maintains this destination. For any issues with the destination, contact the [Retina AI Support Team](mailto:info@retina.ai).
1010

11-
> info " "
11+
> info ""
1212
> The Retina AI Destination is in beta, which means that they are still actively developing the destination. To join the beta program, or if you have any feedback to help improve the Retina AI Destination and its documentation, contact the [Retina AI Support Team](mailto:info@retina.ai).
1313
1414

src/connections/destinations/catalog/rollbar/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ This feature makes use of JavaScript Source Maps to translate the minified code
2020

2121
2. Provide your source map. There are two ways you can do this:
2222

23-
a. Automatic download: place a comment like the following at the bottom of your minified JavaScript files:
23+
1. Automatic download: place a comment like the following at the bottom of your minified JavaScript files:
2424

25-
```
26-
//# sourceMappingURL=URL_TO_SOURCE_MAP
27-
```
25+
```
26+
//# sourceMappingURL=URL_TO_SOURCE_MAP
27+
```
2828

29-
b. Upload pre-deploy: at the beginning of your deploy script, upload a source map package using Rollbar's API.
29+
2. Upload pre-deploy: at the beginning of your deploy script, upload a source map package using Rollbar's API.
3030

3131
For more detail on providing your source map, checkout [Rollbar's documentation here](https://rollbar.com/docs/source-maps/#step-2-provide-your-source-map){:target="_blank"}.

src/connections/destinations/catalog/route/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Once the Segment library is integrated with your server, toggle Route `on` in yo
1010

1111
Route supports the `identify` and `track` methods.
1212

13-
---
14-
1513
## Identify
1614

1715
When you `identify` a contact, we'll pass that contact's information to Route with `email` as Route's Contact ID. The traits recognized as Route's contact profile fields are:

src/connections/destinations/catalog/salesforce-dmp/index.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,17 @@ Next, configure the Destination in the Segment web app:
2828

2929
### Setting up a Client-Side Web Implementation
3030

31-
3. Get your **Config ID** from your SFDMP console. Log into the
31+
4. Get your **Config ID** from your SFDMP console. Log into the
3232
console and go to **Manage** > **Capture** > **Sites**.
3333
If you don't see this option, contact your SFDMP representative.
3434

35-
4. In the **Sites** tab, locate the site you want to use as the SFDMP destination.
35+
5. In the **Sites** tab, locate the site you want to use as the SFDMP destination.
3636
If you haven't created any sites yet, click **Create Site** and go through the options to create a new site.
3737

3838
![A screenshot of the Manage tab in Salesforce DMP, with the Sites item selected.](images/salesforce-dmp-setup1.png)
3939

40-
5. In the dropdown, find the site tag for the site you want to use. The string you need is under "Config" and will look something like `r0u08k4tz`.
41-
6. Go back to the Segment App, and navigate to the Salesforce DMP destination you're setting up. Locate the ConfigID setting, and paste the value you found in that field.
40+
6. In the dropdown, find the site tag for the site you want to use. The string you need is under "Config" and will look something like `r0u08k4tz`.
41+
7. Go back to the Segment App, and navigate to the Salesforce DMP destination you're setting up. Locate the ConfigID setting, and paste the value you found in that field.
4242

4343
To send client-side events to SFDMP, you must include a SFDMP Config ID and
4444
SFDMP Namespace in your Segment settings. Segment's UI enforces inclusion of a
@@ -49,14 +49,14 @@ If you don't provide a `namespace` Segment can't pass events downstream to SFDMP
4949

5050
### Setting up for a Server-Side Implementation
5151

52-
6. To set up SFDMP for a server-side connection, enter your SFDMP `Server-side
52+
8. To set up SFDMP for a server-side connection, enter your SFDMP `Server-side
5353
Publisher UUID`. To locate this, Segment recommends that you contact your SFDMP representative. Helpful documentation can be found
5454
[in the Salesforce Audience Studio Help Center](https://konsole.zendesk.com/hc/en-us/articles/219493027-Mobile-HTTP-API){:target="_blank"}.
55-
7. Once you've retrieved your `Server-side Publisher UUID`, follow the
55+
9. Once you've retrieved your `Server-side Publisher UUID`, follow the
5656
instructions in the Segment SFDMP settings to enter your `Pixel.gif Domain`,
5757
`Pixel.gif Site` and, optionally, your `Pixel.gif Section` in the correct
5858
fields.
59-
8. If you instead want to send your `track` events to SFDMP's
59+
10. If you instead want to send your `track` events to SFDMP's
6060
Event.gif endpoint instead of their Pixel.gif endpoint, first disable the
6161
`Send Server-Side Track Calls to the Pixel.gif Endpoint` (it defaults to on)
6262
setting in the Segment UI.
@@ -217,7 +217,8 @@ If you see page attributes automatically appended to outbound Pixel.gif calls
217217
and you're not sure where the attributes came from, then you or someone on
218218
your team has likely set up page scraping in SFDMP.
219219

220-
Warning: If you decide to rely on SFDMP's page scraping to transmit attributes
220+
> warning ""
221+
> If you decide to rely on SFDMP's page scraping to transmit attributes
221222
to SFDMP rather than adding them as properties to Segment events, you won't
222223
see these properties in other Segment connections, including in a raw data
223224
warehouse.
@@ -401,4 +402,4 @@ The value of field `msg.event`.
401402

402403
| Value Passed to Segment | Value Sent to SFDMP |
403404
|-|-|
404-
| Any String value (for example, 'Account Created') | event_id: <`id mapped in Event ID Map UI setting`> |
405+
| Any String value (for example, 'Account Created') | event_id: `<id mapped in Event ID Map UI setting>` |

0 commit comments

Comments
 (0)