Skip to content

Commit 5a5c6a0

Browse files
Apply suggestions from code review
Co-authored-by: stayseesong <[email protected]>
1 parent df0ede4 commit 5a5c6a0

File tree

1 file changed

+23
-11
lines changed
  • src/connections/destinations/catalog/freshsales-suite-crm

1 file changed

+23
-11
lines changed

src/connections/destinations/catalog/freshsales-suite-crm/index.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,21 @@ id: 62945b73b8fbe38be7718039
55

66
[Freshsales Suite](https://www.freshworks.com/crm/suite/){:target="_blank"} is a cloud CRM software that breaks organizational silos across sales, marketing, and support, allowing businesses to connect with customers across all touchpoints in one system.
77

8-
This destination is maintained by Freshsales. For any issues with the destination [contact the Freshsales support team](mailto:[email protected]).
8+
Freshsale maintains this destination. For any issues with the destination [contact the Freshsales support team](mailto:[email protected]).
99

1010
## Getting Started
1111

12-
Freshsales Suite - CRM supports identify, page, and track methods, allowing users to create and update Freshsales contacts through Segment. To enable the Freshsales Suite - CRM destination, navigate to **Freshsales Admin Settings > Third Party Integrations > Segment** on the Freshsales platform. Click **Install** and select the Segment source you wish to connect to your Freshsales Suite - CRM destination. You can also add the Freshsales Suite - CRM destination from the Segment destinations catalog. You will have to provide the subdomain and API key in the destination settings, which are found in your Freshsales account.
12+
Freshsales Suite - CRM supports identify, page, and track methods, which allows users to create and update Freshsales contacts through Segment. To enable the Freshsales Suite - CRM destination:
13+
1. Navigate to **Freshsales Admin Settings > Third Party Integrations > Segment** on the Freshsales platform.
14+
2. Click **Install** and select the Segment source you wish to connect to your Freshsales Suite - CRM destination.
15+
16+
You can also add the Freshsales Suite - CRM destination from the Segment destinations catalog.
17+
1. From the Segment web app, navigate to **Catalog > Destinations** and click **Add Destination**.
18+
2. Find the Destinations Actions item in the left navigation, and click it.
19+
3. Search for **Freshsales Suite - CRM** and select it.
20+
4. Click **Configure Freshsales Suite - CRM**.
21+
5. Select the Source you want to connect to Freshsales Suite - CRM.
22+
6. Provide the subdomain and API key in the destination settings that are found in your Freshsales account.
1323

1424

1525
## Supported methods
@@ -19,7 +29,7 @@ Freshsales Suite - CRM supports the following methods.
1929

2030
### Identify
2131

22-
You can use identify to create a contact when a website visitor fills a webform. When you identify a user, we’ll pass that user’s information to Freshsales.
32+
You can use identify to create a contact when a website visitor fills a webform. When you identify a user, Segment passes that user’s information to Freshsales.
2333

2434

2535
#### UserId
@@ -49,23 +59,25 @@ Traits are pieces of information you know about a user that are included in an i
4959

5060
#### Default Traits
5161

52-
Segment has reserved some traits that have semantic meanings for users. You should only use reserved traits for their intended meaning. Check the [Segment Spec](https://segment.com/docs/connections/spec/identify/#traits) to get a list of reserved traits.
62+
Segment reserved some traits that have semantic meanings for users. You should only use reserved traits for their intended meaning. Check the [Segment Spec](/docs/connections/spec/identify/#traits) to get a list of reserved traits.
5363

5464
![](images/freshsales-screenshot.png)
5565

56-
All attributes that are a part of traits should correspond to the internal names of those fields in Freshsales. Attributes that are not mapped with their corresponding fields are ignored.
66+
All attributes that are a part of traits should correspond to the internal names of those fields in Freshsales. Segment ignores attributes that aren't mapped with their corresponding fields.
5767

58-
However, we make exception to two attributes: title and phone, which are reserved traits in Segment. They are automatically mapped to Freshsales attributes job_title and work_number respectively.
68+
However, Segment makes an exception for two attributes: `title` and `phone`, which are reserved traits in Segment. They automatically map to the Freshsales attributes of `job_title` and `work_number` respectively.
5969

6070
#### Custom Traits
6171

62-
As part of traits, you can send custom fields created in Freshsales by using their internal names in camel case. You can find internal names in the corresponding field settings page. Also, custom fields will not be automatically created. You have to create them in Freshsales before proceeding to send data from Segment. To learn more about creating custom fields in Freshsales click [here](https://crmsupport.freshworks.com/en/support/solutions/articles/50000002389-how-to-create-custom-fields-for-contacts-accounts-and-deals-).
72+
As part of traits, you can send custom fields created in Freshsales by using their internal names in camel case. You can find internal names in the corresponding field settings page.
73+
74+
Custom fields won't automatically create. You have to create them in Freshsales before proceeding to send data from Segment. [Learn more (https://crmsupport.freshworks.com/en/support/solutions/articles/50000002389-how-to-create-custom-fields-for-contacts-accounts-and-deals-){:target="_blank"} about creating custom fields in Freshsales.
6375
![](images/custom-traits.png)
6476

6577

6678
#### Objects
6779

68-
Accounts and Deals associated with a contact can also be updated in Freshsales. The objects, company and deal, in the identify payload, correspond to the Accounts and Deals objects in Freshsales. Using the identify method, when creating a contact, it is also possible to create the corresponding Account and Deal in Freshsales. To do so, pass the company or the deal objects within traits in the identify call.
80+
You can also update Accounts and Deals associated with a contact in Freshsales. The company and deal objects in the identify payload correspond to the Accounts and Deals objects in Freshsales. When you use the identify method to create a contact, it's possible to also create the corresponding Account and Deal and Freshsales. To do this, pass the company or the deal objects within traits in the identify call.
6981

7082
```json=
7183
{
@@ -88,7 +100,7 @@ Accounts and Deals associated with a contact can also be updated in Freshsales.
88100

89101
### Track
90102

91-
You can track activities of your website visitors. If a user is subscribing to a newsletter and you want to track it, use the track method to accomplish that.
103+
You can track activities of your website visitors. If a user is subscribing to a newsletter and you want to track it, use the track method.
92104

93105
```json=
94106
{
@@ -104,11 +116,11 @@ You can track activities of your website visitors. If a user is subscribing to a
104116
}
105117
```
106118

107-
Segment has standardized a series of reserved event names that have special semantic meaning. We map these events to tools that support them whenever possible. See the [Semantic Events docs](/docs/connections/spec/semantic) for more detail. Custom events are supported as well.
119+
Segment standardized a series of reserved event names that have special semantic meaning. Segment maps these events to tools that support them whenever possible. See the [Semantic Events docs](/docs/connections/spec/semantic) for more detail. Custom events are supported as well.
108120

109121
### Page
110122

111-
If you want to track users visiting your sites, you can use the page method. When you call a page event, we send a pageview to Freshsales. You can send extra data paramerties within properties in the event payload. [See the reserved properties for more details](/docs/connections/spec/page/#properties).
123+
If you want to track users visiting your sites, you can use the page method. When you call a page event, Segment sends a pageview to Freshsales. You can send extra data parameters within properties in the event payload. [See the reserved properties for more details](/docs/connections/spec/page/#properties).
112124

113125
```json=
114126
{

0 commit comments

Comments
 (0)