Skip to content

Commit 66f30bc

Browse files
committed
addressed review comments
1 parent 7e47635 commit 66f30bc

File tree

3 files changed

+27
-23
lines changed

3 files changed

+27
-23
lines changed
Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,59 @@
1-
### Freshchat Source
1+
---
2+
title: Freshchat Source
3+
hidden: true
4+
beta: true
5+
id: xqegKCQA0W
6+
---
27

3-
**Freshchat** is a modern messaging software built for sales and customer engagement teams to talk to customers across various channels like website, email and social channels
8+
[Freshchat](https://www.freshworks.com/live-chat-software/){:target="_blank"} is a modern messaging software built for sales and customer engagement teams to talk to customers across websites, emails and social networks.
49

5-
This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations.
10+
This source is maintained by Freshworks. For any issues with the source, contact the [Freshchat Support team](mailto:[email protected])
611

7-
This source is maintained by Freshworks. For any issues with the source, contact the [**Freshchat Support team**](mailto:[email protected])
12+
## Getting started:
813

9-
### Getting Started:
10-
11-
Before you start, make sure that you have admin rights in both Aircall and Segment.
14+
Before you start, make sure that you have admin rights in Freshchat and [Workspace Owner or Source Admin roles](/docs/segment-app/iam/roles/) in Segment.
1215

1316
**Step 1:** Authenticate Segment
1417

15-
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**.
18+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank"} click **Add Source**.
1619
2. Search for "Freshchat" in the Sources Catalog, select Freshchat, and click **Add Source**.
17-
3. On the next screen, give the Source a Name & set Labels
18-
- The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev).
20+
3. On the next screen, give the Source a nickname and configure any other settings.
21+
- The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but Segment recommend using something that reflects the source itself and distinguishes amongst your environments (eg. Freshchat_Prod, Freshchat_Staging, Freshchat_Dev).
1922
4. Click **Add Source** to save your settings.
20-
5. Copy the Write key from the Segment UI to use in Freshchat
23+
5. Copy the Write key from the Segment UI to use in Freshchat.
2124

2225
**Step 2:** Authenticate Freshchat
2326

24-
1. Log in to your Freshchat account - navigate to Admin → Marketplace Apps → Segment Integration and paste the key to connect.
25-
26-
![Screenshot of the Freshchat Segment installation page.](images/freshchat-installation-1.png)
27+
1. Log in to your Freshchat account.
28+
2. In Freshchat, navigate to Admin → Marketplace Apps → Segment Integration.
29+
3. Paste the your Segment write key and click **Authenticate account** to connect.
30+
4. After your account is authenticated, select one or more of the following events to send to Segment:
31+
- onAgentActivityCreate
32+
- onConversationCreate
33+
- onConversationUpdate
34+
- onMessageCreate
35+
For more information about Product Events, see the [Freshchat Product Events](https://developers.freshchat.com/v2/docs/product-events/){:target="_blank”} documentation.
2736

2837
**Step 3:** Select Freshchat events to send to Segment
2938

3039
1. There are [4 events](https://developers.freshchat.com/v2/docs/product-events/#) that can be pushed to Segment. You will be able to choose the events that you want to send to Segment
3140
2. You can add/remove the events that you want to send anytime after the app installation
3241

33-
![Screenshot of the Freshchat Segment installation page 2nd step.](images/freshchat-installation-2.png)
34-
3542
### Events
3643

37-
The table below lists events that <integration_name> sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. <integration_name> includes the `userId` if available.
44+
The table below lists events that Freshchat sends to Segment. These events appear as tables in your warehouse and as regular events in other Destinations. Freshchat includes the userId if available.
3845

3946
| Event Name | Description |
4047
| --- | --- |
4148
| onAgentActivityCreate | When the general availability or Intelliassign status changes |
4249
| onConversationCreate | When a conversation is initiated by a user |
43-
| onConversationUpdate | When a conversation is:
44-
→ Assigned to an agent or group
45-
→ Existing conversation is reassigned to an agent
46-
→ Conversation is resolved or opened |
50+
| onConversationUpdate | When a conversation is:<br> - Assigned to an agent or group <br> - Reassigned to an agent <br> - Resolved or opened |
4751
| onMessageCreate | When a message is posted, either by the agent or user |
4852

49-
### **Adding Destinations**
53+
## Adding Destinations
5054

5155
Now that your Source is set up, you can connect it with Destinations.
5256

5357
Log into your downstream tools and check to see that your events are populating and they contains all the properties you expect. If all your events and properties are not showing up, refer to the Destination docs for troubleshooting.
5458

55-
If you experience any issues with how the events arrive in Segment, contact the [**Freshchat Support team**](mailto:[email protected])
59+
If you experience any issues with how the events arrive in Segment, contact the [Freshchat Support team](mailto:[email protected])

0 commit comments

Comments
 (0)