Skip to content

Commit 242947e

Browse files
Merge pull request #7433 from segmentio/rm-note-callouts
Remove note callouts from the docs
2 parents 563d029 + 2bad1fa commit 242947e

File tree

109 files changed

+317
-355
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+317
-355
lines changed

Diff for: src/connections/destinations/add-destination.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Each destination can also have destination settings. These control how Segment t
9292

9393
## Connecting one source to multiple instances of a destination
9494

95-
> note ""
95+
> success ""
9696
> Multiple-destination support is available for all Segment customers on all plan tiers.
9797
9898
Segment allows you to connect a source to multiple instances of a destination. You can use this to set up a single Segment source that sends data into different instances of your analytics and other tools.

Diff for: src/connections/destinations/catalog/actions-google-analytics-4-web/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ For event data to be sent downstream to Google Analytics:
162162
163163
Google has introduced a feature for collecting [user-provided data](https://support.google.com/analytics/answer/14077171?hl=en&utm_id=ad){:target="_blank"}, which Segment doesn't support. If you’ve enabled this feature in your Google Analytics 4 account, it is irreversible and may cause issues with receiving data. If everything else is set up correctly but data is still not appearing, check if this feature is enabled. If it is, you’ll need to create a new GA4 space to resolve the issue.
164164
165-
> note "If you toggled Page Views in your Settings to “On”, the page_view event automatically sends when the Set Configuration Mapping is triggered"
165+
> info "If you toggled Page Views in your Settings to “On”, the page_view event automatically sends when the Set Configuration Mapping is triggered"
166166
> If you need to override this setting for your particular use case, see [Can I override my send_page_view selection that I declared in Settings?](#can-i-override-my-send_page_view-selection-that-i-declared-in-settings)
167167
168168
If no events are flowing to your GA4 instance, use one of the Debugging Tools to check the sequence of GA4 events.

Diff for: src/connections/destinations/catalog/actions-hubspot-cloud/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ HubSpot Cloud Mode (Actions) provides the following benefits over the classic Hu
3535
- **Sandbox support**. Test with a HubSpot sandbox account before implementing in your main production account to feel confident in your configuration.
3636
- **Support for custom behavioral events**. Send [custom behavioral events](https://developers.hubspot.com/docs/api/analytics/events){:target="_blank"} and event properties to HubSpot.
3737
- **Create records in custom objects**. Use your Segment events to create records in any standard or custom object in your HubSpot account.
38-
39-
> note ""
40-
> A HubSpot Enterprise Marketing Hub account is required to send Custom Behavioral Events.
38+
39+
> info ""
40+
> A HubSpot Enterprise Marketing Hub account is required to send Custom Behavioral Events.
4141
4242
## Getting started
4343

Diff for: src/connections/destinations/catalog/actions-hubspot-web/index.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,4 @@ HubSpot Web (Actions) provides the following benefits over the classic HubSpot d
4040
## FAQ & Troubleshooting
4141

4242
### Why aren't my custom behavioral events appearing in HubSpot?
43-
HubSpot has several limits for custom behavioral events, including a limit on the number of event properties per event. Each event can contain data for up to 50 properties. If this limit is exceeded, HubSpot will truncate to only update 50 properties per event completion. See [HubSpot documentation](https://knowledge.hubspot.com/analytics-tools/create-custom-behavioral-events#define-the-api-call){:target="_blank"} for other limits.
44-
45-
> note ""
46-
> A HubSpot Enterprise Marketing Hub account is required to send Custom Behavioral Events.
43+
You must have a HubSpot Enterprise Marketing Hub account to send custom behavioral events. If you have a HubSpot Enterprise Marketing Hub account and are still missing events, you might have exceeded the limit on the number of event properties per event. Each event can contain data for up to 50 properties. If this limit is exceeded, HubSpot will truncate to only update 50 properties per event completion. See [HubSpot documentation](https://knowledge.hubspot.com/analytics-tools/create-custom-behavioral-events#define-the-api-call){:target="_blank"} for other limits.

Diff for: src/connections/destinations/catalog/adobe-analytics/best-practices.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,7 @@ To pass in a custom LinkName to Adobe Analytics, pass it as a string in the `int
8080
}
8181
```
8282

83-
If you don't specify a custom linkName in the integration specific object in the payload, Segment defaults to mapping `linkName` to the value from `(context.page.url)`. If no URL is present, Segment sets `linkName` to `No linkName provided`.
84-
85-
> note ""
86-
> **Note**: If you enable the `useLegacyLinkName` setting in the UI, Segment prepends `Link Name -` to the value you specified in the integration-specific object.
83+
If you don't specify a custom linkName in the integration specific object in the payload, Segment defaults to mapping `linkName` to the value from `(context.page.url)`. If no URL is present, Segment sets `linkName` to `No linkName provided`. If you enable the `useLegacyLinkName` setting in the UI, Segment prepends `Link Name -` to the value you specified in the integration-specific object.
8784

8885
### Setting the event LinkURL
8986

Diff for: src/connections/destinations/catalog/adobe-analytics/identity.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,9 @@ This may be acceptable if your organization can handle slightly inflated user co
4242

4343
Segment recommends that you accept the slightly inflated user count, and use the Segment `userId` as the `visitorId`. Yes, you'll have two user profiles if you have any anonymous client side events, but you can always set up custom `eVars` to connect the few anonymous events to the correct user.
4444

45-
If you're using the Experience Cloud ID, you should accept this and use the Segment `userId`, and include a `marketingCloudVisitorId` in `context["Adobe Analytics"].marketingCloudVisitorId`. Segment sends both the `userId` (or `anonymousId`, if the call is anonymous) in the `<visitorId>` tag and the Experience Cloud ID in the `<marketingCloudVisitorID>` tag, and Adobe resolves the users from there.
45+
If you're using the Experience Cloud ID, you should accept this and use the Segment `userId`, and include a `marketingCloudVisitorId` in `context["Adobe Analytics"].marketingCloudVisitorId`. Segment sends both the `userId` (or `anonymousId`, if the call is anonymous) in the `<visitorId>` tag and the Experience Cloud ID in the `<marketingCloudVisitorID>` tag, and Adobe resolves the users from there. If you use the destination-specific `integration` object to pass the `visitorId` in your Segment `page` or `track` events, then the `visitorId` persists on Page or Track calls that occur after an Identify call. You can use this to override the Segment setting the `visitorId` variable to your `userId` after an `identify` call.
4646

47-
> note ""
48-
> **Note**: If you use the destination-specific `integration` object to pass the `visitorId` in your Segment `page` or `track` events, then the `visitorId` persists on Page or Track calls that occur after an Identify call. You can use this to override the Segment setting the `visitorId` variable to your `userId` after an `identify` call.
49-
50-
We know this is daunting territory, so don't hesitate to [contact us directly for guidance](https://segment.com/help/contact/){:target="_blank”}.
47+
If you experience issues with visitor counts when using Cloud Mode, [contact Segment support directly for guidance](https://segment.com/help/contact/){:target="_blank”}.
5148

5249

5350
## No Fallbacks for VisitorId Setting - Cloud Mode Only

Diff for: src/connections/destinations/catalog/adobe-analytics/settings.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -358,8 +358,10 @@ The Segment Adobe Analytics Merchandising setting runs as follows:
358358
If you don't include a value, Segment sends the event without one, and Adobe understands this as an increment of `1`. If you configure a value and the value is not present on the `track` or `page` call, Segment does not send the event to Adobe.
359359
- Map of product eVars to set on the products string. This is only supported at the product level, as expected by Adobe Analytics. <!-- TODO LR Note: this whole section could use work, but this part is especially confusing-->
360360

361-
> note ""
362-
> **Note**: Some events in the Ecommerce spec do not use the "products" array and product information is located in the top level property object, for example the [Product Added Spec](/docs/connections/spec/ecommerce/v2/#product-added). Make sure you specify `properties.key` as the Segment key in the mapping when adding an eVar for **Product Added**, **Product Removed**, and **Product Viewed**.
361+
> info "Product Added, Product Removed, and Product Viewed events do not use the "products" array"
362+
> Product Added, Product Removed, and Product Viewed events store product information in the top level property object rather than in the "products" array. When adding an eVar to these events, specify `properties.key` as the Segment key in the mapping.
363+
>
364+
> For more information, see the [Product Added Spec](/docs/connections/spec/ecommerce/v2/#product-added).
363365
364366
Let's take the following example:
365367

@@ -565,10 +567,7 @@ This option allows you to associate specific Adobe events with individual Segmen
565567

566568
### IMS Region
567569

568-
This option allows you to associate events with IMS Regions.
569-
570-
> note ""
571-
> **Note**: If you specify this you must also define a `Marketing Cloud Visitor Id`.
570+
This option allows you to associate events with IMS Regions. If you specify an IMS region, you must also define a `Marketing Cloud Visitor Id`.
572571

573572
```javascript
574573
analytics.track({

Diff for: src/connections/destinations/catalog/adwords-remarketing-lists/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Create an audience of users that signed up, purchased a product, or otherwise pe
5252

5353
You can use Engage to create a detailed profile of your most loyal customers (sometimes called a “seed audience”) and then send this list of customers to Google. In Google, you can then use Google's [Similar Audience](https://support.google.com/google-ads/answer/7151628?hl=en-AU){:target="_blank”} features to find similar users to target. For example, you might want to create a group of high-value users who have spent a certain amount of money on your product, and then use Similar Audiences to find users who might also spend that much.
5454

55-
> note ""
56-
> A “seed audience” must have at least 100 members for Google's Similar Audience feature to function.
55+
> warning ""
56+
> A “seed audience” must have at least 100 members.
5757
5858

5959
### Remarketing audiences

Diff for: src/connections/destinations/catalog/amazon-lambda/index.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,7 @@ Using the examples provided, your Segment Lambda destination settings will look
108108
To create an IAM policy:
109109
1. Sign in to the [Identity and Access Management (IAM) console](https://console.aws.amazon.com/iam/){:target="_blank"}.
110110
2. Follow these instructions to [Create an IAM policy](http://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html){:target="_blank"} to allow Segment permission to invoke your Lambda function.
111-
3. Select the **Create Policy from JSON** option and use the following template policy in the **Policy Document** field. Be sure to change the `{region}`, `{account-id}` and `{function-names}` with the applicable values. An example of a Lambda ARN is: `arn:aws:lambda:us-west-2:355207333203:function:``my-example-function`.
112-
113-
> note ""
114-
> **NOTE:** You can put in a placeholder ARN for now, as you will need to come back to this step to update the ARN of your Lambda once you create that.
111+
3. Select the **Create Policy from JSON** option and use the following template policy in the **Policy Document** field. Be sure to change the `{region}`, `{account-id}` and `{function-names}` with the applicable values. An example of a Lambda ARN is: `arn:aws:lambda:us-west-2:355207333203:function:``my-example-function`. You can put in a placeholder ARN for now, as you will need to come back to this step to update the ARN of your Lambda once you create that.
115112

116113
```json
117114
{
@@ -148,8 +145,8 @@ To create an IAM role:
148145
7. Copy and paste the following code into your trust relationship. You should replace `<your-source-id>` with either the Source ID of the attached Segment source (the default) or the External ID set in your AWS Lambda destination settings.
149146
* `arn:aws:iam::595280932656:role/customer-lambda-prod-destination-access` refers to Segment's AWS Account, and is what allows Segment's Destination to access the role to invoke your Lambda.
150147

151-
> note ""
152-
> **Note**: Source ID can be found by navigating to **Settings > API Keys** from your Segment source homepage.
148+
> info ""
149+
> You can find your Source ID by navigating to **Settings > API Keys** from your Segment source homepage.
153150
154151
```json
155152
{

Diff for: src/connections/destinations/catalog/amazon-personalize/index.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -642,10 +642,7 @@ Segment will need to be able to call ("invoke") your Lambda in order to process
642642
To create an IAM policy:
643643
1. Sign in to the [Identity and Access Management (IAM) console](https://console.aws.amazon.com/iam/){:target="_blank"} and follow these instructions to [Create an IAM policy](http://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html){:target="_blank"} to allow Segment permission to invoke your Lambda function.
644644
645-
2. Select **Create Policy from JSON** and use the following template policy in the `Policy Document` field. Be sure to change the `{region}`, `{account-id}` and `{function-names}` with the applicable values. Here's example of a Lambda ARN `arn:aws:lambda:us-west-2:355207333203:function:``my-example-function`.
646-
647-
> note ""
648-
> **NOTE:** You can put in a placeholder ARN for now, as you will need to come back to this step to update with the ARN of your Lambda once that's been created.
645+
2. Select **Create Policy from JSON** and use the following template policy in the `Policy Document` field. Be sure to change the `{region}`, `{account-id}` and `{function-names}` with the applicable values. Here's an example of a Lambda ARN `arn:aws:lambda:us-west-2:355207333203:function:``my-example-function`. You can put in a placeholder ARN for now, as you will need to come back to this step to update with the ARN of your Lambda once that's been created.
649646
650647
```json
651648
{
@@ -679,8 +676,8 @@ To create an IAM role:
679676

680677
6. Copy and paste the following into your trust relationship. You should replace `<your-source-id>` with either the Source ID of the attached Segment source (the default) or the custom external ID you set in your Amazon Lambda destination settings.
681678

682-
> note ""
683-
> **NOTE:** Your Source ID can be found by navigating to **Settings > API Keys** from your Segment source homepage.
679+
> info ""
680+
> You can find your Source ID by navigating to **Settings > API Keys** from your Segment source homepage.
684681
>
685682
> For security purposes, Segment will set your Workspace ID as your External ID. If you are currently using an External ID different from your Workspace ID, reach out to Segment support so they can change it and make your account more secure.
686683

Diff for: src/connections/destinations/catalog/amplitude/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Segment's Amplitude destination code is open source and available on GitHub. You
1515

1616
In addition to Segment's Amplitude documentation, Amplitude provides a [Segment integration guide](https://docs.developers.amplitude.com/data/sources/segment/){:target="_blank"}, as well.
1717

18-
> note ""
18+
> info "Secret key required for GDPR deletions"
1919
> To delete users based on GDPR regulations, you must include a secret key in the **Secret Key** setting of every Amplitude destination. You can find your Secret Key on the [General Settings](https://help.amplitude.com/hc/en-us/articles/235649848-Settings#general){:target="_blank"} of your Amplitude project.
2020
2121

@@ -447,8 +447,8 @@ By default, Segment does **NOT** send Alias events to Amplitude. To forward Alia
447447

448448
Once enabled, Segment forwards Alias events from Segment's servers only. This means that Alias events reach Amplitude only when you're sending events from the client and have set your Amplitude instance's connection mode to "Cloud Mode", or are sending Alias events from a Segment server-side library (such as Node).
449449

450-
> note ""
451-
> To use Alias, you must have the Amplitude Portfolio add-on enabled.
450+
> warning "Alias requires the Amplitude Porfolio add-on"
451+
> To use the Alias method, you must have the [Amplitude Portfolio](https://amplitude.com/docs/admin/account-management/portfolio){:target="_blank"} add-on.
452452
453453
For more information, see the [Segment Spec page for the Alias method](/docs/connections/spec/alias/).
454454

Diff for: src/connections/destinations/catalog/braze/index.md

+8-13
Original file line numberDiff line numberDiff line change
@@ -203,19 +203,14 @@ analytics.track('Purchased Item', {
203203
name: 'bag'
204204
})
205205
```
206-
When you `track` an event, Segment sends that event to Braze as a custom event.
207-
208-
> note ""
209-
> Braze requires that you include a `userId` or `braze_id` for all calls made in cloud-mode. Segment sends a `braze_id` if `userId` is missing. When you use a device-mode connection, Braze automatically tracks anonymous activity using the `braze_id` if a `userId` is missing.
210-
211-
> note ""
212-
> Segment removes the following custom properties reserved by Braze when sending data in Cloud mode:
213-
>
214-
> - `time`
215-
> - `quantity`
216-
> - `event_name`
217-
> - `price`
218-
> - `currency`
206+
When you `track` an event, Segment sends that event to Braze as a custom event. If you're sending Track events in Cloud Mode, Braze requires that you include a `userId` or `braze_id`. Segment sends a `braze_id` if `userId` is missing. When you use a device-mode connection, Braze automatically tracks anonymous activity using the `braze_id` if a `userId` is missing.
207+
208+
Segment removes the following custom properties reserved by Braze when sending data in Cloud mode:
209+
- `time`
210+
- `quantity`
211+
- `event_name`
212+
- `price`
213+
- `currency`
219214
220215
### Order Completed
221216

Diff for: src/connections/destinations/catalog/clevertap/index.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,9 @@ When you send an Alias call to CleverTap, CleverTap updates the user's profile w
4646

4747
## Track
4848

49-
When you `track` an event, Segment sends that event to CleverTap as a custom event. Note that CleverTap does not support arrays or nested objects for custom track event properties.
49+
When you `track` an event, Segment sends that event to CleverTap as a custom event. CleverTap requires Identify traits like `userId` or `email` to record and associate the Track event. Without these traits, the Track event does not appear in CleverTap.
5050

51-
> note ""
52-
> CleverTap requires `identify` traits such as `userId` or `email` to record and associate the Track event. Without these traits, the Track event does not appear in CleverTap.
51+
CleverTap does not support arrays or nested objects for custom Track event properties.
5352

5453
The default logic for the cloud mode connection to CleverTap will lower case and snake_case any event properties passed from Segment's servers to CleverTap. The device mode connection will not lower case or snake_case any event properties passed directly to CleverTap from the client.
5554

Diff for: src/connections/destinations/catalog/courier/index.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,7 @@ analytics.track('Login Button Clicked', {
9494
})
9595
```
9696

97-
> note "Note:"
98-
> Courier does not send notifications until you publish a Notification Template and map incoming Segment Track events to that published Notification Template. If you send data to Courier before you complete those steps, incoming events are marked with a status of `Unmapped`.
97+
Courier does not send notifications until you publish a Notification Template and map incoming Segment Track events to that published Notification Template. If you send data to Courier before you complete those steps, incoming events are marked with a status of `Unmapped`.
9998

10099
### Mapping Inbound Events to Notification Templates
101100

Diff for: src/connections/destinations/catalog/crazy-egg/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Your changes appear in the Segment CDN in about 45 minutes, and then Analytics.j
1919

2020
You can navigate to the [Crazy Egg Dashboard](https://app.crazyegg.com/v2/dashboard){:target="_blank"} to track the data.
2121

22-
> note ""
23-
> **Note**: It may take up to 24-48 hours for initial data to show up.
22+
> success ""
23+
> It may take up to 24-48 hours for Segment data to appear in Crazy Egg.
2424
2525

2626

Diff for: src/connections/destinations/catalog/customer-io/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ You can send computed traits and audiences generated using [Engage](/docs/engage
280280

281281
For user-property destinations, an [identify](/docs/connections/spec/identify/) call sends to the destination for each user that's added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property `order_completed_last_30days: true`. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Engage sets that value to `false`.
282282

283-
> note ""
283+
> success ""
284284
> Customer.io requires you to pass an identifier value (ID or email, depending on your workspace settings), when you sync Audiences or Computed Traits.
285285
286286
When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

0 commit comments

Comments
 (0)