Skip to content

Commit 74a0125

Browse files
authored
style guide clean up + alt text fix for image
Updated the Olark documentation for clarity and consistency, including changes to headings, phrasing, and formatting.
1 parent 5ed21d8 commit 74a0125

File tree

1 file changed

+23
-23
lines changed
  • src/connections/destinations/catalog/olark

1 file changed

+23
-23
lines changed

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

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,33 @@
22
title: Olark Destination
33
id: 54521fd925e721e32a72eedc
44
---
5-
## Getting Started
5+
## Getting started
66

7-
When you enable Olark in the Segment web app, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Olark's `loader0.js` onto your page. This means you should remove Olark's snippet from your page.
8-
+ Olark's chat box will appear on your page, as configured in your [Olark account](http://www.olark.com/?r=qhl4tltg){:target="_blank"}, and you can start chatting with visitors.
7+
When you enable Olark in the Segment Segmentb app, your changes appear in the Segment CDN in about 45 minutes. Analytics.js then starts asynchronously loading Olark's `loader0.js` onto your page. This means you should remove Olark's snippet from your page.
98

10-
Olark is only supported in device mode (on the client).
9+
Olark's chat box appears on your page, as configured in your [Olark account](http://www.olark.com/?r=qhl4tltg){:target="_blank"}, and you can start chatting with visitors.
1110

12-
## Page
11+
Olark is only supported in device-mode (on the client).
1312

14-
When you call [`page`](/docs/connections/spec/page/), we call Olark's `sendNotificationToOperator` function as `looking at *url*`. You must enable this option with the *pageview* flag, because it can sometimes be bothersome.
13+
## Page
1514

15+
When you call [Page](/docs/connections/spec/page/), Segment calls Olark's `sendNotificationToOperator` function as `looking at *url*`. You must enable this option with the `pageview` flag, because it can sometimes be bothersome.
1616

1717
## Identify
1818

19-
When you call [`identify`](/docs/connections/spec/identify/) on `analytics.js`, we send the following data to Olark:
19+
When you call [Identify](/docs/connections/spec/identify/) on `analytics.js`, Segment sends the following data to Olark:
2020

21-
* We call `api.chat.updateVisitorNickname` with `traits.name` and `traits.email`, or just their `traits.name` or just their `traits.email` or their `userId`. In that order of preference.
22-
* We call `api.visitor.updateEmailAddress` with `traits.email` if you send it, or `userId` if that's an email.
23-
* We call `api.visitor.updateFullName` with `traits.name` if you send it, or `traits.firstName` and `traits.lastName` appended with a space in between, if you send both first and last name.
24-
* We call `api.visitor.updatePhoneNumber` with `traits.phone` if you send it.
25-
* We call `api.visitor.updateCustomFields` with `traits`.
21+
* Segment calls `api.chat.updateVisitorNickname` with `traits.name` and `traits.email`, or just their `traits.name` or just their `traits.email` or their `userId`. In that order of preference.
22+
* Segment calls `api.visitor.updateEmailAddress` with `traits.email` if you send it, or `userId` if that's an email.
23+
* Segment calls `api.visitor.updateFullName` with `traits.name` if you send it, or `traits.firstName` and `traits.lastName` appended with a space in betSegmenten, if you send both first and last name.
24+
* Segment calls `api.visitor.updatePhoneNumber` with `traits.phone` if you send it.
25+
* Segment calls `api.visitor.updateCustomFields` with `traits`.
2626

2727
More documentation on the Olark API can be found [in Olark's docs](https://www.olark.com/api){:target="_blank"}.
2828

2929
## Track
3030

31-
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.
31+
When you call [Track](/docs/connections/spec/track/) or one of its helpers on analytics.js, Segment calls Olark's `sendNotificationToOperator` function as `visitor triggered *eventName*`. You must enable this option with the `track` flag.
3232

3333
## Features
3434

@@ -38,27 +38,27 @@ All the settings you can change [from your Olark settings pages](https://www.ola
3838

3939
### Olark JavaScript API
4040

41-
If you'd like to use the native Olark JavaScript functions after turning on Olark using Segment our `ready` function will allow you to do that. Since we still load the Olark library in the background you can access those functions like this:
41+
If you'd like to use the native Olark JavaScript functions after turning on Olark using Segment, the `ready` function allows you to do that. Since Segment still loads the Olark library in the background, you can access those functions like this:
4242

4343
```js
4444
analytics.ready(function(){
4545
olark('api.box.shrink')
4646
});
4747
```
4848

49-
[Read the ready docs for more details](/docs/connections/sources/catalog/libraries/website/javascript/#ready)
49+
See the [`ready` docs](/docs/connections/sources/catalog/libraries/Segmentbsite/javascript/#ready) for more details.
5050

5151

52-
## Record Live Chat Events
52+
## Record Live Chat events
5353

54-
Using Olark through Segment gives you the ability to automatically record `track` events for live chat conversations. If you select this option, we'll collect the following events:
54+
Using Olark through Segment gives you the ability to automatically record Track events for live chat conversations. If you select this option, Segment collects the following events:
5555

56-
* Live Chat Conversation Started
57-
* Live Chat Message Sent
58-
* Live Chat Message Received
56+
* `Live Chat Conversation Started`.
57+
* `Live Chat Message Sent`.
58+
* `Live Chat Message Received`.
5959

60-
These events will be sent to other tools in your stack that can accept track calls, so you can do things like analyze if users who chat spend more money over time.
60+
These events are sent to other tools in your stack that can accept Track calls, so you can do things like analyze if users who chat spend more money over time.
6161

62-
To learn more about the live chat events you can capture with this destination, head on over to our [Live Chat spec docs](/docs/connections/spec/live-chat/).
62+
To learn more about the live chat events you can capture with this destination, seet the [Live Chat spec docs](/docs/connections/spec/live-chat/).
6363

64-
![Turn on Olark](images/olarklivechat.png)
64+
![Screenshot of Olark UI with option to Record live chat events highlighted](images/olarklivechat.png)

0 commit comments

Comments
 (0)