You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/freshsales-suite-crm/index.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ You can use identify to create a contact when a website visitor fills a webform.
36
36
37
37
userId is a mandatory field which is used to identify the contact in Freshsales. If your user identifier is not email, then email has to be a part of traits.
38
38
39
-
```json=
39
+
```json
40
40
{
41
41
"userId": "97980cfea0067",
42
42
"type": "identify",
@@ -78,7 +78,7 @@ Custom fields won't automatically create. You have to create them in Freshsales
78
78
79
79
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.
80
80
81
-
```json=
81
+
```json
82
82
{
83
83
"userId" : "97980cfea0067",
84
84
"type": "identify",
@@ -101,7 +101,7 @@ You can also update Accounts and Deals associated with a contact in Freshsales.
101
101
102
102
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.
@@ -121,15 +121,16 @@ Segment standardized a series of reserved event names that have special semantic
121
121
122
122
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).
is an API that allows users to share customer interactions, behaviors, and
9
-
target audiences among IBM solutions and applications - including the *Watson
10
-
Marketing Portfolio* - without the need for custom software integration. In
11
-
effect, UBX is the "Segment" of IBM's ecosystem. Once data is routed to IBM, you
12
-
can send it to any destination in UBX's portfolio.
7
+
[IBM's Universal Behavior Exchange (UBX)](https://www.ibm.com/support/knowledgecenter/en/SS9JVY/UBX/kc_welcome_UBX.html){:target="_blank"} is an API that allows users to share customer interactions, behaviors, and target audiences among IBM solutions and applications - including the *Watson Marketing Portfolio* - without the need for custom software integration. In effect, UBX is the "Segment" of IBM's ecosystem. Once data is routed to IBM, you can send it to any destination in UBX's portfolio.
13
8
14
-
_**NOTE:** IBM UBX is currently in beta and this doc was last
15
-
updated on May 7, 2018. This means that there may still be some bugs for us to
16
-
iron out and we're excited to hear your thoughts. If you are interested in
17
-
joining or have any feedback to help us improve the IBM UBX Destination and its documentation, [let us know](https://segment.com/help/contact){:target="_blank"}!_
18
-
19
-
## Getting Started
20
-
21
-
_**NOTE:** To enable Segment in UBX, navigate to "Endpoints" in the UBX dashboard,
22
-
select "Register new endpoint", then select "Segment". Once you've added the
23
-
Segment endpoint, contact [Segment support](https://segment.com/help/contact){:target="_blank"} with your new endpoint's "endpoint
24
-
authentication key" for help activating your new endpoint. Note that the
25
-
endpoint in UBX will not be able to receive Segment data until you have enabled
26
-
both the destination in the Segment UI *and* requested activation of the
27
-
endpoint from Segment's support team._
9
+
> info ""
10
+
> IBM UBX is currently in beta and this doc was last updated on **May 7, 2018**. Segment is actively working on this feature. Some functionality may change before it becomes generally available. If you have any feedback to help improve the IBM UBX Destination and its documentation, [contact Segment](https://segment.com/help/contact){:target="_blank"}.
28
11
12
+
## Getting started
29
13
14
+
> info "Enabling Segment in UBX"
15
+
> To enable Segment in UBX, go to "Endpoints" in the UBX dashboard, select "Register new endpoint", then select "Segment".
16
+
>
17
+
> Once you've added the Segment endpoint, contact [Segment support](https://segment.com/help/contact){:target="_blank"} with your new endpoint's "endpoint authentication key" for help activating your new endpoint.
18
+
>
19
+
> Note that the endpoint in UBX cannot receive Segment data until you have enabled both the destination in the Segment UI *and* requested activation of the endpoint from Segment's support team.
30
20
31
21
1. From the Segment web app, click **Catalog**.
32
22
2. Search for "IBM UBX" in the Catalog, select it, and choose which of your sources to connect the destination to.
33
-
3. Enter your UBX API URL and your publisher's endpoint authentication key in
34
-
the Segment Settings UI. You should have received an email with this URL
35
-
shortly after setting up your UBX account. If you can't locate your URL,
36
-
contact UBX support (the URL is also referred to as a "base URL" in
37
-
the [IBM UBX documentation](https://developer.ibm.com/customer-engagement/docs/watson-marketing/ibm-universal-behavior-exchange-ubx/ubxapireference/){:target="_blank"}).
38
-
To locate your endpoint authentication key, navigate to the "Endpoints" tab
39
-
in UBX, then look to the far right where you'll find three vertical dots.
40
-
Click on them and select "Endpoint details".
41
-
4. Register and provision a Segment endpoint within your UBX dashboard so you
42
-
can access the appropriate endpoint authentication key. Do this by navigating
43
-
to "Endpoints", then "Register a new endpoint" and select "Segment". Then
44
-
click "Register" to proceed.
23
+
3. Enter your UBX API URL and your publisher's endpoint authentication key in the Segment Settings UI. You should receive an email with this URL after setting up your UBX account. If you can't locate your URL, contact UBX support.
24
+
> **Note**: The URL is also referred to as a "base URL" in the [IBM UBX documentation](https://developer.ibm.com/customer-engagement/docs/watson-marketing/ibm-universal-behavior-exchange-ubx/ubxapireference/){:target="_blank"}. To locate your endpoint authentication key, navigate to the **Endpoints** tab in UBX, click on the three dots symbol, and select **Endpoint details**.
25
+
4. Register and provision a Segment endpoint within your UBX dashboard so you can access the appropriate endpoint authentication key. To do this, go to **Endpoints > Register a new endpoint** and select "Segment". Click **Register** to proceed.
45
26
46
27

47
28
48
-
5. Once registered, the new endpoint's status will remain "Pending" in the
49
-
"Endpoints" tab until it has been activated. To activate an endpoint,
50
-
include your UBX account's API URL and your endpoint authentication key in an
51
-
email to Segment using our [tech support form](https://segment.com/help/contact/){:target="_blank"}.
52
-
29
+
6. Once registered, the new endpoint's status will remain "Pending" in the **Endpoints** tab until it has been activated. To activate an endpoint, include your UBX account's API URL and your endpoint authentication key in an email to Segment using the [tech support form](https://segment.com/help/contact/){:target="_blank"}.
53
30

54
31
55
-
6. Segment will activate your endpoint within 24 hours, at which time its status
56
-
will update to "Active" in the UBX dashboard. Now, you can grab your endpoint
57
-
authentication key again and paste it into your UBX settings in the Segment
58
-
UI.
32
+
7. Segment activates your endpoint within 24 hours, at which time its status updates to "Active" in the UBX dashboard. Now, you can grab your endpoint authentication key again and paste it into your UBX settings in the Segment UI.
59
33
34
+
## General tracking advice
60
35
61
-
## General Tracking Advice
62
-
63
-
We encourage customers to review UBX's dynamic event
64
-
library closely to become
65
-
familiar with UBX's specced events and properties. Many UBX consumers only
66
-
accept specific events; likewise, many consumers function best when specific
67
-
events include particular properties. Although Segment provides robust
68
-
out-of-the-box mapping (documented below), we still recommend reviewing the
69
-
dynamic event library closely to ensure that you are sending events and
70
-
properties that enable you to get the most out of your UBX consumers.
36
+
Segment encourages customers to review UBX's dynamic event library to become familiar with UBX's specced events and properties. Many UBX consumers only accept specific events; likewise, many consumers function best when specific events include particular properties. Although Segment provides robust out-of-the-box mapping, Segment still recommends reviewing the dynamic event library closely to ensure that you are sending events and properties that enable you to get the most out of your UBX consumers.
71
37
72
38
## Page
73
39
74
-
Page calls will send a 'Page View Event' to UBX (code `ibmpageView`). The below
75
-
mappings may apply:
40
+
Page calls send a 'Page View Event' to UBX (code `ibmpageView`). The following mappings might apply:
76
41
77
42
<table>
78
43
<tr>
@@ -82,32 +47,22 @@ mappings may apply:
82
47
<tr>
83
48
<td>`name`</td>
84
49
<td>`siteID`</td>
85
-
<tr>
50
+
</tr>
86
51
</table>
87
52
88
-
_**Note:** As with `track` events, all properties sent by the user that aren't
89
-
mapped above will be sent as attributes to UBX. To send a UBX-specced property
90
-
that isn't mapped above, simply set the Segment property name to the UBX
91
-
property code directly (e.g. `pageID`)._ Remember, you can find UBX-specific
92
-
event and property codes in their dynamic event
93
-
library.
53
+
**Note**: As with Track events, all properties sent by the user that aren't mapped are sent as attributes to UBX. To send a UBX-specced property that isn't mapped, set the Segment property name to the UBX property code directly (for example, `pageID`). You can find UBX-specific event and property codes in their dynamic event library.
94
54
95
55
## Track
96
56
97
-
Segment's integration with UBX supports all public recognized UBX event types.
98
-
Beware, however - UBX event destinations will only receive events to which they
99
-
are subscribed. To subscribe a UBX destination to events from the Segment
100
-
publisher, navigate to the "Events" tab and select "Subscribe to events".
57
+
Segment's integration with UBX supports all public recognized UBX event types. Beware, UBX event destinations only receive events to which they are subscribed. To subscribe a UBX destination to events from the Segment publisher, navigate to the **Events** tab and select "Subscribe to events".
101
58
102
59

103
60
104
-
Make sure that you subscribe your UBX event subscriber endpoints to the events
105
-
you'd like them to consume from the Segment publisher.
61
+
Make sure that you subscribe your UBX event subscriber endpoints to the events you'd like them to consume from the Segment publisher.
106
62
107
-
Note that while Segment supports all UBX-specced events, we have mapped the
108
-
following Segment-specced events and their properties to their UBX equivalents:
63
+
Note that while Segment supports all UBX-specced events, the following Segment-specced events and their properties have been mapped to their UBX equivalents:
109
64
110
-
### Event Mappings
65
+
### Event mappings
111
66
112
67
#### Mobile
113
68
Events
@@ -138,11 +93,7 @@ Events
138
93
</tr>
139
94
</table>
140
95
141
-
We do not define any specific mobile property mappings at this time given that
142
-
Segment's spec and UBX's spec do not share closely related mobile properties.
143
-
Note, you can still pass in any attribute codes as defined in UBX's dynamic
144
-
event library, and Segment
145
-
will pass these values downstream.
96
+
No specific mobile property mappings are defined at this time, given that Segment's spec and UBX's spec do not share closely related mobile properties. You can still pass in any attribute codes as defined in UBX's dynamic event library, and Segment passes these values downstream.
146
97
147
98
#### Ecommerce
148
99
Events
@@ -327,20 +278,12 @@ Attributes
327
278
</tr>
328
279
</table>
329
280
330
-
_**Note**: To send a UBX event or property that isn't mapped above, simply set
331
-
the Segment event or property name to the UBX-specced event or property code
332
-
directly (e.g. `opptyQualified`)._ Remember, you can find UBX-specific event and
333
-
property codes in their dynamic event
334
-
library.
281
+
> info ""
282
+
> To send a UBX event or property that isn't mapped, set the Segment event or property name to the UBX-specced event or property code directly (for example, `opptyQualified`). You can find UBX-specific event and property codes in their dynamic event library.
335
283
336
-
### Property Mappings
284
+
### Property mappings
337
285
338
-
Segment also maps some properties from the context object to their equivalent
339
-
UBX attributes. Note that UBX only supports a few data types - `string`,
340
-
`number`, `boolean` and `date`. Segment will automatically discard any
341
-
properties of a type not mentioned here, with the exception of objects, which we
342
-
will attempt to stringify. If we cannot, expect to see `[object Object]` appear
343
-
as the value in UBX.
286
+
Segment also maps some properties from the context object to their equivalent UBX attributes. Note that UBX only supports a few data types - `string`, `number`, `boolean` and `date`. Segment automatically discards any properties of a type not mentioned here, with the exception of objects, which Segment attempts to stringify. If this isn't possible, you can expect to see `[object Object]` appear as the value in UBX.
344
287
345
288
<table>
346
289
<tr>
@@ -409,7 +352,7 @@ as the value in UBX.
409
352
</tr>
410
353
</table>
411
354
412
-
### Integration-Specific Option Mapping
355
+
### Integration-specific option mapping
413
356
414
357
Segment maps the following integration-specific options to UBX:
415
358
@@ -428,8 +371,7 @@ Segment maps the following integration-specific options to UBX:
428
371
</tr>
429
372
</table>
430
373
431
-
An event containing all three integration-specific options may look something
432
-
like this:
374
+
An event containing all three integration-specific options might look like this:
It's important to note some information about precedent for each of these
449
-
options:
390
+
It's important to note some information about precedent for each of these options:
450
391
451
-
-`channel`: Segment first checks whether this value is defined in
452
-
integration-specific options; if not and we detect `analytics-android` or
453
-
`analytics-ios` libraries, `channel` is set to `mobile`; for all other
454
-
libraries, `channel` is set to `web`.
455
-
-`subChannel`: This value is not appended to the outgoing payload unless
456
-
explicity defined by the user.
457
-
-`ContactConsent`: This value is not appended to the outgoing payload unless
458
-
explicity defined by the user. The value passed to Segment must be in the
459
-
format `channel,subscriptionOption`. At the moment, the only acceptable
460
-
channels are `email` and `sms`, and the only two acceptable subscription
461
-
options are `opt-in` and `opt-out`.
392
+
-`channel`: Segment first checks whether this value is defined in integration-specific options. If not and if `analytics-android` or
393
+
`analytics-ios` libraries are detected,`channel` is set to `mobile`; for all other libraries, `channel` is set to `web`.
394
+
-`subChannel`: This value is not appended to the outgoing payload unless explicity defined by the user.
395
+
-`ContactConsent`: This value is not appended to the outgoing payload unless explicity defined by the user. The value passed to Segment must be in the format `channel,subscriptionOption`. At the moment, the only acceptable channels are `email` and `sms`, and the only two acceptable subscription options are `opt-in` and `opt-out`.
462
396
397
+
## FAQ
463
398
464
-
## Troubleshooting
465
-
466
-
### Not seeing any data from Segment appear in UBX
467
-
468
-
- Check to ensure your Segment publisher endpoint is "Active". If not, see
469
-
[Getting Started](#getting-started) above.
399
+
#### Why isn't the data from Segment appear in UBX?
400
+
- Ensure your Segment publisher endpoint is "Active". If not, see the [getting started](#getting-started) steps.
470
401
- Ensure you've subscribed your UBX destinations to the appropriate events.
471
402
472
-
## FAQ
403
+
## Troubleshooting
473
404
474
405
Segment does not auto-generate events other than an initial `page` call when using our Analytics.js library and mobile lifecycle events when mobile lifecycle tracking is enabled using Segment's Android or iOS library.
475
406
476
407
This means some events supported and in some cases expected by downstream UBX destinations - including *abandonment events* - must be derived by the customer. One approach would be to integrate with a marketing tool such as [Braze](/docs/connections/destinations/catalog/braze/) or [Bronto](/docs/connections/destinations/catalog/bronto/), in which you can [set up rules that generate abandonment events](/docs/guides/destinations/how-do-i-automate-multi-channel-re-engagement-campaigns/#1st-line-of-defense-the-push-notification), which are then be sent back through Segment and downstream to UBX.
477
408
478
-
Another approach may be to schedule a cron job in your database that checks for users who have triggered a `Product Added` event, but who never went on to trigger an `Order Completed` event. In this case, one can logically deduce that the user abandoned his cart, hence you should trigger a server-side Segment event based on this rule, which Segment will process and pass downstream to UBX.
409
+
Another approach may be to schedule a cron job in your database that checks for users who have triggered a `Product Added` event, but who never went on to trigger an `Order Completed` event. In this case, you can assume that the user abandoned his cart, therefore, you should trigger a server-side Segment event based on this rule, which Segment will process and pass downstream to UBX.
479
410
480
411
Segment's integration with UBX supports the following UBX abandonment events:
[SendGrid Marketing Campaigns](http://twilio.com/docs/sendgrid/ui/integrations/segment?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} lets you automatically stream your email events directly into Segment for use inside your warehouse or other downstream destinations.
6
+
[SendGrid Marketing Campaigns](https://twilio.com/docs/sendgrid/ui/integrations/segment?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} lets you automatically stream your email events directly into Segment for use inside your warehouse or other downstream destinations.
7
7
8
8
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) that can not only export data into your Segment warehouse but also federate the exported data into your other enabled Segment destinations.
0 commit comments