Skip to content

Commit 0f2c19b

Browse files
committed
Added freshchat-segment documentation and relevant images
1 parent b54f0c4 commit 0f2c19b

File tree

4 files changed

+55
-4
lines changed

4 files changed

+55
-4
lines changed

src/connections/sources/catalog/cloud-apps/freshchat-source/index.md

Lines changed: 0 additions & 4 deletions
This file was deleted.
253 KB
Loading
282 KB
Loading
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
### Freshchat Source
2+
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
4+
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.
6+
7+
This source is maintained by Freshworks. For any issues with the source, contact the [**Freshchat Support team**](mailto:[email protected])
8+
9+
### Getting Started:
10+
11+
Before you start, make sure that you have admin rights in both Aircall and Segment.
12+
13+
**Step 1:** Authenticate Segment
14+
15+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) 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 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).
19+
4. Click **Add Source** to save your settings.
20+
5. Copy the Write key from the Segment UI to use in Freshchat
21+
22+
**Step 2:** Authenticate Freshchat
23+
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+
28+
**Step 3:** Select Freshchat events to send to Segment
29+
30+
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
31+
2. You can add/remove the events that you want to send anytime after the app installation
32+
33+
![Screenshot of the Freshchat Segment installation page 2nd step.](images/freshchat-installation-2.png)
34+
35+
### Events
36+
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.
38+
39+
| Event Name | Description |
40+
| --- | --- |
41+
| onAgentActivityCreate | When the general availability or Intelliassign status changes |
42+
| 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 |
47+
| onMessageCreate | When a message is posted, either by the agent or user |
48+
49+
### **Adding Destinations**
50+
51+
Now that your Source is set up, you can connect it with Destinations.
52+
53+
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.
54+
55+
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)