Skip to content

Commit fc4c8f0

Browse files
authored
Merge pull request #5902 from segmentio/develop
Release 24.3.2
2 parents 2c11659 + 60b00e4 commit fc4c8f0

File tree

25 files changed

+385
-161
lines changed

25 files changed

+385
-161
lines changed

src/_data/catalog/beta_sources.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@
2121
- o9OyD6xsVJ
2222
- ODf0vA6dcH
2323
- YWOGVbyMVz
24-
- CwGEZ7eCcA
24+
- CwGEZ7eCcA
25+
- xeZMgSrtAQ

src/_data/catalog/destination_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination categories last updated 2024-01-16
2+
# destination categories last updated 2024-01-18
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

src/_data/catalog/destinations.yml

Lines changed: 118 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2024-01-16
2+
# destination data last updated 2024-01-18
33
items:
44
- id: 637e8d185e2dec264895ea89
55
display_name: 1Flow
@@ -3721,6 +3721,123 @@ items:
37213721
label: API Key
37223722
actions: []
37233723
presets: []
3724+
- id: 659eb601f8f615dac18db564
3725+
display_name: Aggregations.io (Actions)
3726+
name: Aggregations.io (Actions)
3727+
slug: aggregations-io-actions
3728+
hidden: false
3729+
endpoints:
3730+
- US
3731+
regions:
3732+
- us-west-2
3733+
- eu-west-1
3734+
url: connections/destinations/catalog/aggregations-io-actions
3735+
previous_names:
3736+
- Aggregations.io (Actions)
3737+
website: https://aggregations.io
3738+
status: PUBLIC_BETA
3739+
categories:
3740+
- Raw Data
3741+
- Analytics
3742+
logo:
3743+
url: https://cdn-devcenter.segment.com/886284de-022d-434b-8e45-b054964c7479.svg
3744+
mark:
3745+
url: https://cdn-devcenter.segment.com/b106e36f-d5e8-4307-8174-ac3c5ad432f5.svg
3746+
methods:
3747+
track: true
3748+
identify: true
3749+
group: true
3750+
alias: true
3751+
screen: false
3752+
page: true
3753+
platforms:
3754+
browser: true
3755+
mobile: false
3756+
server: true
3757+
warehouse: false
3758+
cloudAppObject: false
3759+
components: []
3760+
browserUnbundlingSupported: false
3761+
browserUnbundlingPublic: false
3762+
replay: false
3763+
connection_modes:
3764+
device:
3765+
web: false
3766+
mobile: false
3767+
server: false
3768+
cloud:
3769+
web: true
3770+
mobile: false
3771+
server: true
3772+
settings:
3773+
- name: api_key
3774+
type: password
3775+
defaultValue: ''
3776+
description: Your Aggregations.io API Key. This key requires Write permissions.
3777+
required: true
3778+
label: API Key
3779+
- name: ingest_id
3780+
type: string
3781+
defaultValue: ''
3782+
description: >-
3783+
The ID of the ingest you want to send data to. This ingest should be set
3784+
up as "Array of JSON Objects". Find your ID on the Aggregations.io
3785+
Organization page.
3786+
required: true
3787+
label: Ingest Id
3788+
actions:
3789+
- id: ibzRWPV7jdx3UvSqhDCWob
3790+
name: Send Events
3791+
slug: send
3792+
description: Send events to Aggregations.io.
3793+
platform: CLOUD
3794+
hidden: false
3795+
defaultTrigger: null
3796+
fields:
3797+
- id: pKS6wAoVMhgMKcGRtRyKPb
3798+
sortOrder: 0
3799+
fieldKey: data
3800+
label: Data
3801+
type: OBJECT
3802+
description: Payload to deliver (JSON-encoded).
3803+
placeholder: ''
3804+
defaultValue:
3805+
'@path': $.
3806+
required: false
3807+
multiple: false
3808+
choices: null
3809+
dynamic: false
3810+
allowNull: false
3811+
- id: bQA4z2u97zSZVXX16WtZvR
3812+
sortOrder: 1
3813+
fieldKey: enable_batching
3814+
label: Enable Batching
3815+
type: BOOLEAN
3816+
description: Enabling sending batches of events to Aggregations.io.
3817+
placeholder: ''
3818+
defaultValue: true
3819+
required: true
3820+
multiple: false
3821+
choices: null
3822+
dynamic: false
3823+
allowNull: false
3824+
- id: rF7Z7KScxWx34TEDnRmpHa
3825+
sortOrder: 2
3826+
fieldKey: batch_size
3827+
label: Batch Size
3828+
type: NUMBER
3829+
description: >-
3830+
Maximum number of events to include in each batch. Actual batch sizes
3831+
may be lower. If you know your events are large, you may want to tune
3832+
your batch size down to meet API requirements.
3833+
placeholder: ''
3834+
defaultValue: 300
3835+
required: false
3836+
multiple: false
3837+
choices: null
3838+
dynamic: false
3839+
allowNull: false
3840+
presets: []
37243841
- id: 5d0ac1fbc12d700001651e34
37253842
display_name: Airship
37263843
name: Airship

