Skip to content

Commit a12904d

Browse files
Merge pull request #5165 from jerusheya-johnson/segment_freshchat
Added freshchat-segment documentation and relevant images
2 parents a4175fc + 7e6fea2 commit a12904d

File tree

1 file changed

+51
-3
lines changed
  • src/connections/sources/catalog/cloud-apps/freshchat-source

1 file changed

+51
-3
lines changed
Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,52 @@
11
---
2-
title: 'Freshchat Source Source'
3-
hidden: true
4-
---
2+
title: Freshchat Source
3+
beta: true
4+
id: tCkZda6aKQ
5+
---
6+
7+
[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.
8+
9+
This source is maintained by Freshworks. For any issues with the source, contact the [Freshchat Support team](mailto:[email protected]).
10+
11+
## Getting started:
12+
13+
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.
14+
15+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank"} click **Add Source**.
16+
2. Search for "Freshchat" in the Sources Catalog, select Freshchat, and click **Add Source**.
17+
3. On the next screen, give the Source a nickname and configure any other settings.
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 Segment recommend using something that reflects the source itself and distinguishes amongst your environments (eg. Freshchat_Prod, Freshchat_Staging, Freshchat_Dev).
19+
4. Click **Add Source** to save your settings.
20+
5. Copy the Write key from the Segment UI to use in Freshchat.
21+
6. Log in to your Freshchat account.
22+
7. In Freshchat, navigate to Admin → Marketplace Apps → Segment Integration.
23+
8. Paste the your Segment write key and click **Authenticate account** to connect.
24+
9. After your account is authenticated, select one or more of the following events to send to Segment:
25+
- On Agent Activity Create
26+
- On Conversation Create
27+
- On Conversation Update
28+
- On Message Create
29+
For more information about Product Events, see the [Freshchat Product Events](https://developers.freshchat.com/v2/docs/product-events/){:target="_blank”} documentation.
30+
10. There are [four events](https://developers.freshchat.com/v2/docs/product-events/#){:target="_blank"} that can be pushed to Segment. You can choose the events that you want to send to Segment.
31+
11. You can add/remove the events that you want to send anytime after the app installation
32+
33+
### Events
34+
35+
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.
36+
37+
| Event Name | Description |
38+
| --- | --- |
39+
| On Agent Activity Create | When the general availability or Intelliassign status changes |
40+
| On Conversation Create | When a conversation is initiated by a user |
41+
| On Conversation Update | When a conversation is:<br> - Assigned to an agent or group <br> - Reassigned to an agent <br> - Resolved or opened |
42+
| On Message Create | When a message is posted, either by the agent or user |
43+
44+
To find the list of properties associated with the events, please refer to the [Freshchat Developer Documentation](https://developers.freshchat.com/v2/docs/product-events/){:target="_blank"}.
45+
46+
## Adding Destinations
47+
48+
Now that your Source is set up, you can connect it with Destinations.
49+
50+
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.
51+
52+
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)