diff --git a/src/connections/destinations/catalog/chartbeat/index.md b/src/connections/destinations/catalog/chartbeat/index.md index aff9d7cac4..b805eb8ac4 100644 --- a/src/connections/destinations/catalog/chartbeat/index.md +++ b/src/connections/destinations/catalog/chartbeat/index.md @@ -11,7 +11,6 @@ When you enable Chartbeat in the Segment web app, your changes appear in the Seg Chartbeat is only supported on the client-side. -- - - ## Page diff --git a/src/connections/destinations/catalog/clicky/index.md b/src/connections/destinations/catalog/clicky/index.md index 0587ea477e..7b354d5e28 100644 --- a/src/connections/destinations/catalog/clicky/index.md +++ b/src/connections/destinations/catalog/clicky/index.md @@ -8,7 +8,7 @@ id: 54521fd525e721e32a72eea2 Our Clicky destination code is open-source on GitHub. You can check out the code [in the @segment-integrations/analytics.js-integration-clicky](https://github.com/segment-integrations/analytics.js-integration-clicky){:target="_blank"} repository. -## Getting Started +## Getting started 1. From the Segment web app, click **Catalog**. 2. Search for "Clicky" in the Catalog, select it, and choose which of your sources to connect the destination to. diff --git a/src/connections/destinations/catalog/clientsuccess/index.md b/src/connections/destinations/catalog/clientsuccess/index.md index 2fd4eda39f..32be31930e 100644 --- a/src/connections/destinations/catalog/clientsuccess/index.md +++ b/src/connections/destinations/catalog/clientsuccess/index.md @@ -5,7 +5,7 @@ id: 55677dfd0a20f4e22f0fb39a --- This destination is maintained by ClientSuccess. -## Getting Started (for CSMs) +## Getting started (for CSMs) If your engineers have already set up Segment, adding Segment data to ClientSuccess is straightforward. All you need to do is turn on the destination. @@ -17,7 +17,8 @@ To turn on the destination, do the following: **Note:** Because ClientSuccess focuses on group level events, you must pass group information before your events will show up. If you turn on the ClientSuccess destination in Segment and don't see events in ClientSuccess after 24 hours, it may be that your engineers need to send group information to Segment using Segment's `group` call. -## Getting Started (for Developers) + +## Getting started (for developers) ClientSuccess supports the `identify`, `group`, `track`, and `page` methods of Segment. diff --git a/src/connections/destinations/catalog/cubitic/index.md b/src/connections/destinations/catalog/cubitic/index.md index 06323625ca..43af00e8b5 100644 --- a/src/connections/destinations/catalog/cubitic/index.md +++ b/src/connections/destinations/catalog/cubitic/index.md @@ -12,7 +12,6 @@ The Cubitic application key can be obtained by contacting signup@cubitic.io Cubitic supports the `identify` and `track` methods. -- - - ## Identify diff --git a/src/connections/destinations/catalog/cxense/index.md b/src/connections/destinations/catalog/cxense/index.md index 205f18fdaf..9eeee782e6 100644 --- a/src/connections/destinations/catalog/cxense/index.md +++ b/src/connections/destinations/catalog/cxense/index.md @@ -17,7 +17,6 @@ To get started with Cxense and Segment, you'll need the following: Assuming these criteria are met, you can add Cxense as a destination for your desired source in your Segment account. -- - - ## Page diff --git a/src/connections/destinations/catalog/firebase/index.md b/src/connections/destinations/catalog/firebase/index.md index 0d0c6f5f73..8d7c6e4731 100644 --- a/src/connections/destinations/catalog/firebase/index.md +++ b/src/connections/destinations/catalog/firebase/index.md @@ -44,7 +44,7 @@ buildscript { apply plugin: 'com.google.gms.google-services' ``` -> warning "Use the `aar` package when adding the Segment-Firebase SDK" +> warning "Use the aar package when adding the Segment-Firebase SDK" > The Firebase SDK requires Android resources which are available on `aar` packages. diff --git a/src/connections/destinations/catalog/framed-io/index.md b/src/connections/destinations/catalog/framed-io/index.md index e778d270a2..0206bd8d5c 100644 --- a/src/connections/destinations/catalog/framed-io/index.md +++ b/src/connections/destinations/catalog/framed-io/index.md @@ -8,7 +8,6 @@ Once your application is set up and instrumented with Segment, turn on Framed in Framed supports the `identify` and `track` methods. -- - - ## Identify diff --git a/src/connections/destinations/catalog/freshsales/index.md b/src/connections/destinations/catalog/freshsales/index.md index b2477e6372..b85d5e8947 100644 --- a/src/connections/destinations/catalog/freshsales/index.md +++ b/src/connections/destinations/catalog/freshsales/index.md @@ -19,7 +19,7 @@ You can use `identify` to create a lead or a contact when a website visitor fill ### User ID `userId` is a mandatory field which is used to identify the lead or contact in Freshsales. If your user identifier is not email, then email has to be a part of traits. -
+```json
 {
   "userId": "97980cfea0067",
   "traits": {
@@ -32,11 +32,11 @@ You can use `identify` to create a lead or a contact when a website visitor fill
     }
   }
 }
-
+``` By default, every `identity` is created as a lead. If you'd like an identity to be a contact, you'd need to pass `fs_contact` as `true` as a part of traits. -
+```json
 {
   "userId" : "97980cfea0067",
   "traits" : {
@@ -50,7 +50,7 @@ By default, every `identity` is created as a lead. If you'd like an identity to
     }
   }
 }
-
+``` ### Traits `traits` are pieces of information you know about a user that are included in an `identify` method. @@ -72,7 +72,7 @@ As part of traits, you can send custom fields created in Freshsales by using the ### Objects: Accounts and Deals associated to a contact or lead can also be updated in Freshsales. The objects company and deal in the identity correspond to the Accounts and Deals in Freshsales. You can pass the `traits` of the company or the deal along with the respective objects in the identity. -``` +```json { "userId" : "97980cfea0067", "traits" : { @@ -98,7 +98,7 @@ You can track activities of your website visitors. If a user is subscribing to a ### Track request payload -``` +```json { "userId" : "john.doe@example.com", "event": "Email Bounced", @@ -120,7 +120,7 @@ When you call a `page` event, we send a pageview to Freshsales. You can send ext ### Sample Page request payload -``` +```json { "userId" : "john.doe@example.com", "name": "Page view", diff --git a/src/connections/destinations/catalog/fullstory/index.md b/src/connections/destinations/catalog/fullstory/index.md index ff78b4c9b4..1e248fd05d 100644 --- a/src/connections/destinations/catalog/fullstory/index.md +++ b/src/connections/destinations/catalog/fullstory/index.md @@ -39,7 +39,7 @@ analytics.identify("userId"); In addition, Segment will send over along any traits included in the `identify` call. The example call below would send over both `plan` and `logins`. -``` +```js analytics.identify("userId123", { plan: "premium", logins: 5 @@ -50,7 +50,7 @@ analytics.identify("userId123", { Both `email` and `displayName` are special traits that will be passed to FullStory to be used in their interface as explained in [FullStory's docs](https://help.fullstory.com/hc/en-us/articles/360020828113){:target="_blank"}. These traits are optional. -``` +```js analytics.identify("userId123", { email: "john.doe@example.com", displayName: "John Doe" @@ -63,7 +63,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th An example call would look like: -``` +```js analytics.track('Product Purchased', { order_ID: '2969302398', category: 'boots', diff --git a/src/connections/destinations/catalog/gauges/index.md b/src/connections/destinations/catalog/gauges/index.md index 84d00673af..cbbeaba649 100644 --- a/src/connections/destinations/catalog/gauges/index.md +++ b/src/connections/destinations/catalog/gauges/index.md @@ -10,14 +10,12 @@ This means you should remove Gauges' snippet from your page. Gauges starts automatically collecting data on your site. -- - - ## Page When you call [`page`](/docs/connections/spec/page/), we call Gauges' `track` method with no arguments. -- - - ## Troubleshooting diff --git a/src/connections/destinations/catalog/google-ads-gtag/index.md b/src/connections/destinations/catalog/google-ads-gtag/index.md index 3ce0ef820d..f2f4780e80 100644 --- a/src/connections/destinations/catalog/google-ads-gtag/index.md +++ b/src/connections/destinations/catalog/google-ads-gtag/index.md @@ -47,7 +47,7 @@ To enable consent mode for your Google Ads (Gtag) destination, you can choose fr * **Option 1:** 1. Set the consent defaults by implementing the `ready()` method to set consent defaults. - ``` + ```js analytics.ready(function() { window.gtag('consent', 'default', { 'ad_storage': 'granted', @@ -62,7 +62,7 @@ To enable consent mode for your Google Ads (Gtag) destination, you can choose fr 3. Pass the information to Gtag.js by calling `gtag` inside the Segment `ready`() method. - ``` + ```js analytics.ready(function() { window.gtag('consent', 'update', { 'ad_storage': 'denied', diff --git a/src/connections/destinations/catalog/gosquared/index.md b/src/connections/destinations/catalog/gosquared/index.md index b099baac37..afae7d69cd 100644 --- a/src/connections/destinations/catalog/gosquared/index.md +++ b/src/connections/destinations/catalog/gosquared/index.md @@ -12,7 +12,6 @@ Your GoSquared Now dashboard will instantly start showing the number of visitors GoSquared supports mobile, webpage and server-side tracking. -- - - ## Website Tracking @@ -22,7 +21,6 @@ When you enter your GoSquared site token into Segment, website tracking will aut To track data using Segment's mobile and server-side sources, you will need to enter a GoSquared API Key, which can be created in your [GoSquared account](https://www.gosquared.com/settings/api){:target="_blank"}. The API Key must have "Write Tracking" access. All functionality is supported by mobile and server-side tracking. -- - - ## Page diff --git a/src/connections/destinations/catalog/gtag/index.md b/src/connections/destinations/catalog/gtag/index.md index dcc0ff705f..e66fa2c11f 100644 --- a/src/connections/destinations/catalog/gtag/index.md +++ b/src/connections/destinations/catalog/gtag/index.md @@ -130,6 +130,8 @@ analytics.track('Logged In'); Segment sends these event attributes to Google Analytics: +| Event Attributes | Info | +| ------------------ | --------- | | **Event Category** | All | | **Event Action** | Logged In | @@ -150,6 +152,8 @@ In this example, Segment sends all Google Analytics event parameters: Segment sends these event attributes to Google Analytics: +| Event Attributes | Info | +| ------------------ | --------- | | **Event Category** | Account | | **Event Action** | Logged In | | **Event Label** | Premium | diff --git a/src/connections/destinations/catalog/hawkei/index.md b/src/connections/destinations/catalog/hawkei/index.md index 246e1bbe1c..b98c509eee 100644 --- a/src/connections/destinations/catalog/hawkei/index.md +++ b/src/connections/destinations/catalog/hawkei/index.md @@ -70,6 +70,6 @@ You'll want to create events that are part of critical paths in your application ## Troubleshooting -## AnonymousId +### AnonymousId All requests to Hawkei require an `anonymousId` to be set. Segment sets this automatically on client-side libraries, but for server side libraries (php, Ruby etc) this needs to be explicitly set. diff --git a/src/connections/destinations/catalog/hotjar/index.md b/src/connections/destinations/catalog/hotjar/index.md index a2698cbc26..35374deb7d 100644 --- a/src/connections/destinations/catalog/hotjar/index.md +++ b/src/connections/destinations/catalog/hotjar/index.md @@ -34,19 +34,20 @@ Identify calls that do not have a User ID value will not be sent to Hotjar. Currently, the Hotjar Identify API **does not** support ingesting values passed as nested objects or lists over your identify Spec: -```js +```json "traits": { - "name": "Peter Gibbons", - "email": "peter@example.com", - "plan": "premium", - "logins": 5, - "address": { - "street": "6th St", - "city": "San Francisco", - "state": "CA", - "postalCode": "94103", - "country": "USA" - } + "name": "Peter Gibbons", + "email": "peter@example.com", + "plan": "premium", + "logins": 5, + "address": { + "street": "6th St", + "city": "San Francisco", + "state": "CA", + "postalCode": "94103", + "country": "USA" + } +} ``` In the example above, Hotjar rejects all the values in the `address` field. @@ -62,8 +63,8 @@ Currently, the Hotjar Events API **does not** support ingesting event properties ```js analytics.track("Experiment Viewed", { experiment_id: "1234", - experiment_name: "new_upsell_UX" - variation_id: "1234b" + experiment_name: "new_upsell_UX", + variation_id: "1234b", variation_name: "variant" }); ``` diff --git a/src/connections/destinations/catalog/hydra/index.md b/src/connections/destinations/catalog/hydra/index.md index 655adfdf82..38df66ad93 100644 --- a/src/connections/destinations/catalog/hydra/index.md +++ b/src/connections/destinations/catalog/hydra/index.md @@ -23,7 +23,7 @@ If you would like to use `track` event data, create a `Segment Product Usage Sca If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like: -``` +```js analytics.identify('userId123', { email: 'john.doe@example.com', firstName: 'John', @@ -45,7 +45,7 @@ Identify calls will be sent to Hydra as an `identify` event. Upon receiving an I If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like: -``` +```js analytics.track('Device deploy started', "properties": { "feature": "Device management", diff --git a/src/connections/destinations/catalog/impact/index.md b/src/connections/destinations/catalog/impact/index.md index 003ba52a09..ef465b5e4c 100644 --- a/src/connections/destinations/catalog/impact/index.md +++ b/src/connections/destinations/catalog/impact/index.md @@ -26,7 +26,6 @@ For tracking on Web, you will need your... 4. Campaign ID Your campaign id will be displayed in the top right corner of your Impact dashboard. It will be the four numbers next to your campaign name. -- - - ## Track diff --git a/src/connections/destinations/catalog/infinario/index.md b/src/connections/destinations/catalog/infinario/index.md index e3737e9d55..d3579f950f 100644 --- a/src/connections/destinations/catalog/infinario/index.md +++ b/src/connections/destinations/catalog/infinario/index.md @@ -40,6 +40,5 @@ The alias call can be used to merge two user identities and their data to one. T This call is currently only supported partially. Whenever a user is assigned to a group, the properties of this group and the group ID is added to the user's properties. This means there is no support for the user being in multiple groups. -- - - Read the [Infinario guides](http://guides.infinario.com/){:target="_blank"} to see what can you do with the data you tracked. diff --git a/src/connections/destinations/catalog/iterable/index.md b/src/connections/destinations/catalog/iterable/index.md index b299e51950..26096ad54e 100644 --- a/src/connections/destinations/catalog/iterable/index.md +++ b/src/connections/destinations/catalog/iterable/index.md @@ -16,7 +16,6 @@ When you enable the Iterable destination from the Segment app, your data starts * [Automatically send a follow up email when your initial email goes unopened](https://segment.com/recipes/iterable-autoresponder-emails-when-unopened/) --> -- - - ## Identify diff --git a/src/connections/destinations/catalog/keen/index.md b/src/connections/destinations/catalog/keen/index.md index 57b9507edc..b0b9e97d3e 100644 --- a/src/connections/destinations/catalog/keen/index.md +++ b/src/connections/destinations/catalog/keen/index.md @@ -9,7 +9,6 @@ When you enable Keen in the Segment web app, your changes appear in the Segment Keen is supported on the client side and server side. -- - - ## Identify diff --git a/src/connections/destinations/catalog/librato/index.md b/src/connections/destinations/catalog/librato/index.md index 0c10df41a1..940024517e 100644 --- a/src/connections/destinations/catalog/librato/index.md +++ b/src/connections/destinations/catalog/librato/index.md @@ -9,7 +9,6 @@ When you enable Librato in the Segment web app, your changes appear in the Segme Librato supports the Segment `track` method for both client-side and server-side. -- - - ## Track diff --git a/src/connections/destinations/catalog/livechat/index.md b/src/connections/destinations/catalog/livechat/index.md index 748df4af30..97db17014a 100644 --- a/src/connections/destinations/catalog/livechat/index.md +++ b/src/connections/destinations/catalog/livechat/index.md @@ -9,7 +9,6 @@ When you enable LiveChat in the Segment web app, your changes appear in the Segm LiveChat is only supported on the client-side. -- - - ## Identify diff --git a/src/connections/destinations/catalog/marketo/index.md b/src/connections/destinations/catalog/marketo/index.md index 0012bc552e..5771c4461a 100644 --- a/src/connections/destinations/catalog/marketo/index.md +++ b/src/connections/destinations/catalog/marketo/index.md @@ -11,7 +11,6 @@ When you enable Marketo in the Segment web app, your changes appear in the Segme ### Important Note: Our client-side and server-side destinations each require **different** credentials for authentication. Read through the information below on `identify` calls for further information. -- - - ## Page and Track diff --git a/src/connections/destinations/catalog/mixpanel/index.md b/src/connections/destinations/catalog/mixpanel/index.md index 05fe21e16c..2ec9b89a3b 100644 --- a/src/connections/destinations/catalog/mixpanel/index.md +++ b/src/connections/destinations/catalog/mixpanel/index.md @@ -337,7 +337,6 @@ analytics.track({ Segment doesn't map `$library_version` since that is reserved for Mixpanel's library version, not Segment's. Segment doesn't map to `$brand`. -- - - ## Features diff --git a/src/connections/destinations/catalog/olark/index.md b/src/connections/destinations/catalog/olark/index.md index 0fa22b794a..cdc9587194 100644 --- a/src/connections/destinations/catalog/olark/index.md +++ b/src/connections/destinations/catalog/olark/index.md @@ -9,7 +9,6 @@ When you enable Olark in the Segment web app, your changes appear in the Segment Olark is only supported in device mode (on the client). -- - - ## Page @@ -32,7 +31,6 @@ More documentation on the Olark API can be found [in Olark's docs](https://www.o When you call [`track`](/docs/connections/spec/track/) or one of its helpers on analytics.js, we call Olark's `sendNotificationToOperator` function as `visitor triggered *eventName*`. You must enable this option with the *track* flag, because it can sometimes be bothersome. -- - - ## Features @@ -52,7 +50,6 @@ analytics.ready(function(){ [Read the ready docs for more details](/docs/connections/sources/catalog/libraries/website/javascript/#ready) -- - - ## Record Live Chat Events diff --git a/src/connections/destinations/catalog/onesignal/index.md b/src/connections/destinations/catalog/onesignal/index.md index 0dff3e8658..d1b084568f 100644 --- a/src/connections/destinations/catalog/onesignal/index.md +++ b/src/connections/destinations/catalog/onesignal/index.md @@ -11,7 +11,6 @@ OneSignal will only track new users. If you have existing push notification data OneSignal supports the `identify` and `track` methods and is currently only available on iOS using Segment. -- - - ## Identify & Track diff --git a/src/connections/destinations/catalog/planhat/index.md b/src/connections/destinations/catalog/planhat/index.md index 15f4744cb9..6bb2324655 100644 --- a/src/connections/destinations/catalog/planhat/index.md +++ b/src/connections/destinations/catalog/planhat/index.md @@ -12,7 +12,6 @@ The Segment Planhat destination is 100% handled through our servers, so you don' The Segment Planhat destination supports Identify, Page, Track, and Group calls. For more information, see the [Segment Spec documentation](/docs/connections/spec/). -- - - ## Identify diff --git a/src/connections/destinations/catalog/preact/index.md b/src/connections/destinations/catalog/preact/index.md index 42e22ca178..d14b58d3eb 100644 --- a/src/connections/destinations/catalog/preact/index.md +++ b/src/connections/destinations/catalog/preact/index.md @@ -17,7 +17,6 @@ To group users into accounts in preact you'll use our [`group`](/docs/connection Our [`track`](/docs/connections/spec/track) method will record events in Preact. Users must be identified on the client side for events to appear in Preact. -- - - ## Features diff --git a/src/connections/destinations/catalog/sailthru/index.md b/src/connections/destinations/catalog/sailthru/index.md index 717c8b0629..32500155f2 100644 --- a/src/connections/destinations/catalog/sailthru/index.md +++ b/src/connections/destinations/catalog/sailthru/index.md @@ -18,7 +18,6 @@ The Sailthru server-side destination will allow you to add users, send custom ev - The template passed through as `reminder_template` must match the public name configured in Sailthru's UI. - We recommend appending `traits.email` whenever possible in your `identify` calls. If you send an `identify` call without a `traits.email` and only a `userId`, the profile will be created in Sailthru but you would not be able to find that user using their **User Look Up** feature. -- - - ### Page You must configure a `customerId` in your integration settings in order to use the `page` functionality. This value is only required for `page` calls and can be found in your Sailthru Dashboard under **App Settings** @@ -41,7 +40,6 @@ analytics.page('Page Name', { See our [documentation](/docs/connections/spec/page/#properties) for more info on the `keywords` property. -- - - ### Identify diff --git a/src/connections/sources/catalog/cloud-apps/marketo/index.md b/src/connections/sources/catalog/cloud-apps/marketo/index.md index 547770af8f..17a83e9485 100644 --- a/src/connections/sources/catalog/cloud-apps/marketo/index.md +++ b/src/connections/sources/catalog/cloud-apps/marketo/index.md @@ -36,10 +36,10 @@ You will need Admin permissions to your Marketo account. 2. Go to **Admin > Munchkin** to find your Munchkin Account ID. ![Screenshot of the Tracking Code section of Marketo's Munchkin page.](images/Image2018-04-30at5.28.54PM.png) 3. Go to Admin > LaunchPoint - 1. If you don't already have a REST service setup, follow [these steps](http://developers.marketo.com/rest-api/custom-services/){:target="_blank"}. - 2. Then, copy the "Client ID" and "Client Secret" parameters. - ![Screenshot of the Details section of the LaunchPoint page.](images/Image2018-04-30at5.29.32PM.png) - 3. Paste the "Client ID" and "Client Secret" into the Segment Marketo source settings. + 1. If you don't already have a REST service setup, follow [these steps](http://developers.marketo.com/rest-api/custom-services/){:target="_blank"}. + 2. Then, copy the "Client ID" and "Client Secret" parameters. + ![Screenshot of the Details section of the LaunchPoint page.](images/Image2018-04-30at5.29.32PM.png) + 3. Paste the "Client ID" and "Client Secret" into the Segment Marketo source settings. Data should start flowing into your warehouse in the next few hours.