src/_data/catalog/destinations_private.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2024-01-16
2+
# destination data last updated 2024-01-18
33
items:
44
- id: 54521fd725e721e32a72eec6
55
display_name: Intercom

src/_data/catalog/source_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# source categories last updated 2024-01-16
2+
# source categories last updated 2024-01-18
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

src/_data/catalog/sources.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# sources last updated 2024-01-16
2+
# sources last updated 2024-01-18
33
items:
44
- id: 8HWbgPTt3k
55
display_name: .NET
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Aggregations.io (Actions) Destination
3+
id: 659eb601f8f615dac18db564
4+
beta: true
5+
---
6+
7+
{% include content/plan-grid.md name="actions" %}
8+
9+
[Aggregations.io](https://aggregations.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} enables you to use your existing analytics events and pipeline for real-time monitoring and alerting.
10+
11+
This destination is maintained by Aggregations.io. For any issues with the destination, [contact their Support team](mailto:[email protected]).
12+
13+
## Getting started
14+
15+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
16+
2. Find the Destinations Actions item in the left navigation, and click it.
17+
3. Click **Configure Aggregations.io (Actions)**.
18+
4. Select an existing Source to connect to Aggregations.io (Actions).
19+
5. In the destination settings, enter your Aggregations.io API Key and Ingest ID. Your ingestion on the Aggregations.io dashboard should be set up using `Array of JSON Objects` and the API Key requires `Write` permission. For more information, see the [Aggregation.io docs](https://aggregations.io/docs/ingesting-data/create-an-ingest){:target="_blank"}.
20+
21+
{% include components/actions-fields.html %}

src/connections/destinations/catalog/actions-klaviyo/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
---
22
title: Klaviyo (Actions) Destination
3-
hide-boilerplate: true
4-
hide-dossier: true
5-
hidden: true
63
id: 650bdf1a62fb34ef0a8058e1
74
beta: true
85
---

src/connections/destinations/catalog/actions-listrak/index.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,18 +42,19 @@ To sync an Engage audience with your Listrak (Actions) destination:
4242
9. In the **Mappings** tab, click **New Mapping** and select **Update Email Contact Profile Fields**.
4343
10. Under **Select events to map and send**, select **Track** for the **Event Type**.
4444
11. Click **Add Condition** and add this condition: **Event Name** is `Audience Entered`.
45-
12. Under **Select mappings**, enter the list ID and map the email address if `context.traits.email` is not desired.
46-
13. Still under **Select mappings**, in the section for mapping the `Profile Field Values`, enter the profile field ID for the `Enter Key Name` textbox on the right and `on` in the textbox for its value to the left. Click **Save**.
47-
14. Repeat steps 9 through 13 using `Audience Exited` instead of `Audience Entered` in step 11 and `off` instead of `on` in step 13.
48-
15. **Enable** both mappings.
49-
16. Go to the **Settings** tab for the destination and **Enable** the destination. Click **Save Changes**.
50-
17. Select the Engage space and navigate to **Engage > Audiences**. Select the source audience to send to the Listrak destination.
51-
18. Click **Add Destination** and select the Listrak Audience destination.
52-
19. In the settings that appear on the right-hand side, toggle the **Send Track** option on and disable **Send Identify**.
53-
20. Click **Save**.
54-
21. To filter email sends in Listrak using the new audience profile field, see this [help article](https://help.listrak.com/en/articles/3951597-introduction-to-building-filter-2-0-segments){:target="_blank”}.
55-
22. If you want to sync another audience, repeat steps 1 through 20.
45+
12. Click **Add Condition** and add this condition: **Event Property** `audience_key` is `my_audience` (where `my_audience` is the Audience Key found on the Audience settings page).
46+
13. Under **Select mappings**, enter the list ID and map the email address if `context.traits.email` is not desired.
47+
14. Under **Select mappings**, in the section for mapping the `Profile Field Values`, enter the profile field ID for the `Enter Key Name` textbox on the right and `on` in the textbox for its value to the left. Click **Save**.
48+
15. Repeat steps 9 through 14 using `Audience Exited` instead of `Audience Entered` in step 11 and `off` instead of `on` in step 14.
49+
16. **Enable** both mappings.
50+
17. Go to the **Settings** tab for the destination and **Enable** the destination. Click **Save Changes**.
51+
18. Select the Engage space and navigate to **Engage > Audiences**. Select the source audience to send to the Listrak destination.
52+
19. Click **Add Destination** and select the Listrak Audience destination.
53+
20. In the settings that appear on the right-hand side, toggle the **Send Track** option on and disable **Send Identify**.
54+
21. Click **Save**.
55+
22. To filter email sends in Listrak using the new audience profile field, see the [help article](https://help.listrak.com/en/articles/3951597-introduction-to-building-filter-2-0-segments){:target="_blank”}.
56+
23. Repeat steps 1 through 21, if you want to sync another audience.
5657

5758
{% include components/actions-fields.html %}
5859

59-
---
60+
---
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Pendo Web (Actions) Destination
3+
id: 6501a4325a8a629197cdd691
4+
hidden: true
5+
beta: true
6+
hide-boilerplate: true
7+
hide-dossier: true
8+
---
9+
10+
{% include content/plan-grid.md name="actions" %}
11+
12+
13+
[Pendo](http://www.pendo.io/){:target="_blank"} combines powerful software usage analytics with in-app guidance and user feedback capabilities, enabling even non-technical teams to deliver better product experiences to their customers or employees.
14+
15+
> success ""
16+
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Pendo Web (Actions) Segment destination. There's also a page about the [non-Actions Pendo destination](/docs/connections/destinations/catalog/pendo/). Both of these destinations receives data from Segment.
17+
18+
## Benefits of Pendo Web (Actions) vs Pendo Classic
19+
20+
Pendo Web (Actions) provides the following benefits over the classic Pendo destination:
21+
22+
- **Support for Track, Identify, and Group calls**. The classic Pendo destination did not support Track calls and required users to configure an additional Webhook destination.
23+
- **Full region support**. Setup allows the destination to be configured for US, EU, US restricted, or Japan.
24+
- **Supports CNAME for Pendo**. Works with subscriptions using Pendo's custom CNAME feature.
25+
26+
## Getting started
27+
28+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
29+
2. Find the Destinations Actions item in the left navigation, and click it.
30+
3. Click **Pendo Web (Actions)**.
31+
4. Click **Add destination ->**.
32+
5. Select an existing Source to connect to Pendo Web (Actions).
33+
6. In the destination settings, enter your Pendo API Key which you can find in the Pendo UI under [Site Settings](https://app.pendo.io/admin){:target="_blank"} > Basic Information > API Key.
34+
7. Select the correct region for your Pendo subscription.
35+
36+
{% include components/actions-fields.html %}
37+
38+
## Migration from the classic Pendo destination
39+
40+
Remove the classic Pendo destination and Webhook destination from your Segment workspace before adding the Pendo Web (Actions) destination.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: 'Aggregations.io (Actions) Destination'
3+
hidden: true
4+
id: 659eb601f8f615dac18db564
5+
published: false
6+
beta: true
7+
---
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Gleap (Actions) Destination
3+
id: 656f2474a919b7e6e4900265
4+
beta: true
5+
---
6+
7+
{% include content/plan-grid.md name="actions" %}
8+
9+
[Gleap](https://gleap.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a customer feedback platform designed for apps and websites. It offers a suite of tools including visual bug reporting, live chat, AI customer support, public roadmaps, marketing automation, and more, aimed at enhancing customer success and product improvement.
10+
11+
12+
This destination is maintained by Gleap. For any issues with the destination, [contact their Support team](mailto:[email protected]).
13+
14+
15+
## Getting started
16+
17+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
18+
2. Find the Destinations Actions item in the left navigation, and click it.
19+
3. Click **Configure Gleap**.
20+
4. Select an existing Source to connect to Gleap (Actions).
21+
5. To use the Gleap destination, obtain an API key by signing up at [app.gleap.io](https://app.gleap.io){:target="_blank”}.
22+
6. Once registered, navigate to **Project > Settings > Security** in the Gleap dashboard.
23+
7. Copy the API key and paste it into the Segment Gleap destination settings.
24+
25+
{% include components/actions-fields.html %}

src/connections/functions/insert-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Segment invokes a separate part of the function (called a "handler") for each ev
5757
The default source code template includes handlers for all event types. You don't need to implement all of them - just use the ones you need, and skip the ones you don't.
5858

5959
> info ""
60-
> Removing the handler for a specific event type results in blocking the events of that type from arriving at their destination.
60+
> Removing the handler for a specific event type results in blocking the events of that type from arriving at their destination. To keep an event type as is but still send it downstream, add a `return event` inside the event type handler statement.
6161
6262
Insert functions can define handlers for each message type in the [Segment spec](/docs/connections/spec/):
6363

src/connections/sources/catalog/cloud-apps/cdpresolution/index.md renamed to src/connections/sources/catalog/cloud-apps/cdp-resolution-enrichment/index.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
---
2-
title: CDP Resolution Source
2+
title: CDP Resolution Enrichment Source
3+
id: HoFsjsDOW2
4+
beta: true
35
hidden: true
46
---
57

68
[CDP Resolution](https://cdpresolution.com?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} helps customers identify their target audience for the purpose of activation, ongoing engagement, and conversion. You can find a [list of the different attributes](https://www.cdpresolution.com/resources/UPID?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} you can collect with CDP Resolution Enrichment.
79

810
This source is maintained by CDP Resolution. For any issues with the destination, [contact the CDP Resolution support team](mailto:[email protected]).
911

10-
How this works: A user is logged into CDP Resolution UI application. They are performing a segmentation operation of identifying their total addressable market and enriching their Segment workspace with data from CDP Resolution.
12+
Here's how it works: When a user logs into the CDP Resolution UI application, they engage in a segmentation operation to identify their total addressable market. Concurrently, they enhance their Segment workspace by incorporating data sourced from CDP Resolution.
1113

1214
## Getting started
1315

@@ -24,4 +26,6 @@ To set up your CDP Resolution Enrichment source:
2426

2527
Further documentation can be found on the [CDP documentation site](https://docs.cdpresolution.com?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"}.
2628

27-
If you configured your CDP Resolution Source correctly, and if you also configured CDP Resolution to send user profile data to a Segment Source, you should start to see user profile data shown in the Segment Source debugger as Identify and Group calls.
29+
## Events
30+
31+
If you've correctly set up your CDP Resolution Source and configured CDP Resolution to transmit user profile data to a Segment source, user profile data will begin to populate in the Segment Source debugger as Identify and Group calls.

src/connections/sources/catalog/libraries/website/javascript/index.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -903,20 +903,23 @@ For more information, visit the [Segment localstorage-retry library](https://git
903903
904904
You can set the `debug` cookie to `analytics.js` to log debug messages from Analytics.js to the console.
905905
906-
## Ad Blocking
907-
Segment doesn't endorse bypassing ad blockers for client-side tracking. Your users have control as to what gets loaded on the page, because they can add a plugin to block third party scripts from loading, which includes Segment. As you can expect some data loss in client-side tracking, there are three routes Segment recommends you to choose from:
906+
## Tracking Blockers and Browser Privacy Settings
908907
909-
1. Honor the decision of the user to implement the ad blocker knowing that unfortunately, some data will be lost.
910-
2. Ask the customer to remove the ad blocker (for example, in the case of large, corporate customers).
911-
3. Move as many events and tracking over to a server-side library as possible, which won't run into the same limitations.
908+
Segment does not endorse bypassing tracking blockers or browser privacy settings for client-side tracking. Your users have control over what gets loaded on their pages and can use plugins or browser settings to block third-party scripts, including Segment. To minimize client-side data loss, Segment recommends you choose from the following routes:
912909
913-
If the above routes don't work, Segment provides these workarounds to help with tracking and to mitigate data loss:
910+
1. Respect the user's decision to implement tracking blockers or use privacy settings, knowing that, unfortunately, some data will be lost.
911+
2. Ask the customer to disable the tracking blockers or adjust their privacy settings (for example, in the case of large, corporate customers).
912+
3. Move as many events and tracking actions as possible to a server-side library, which won't encounter the same limitations.
913+
914+
To minimize client-side data loss, Segment provides a few workarounds. However, it's important to note that Segment cannot guarantee their effectiveness.
914915
915916
* Use the [bundle obfuscation](#bundle-obfuscation) feature. You can add an obfuscate property to the object in the second parameter, which obscures the URL from which your integrations and destination actions are loaded. This helps prevent words that are flagged by ad blockers to not be detected in your URL, enabling the integration to properly load.
916917
917-
* Create a [custom proxy](/docs/connections/sources/catalog/libraries/website/javascript/custom-proxy/). This changes the URL that Segment loads from (cdn.segment.com), as well as the outgoing requests generated when events are triggered (api.segment.io). By setting up proxies for these URLs, some ad blockers won't prevent Segment from loading, which means your events send downstream to your destinations. 
918+
* Create a [custom proxy](/docs/connections/sources/catalog/libraries/website/javascript/custom-proxy/). This changes the URL that Segment loads from (cdn.segment.com) and the outgoing requests generated when events are triggered (api.segment.io).
919+
920+
* Consider implementing the [Segment Edge SDK](https://segment.com/blog/twilio-segment-edge-sdk/){:target="_blank”}. The Segment Edge SDK leverages Cloudflare Workers to facilitate first-party data collection and real-time user profiling for app personalization. It integrates Segment's library into web apps, manages user identity via HttpOnly cookies, and employs an internal router for efficient data processing and user experience customization. This innovative approach simplifies tracking and personalization for Segment customers. More information is available in the [Edge SDK README](https://github.com/segmentio/analytics-edge/blob/main/packages/edge-sdk/README.md){:target="_blank”}.
918921
919-
* Consider tracking data using one of Segment's [server-side libraries](/docs/connections/sources/#server). By using a server-side library, you no longer have to worry about ad blockers and privacy browsers preventing Segment from loading. This option may require more code to track something like a `.page()` call, since now you have to manually pass contextual information that otherwise would've been collected automatically by Analytics.js, such as `url`, `path`, `referrer`. Note that some destinations are device-mode only.
922+
* Consider using one of Segments [server-side libraries](/docs/connections/sources/#server). Using a server-side library eliminates concerns about tracking blockers and privacy browsers that can prevent Segment from loading. This option may require additional code to track actions like a Page call, as you now need to manually pass contextual information that would have been automatically collected by Analytics.js, like `url`, `path`, and `referrer`. Note that some destinations are device-mode only.
920923
921924
## Add destinations from npm
922925

0 commit comments

Comments
 (0)