You must have both read and write workspace permissions to create or make changes to folders.
Destination Info
{% if connectionModes.cloud.web == true or connectionModes.cloud.mobile == true or connectionModes.cloud.server == true %}Components
{% endunless %} -{% unless page.hide-cmodes %} +{% unless page.hide-cmodes or page.engage %}Connection Modes 
|
+ AI Nutrition Facts
+ |
+
|
+ Description
+ |
+
Privacy Ladder Level + 1 + |
+
+ Feature is Optional + Yes + |
+
Model Type + Generative + |
+
Base Model + OpenAI - GPT-4 + |
+
Trust Ingredients + |
+
|
+ Base Model Trained with Customer Data
+ No
+ |
+
Customer Data Shared with Model Vendor
+ No
+ |
+
Training Data Anonymized + N/A + |
+
Data Deletion + Yes + |
+
Human in the Loop + Yes + |
+
Data Retention + N/A + |
+
| Compliance + Logging & Auditing + N/A + Guardrails + N/A + |
+
Input/Output Consistency + Yes + |
+
Other Resources
+ |
+
Limited time opt-out option
+If you need more time to prepare, you can opt out of the update before March 19, 2024.
Note that if you opt out:
+- The existing functions will continue working on Node.js v16.
+- You won't be able to create new functions after July 15, 2024.
+- You won't be able to update existing functions after August 15, 2024.
+- You won't receive future bug fixes, enhancements, and dependency updates to the functions runtime.
+[Contact Segment](https://segment.com/help/contact/){:target="_blank"} to opt-out or with any questions.
Node.js 18
Segment strongly recommends updating to Node.js v18 to benefit from future runtime updates, the latest security, and performance improvements.
+
|
+ AI Nutrition Facts
+ |
+
|
+ Description
+ |
+
Privacy Ladder Level + 1 + |
+
+ Feature is Optional + Yes + |
+
Model Type + Generative + |
+
Base Model + OpenAI - GPT-4 + |
+
Trust Ingredients + |
+
|
+ Base Model Trained with Customer Data + No + |
+
Customer Data is Shared with Model Vendor + No + |
+
Training Data Anonymized + N/A + |
+
Data Deletion + Yes + |
+
Human in the Loop + Yes + |
+
Data Retention + 30 days + |
+
| Compliance + Logging & Auditing + No + Guardrails + Yes + |
+
Input/Output Consistency + No + |
+
Other Resources + |
+
The Segment Public API is available
-Segment's [Public API](/docs/api/public-api) is available to use. You can use the Public API and Config APIs in parallel, but moving forward any API updates will come to the Public API exclusively.
+Segment's [Public API](/docs/api/public-api) is available for Team and Business tier customers to use. You can use the Public API and Config APIs in parallel, but moving forward any API updates will come to the Public API exclusively.
Please contact your account team or [friends@segment.com](mailto:friends@segment.com) with any questions.
| Engage Audiences | -
|---|
| ✅ | -
+
|
+ AI Nutrition Facts
+ |
+
|
+ Description
+ |
+
Privacy Ladder Level + 2 + |
+
+ Feature is Optional + Yes + |
+
Model Type + Predictive + |
+
Base Model + Gradient Boosted Trees + |
+
Trust Ingredients + |
+
|
+ Base Model Trained with Customer Data
+ N/A
+ |
+
Customer Data Shared with Model Vendor
+ No
+ |
+
Training Data Anonymized + No + |
+
Data Deletion + Yes + |
+
Human in the Loop + N/A + |
+
Data Retention + 30 days + |
+
| Compliance + Logging & Auditing + Yes + Guardrails + N/A + |
+
Input/Output Consistency + N/A + |
+
Other Resources
+ |
+
-
-
-{%endif%}
-
-To add the {{thisDestName}} device-mode SDK to a [React Native](/docs/connections/sources/catalog/libraries/mobile/react-native/) project using Segment's `1.5.1≤` release:
-1. Navigate to the root folder of your project, and run a `yarn add @segment/analytics-react-native-{{thisDestName | downcase | replace: " ", "-" }}{% if thisDestRNspecific %}-{{thisDestRNspecific}}{%endif%}` command to add the destination SDK to your project.
-2. Add an `import` statement to your project, as in the example below.
- ```js
- import {{thisDestName | replace: " ", "" }} from '@segment/analytics-react-native-{{thisDestName | downcase | replace: " ", "-" }}{% if thisDestRNspecific %}-{{thisDestRNspecific}}{%endif%}'
- ```
-3. In the same project file, add the destination to the `using` list in the `await` command.
- ```js
- await analytics.setup('YOUR_WRITE_KEY', {
- // Add any of your Device-mode destinations. This ensures they load before continuing.
- using: {{thisDestName | replace: " ", "" }}
- // ...
- })
- ```
-4. Finally, change to your iOS development folder ( `cd ios` ) and run `pod install`.
diff --git a/src/_includes/content/react2-dest.md b/src/_includes/content/react2-dest.md
new file mode 100644
index 0000000000..3b48e4b596
--- /dev/null
+++ b/src/_includes/content/react2-dest.md
@@ -0,0 +1,17 @@
+
+
+{% assign currentSlug = page.url | split: "/" | last %}
+{% assign thisDest = site.data.catalog.destinations.items | where: "slug", currentSlug | first %}
+{% assign thisDestName = thisDest.display_name %}
+{% assign thisDestRNspecific = include.only %}
+
+
+{% if thisDestRNspecific %}
+-The {{thisDestName}} device-mode destination SDK is only available for {{thisDestRNspecific}} in React Native. -
+
+
+{%endif%}
+
+To add the {{thisDestName}} device-mode SDK to a [React Native](/docs/connections/sources/catalog/libraries/mobile/react-native/) project using Segment's new `2.0` release, please reference the [Destination Plugin documentation](/docs/connections/sources/catalog/libraries/mobile/react-native/#supported-destinations).
\ No newline at end of file
diff --git a/src/_includes/content/regional-integrations-table.md b/src/_includes/content/regional-integrations-table.md
index 4bc37dacc7..c0a3806bc0 100644
--- a/src/_includes/content/regional-integrations-table.md
+++ b/src/_includes/content/regional-integrations-table.md
@@ -1,12 +1,10 @@
-{% assign sources = site.data.catalog.regional-supported.sources %}
{% assign destinations = site.data.catalog.destinations.items %}
-{% assign warehouses = site.data.catalog.regional-supported.warehouses %}
+{% assign warehouses = site.data.catalog.warehouse.items | where: "status", "PUBLIC" %}
@@ -21,24 +19,6 @@
- +The {{thisDestName}} device-mode destination SDK is only available for {{thisDestRNspecific}} in React Native. +
{% else %}
{% endif %}{% else %}{% endif %}{% else %}{% endif %}{% else %}{% endif %}{% else %}{% endif %}| Integration | +US Workspace | +EU workspace | +|
|---|---|---|---|
| + Sources | +|||
| {{source.display_name}} | +{% if source.regions contains "us" %}{% else %}{% endif %} |
+ {% if source.regions contains "eu" %}{% else %}{% endif %} |
+ |
+
+
diff --git a/src/_includes/content/retl-discards.md b/src/_includes/content/retl-discards.md
new file mode 100644
index 0000000000..67df31d966
--- /dev/null
+++ b/src/_includes/content/retl-discards.md
@@ -0,0 +1,42 @@
+
+
+The reset method doesn't clear the `userId` from connected client-side integrations. If you want to clear the `userId` from connected client-side destination plugins, you'll need to call the equivalent reset method for that library.
+| Discard reason | +Error code | +What happened? | +Remedy | +
|---|---|---|---|
| Duplicate record detected | +ErrRecordDuplicate | +Duplicate records have been found for the Unique Identifier configured | +Change the Unique Identifier column that has unique values per record or construct a query that returns distinct records for the Unique Identifier configured. | +
| Record with NULL unique ID detected | +ErrRecordNullUniqueID | +While extracting the records, the Unique Identifier column was found to have a null value. | +Make sure to select a Not null column to use as the unique identifier or construct a query that returns not null values for the Unique Identifier configured. | +
| Value for IdentifierColumn is required | +ErrRecordMissingID | +Tried saving the model without the Unique Identifier column; this is a required field | +Select a column to use as the unique identifier for each row and input the column name in the UI | +
| Value for IdentifierColumn must be text | +ErrRecordInvalidID | +The value returned for the Unique Identifier is other than text | +Construct a SQL query to cast the Identifier column to values in text and select the casted column as the Unique Identifier column. If possible, select an Identifier column that is of text data type | +
| Workspace reached the Reverse ETL usage limit | +ErrSegmentNoEntitlement | +Indicates that the workspace had reached the limit of their workspace billing plan | +To increase your usage limit, upgrade your workspace plan. For more information, see the Reverse ETL Usage Limits documentation |
+
Adding {{ integration.name }} to the integrations object
- -To add {{ integration.name }} to theintegrations JSON object (for example, to filter data from a specific source), use one of the {{ integration.previousNames.length }} valid names for this integration:
-{{#each integration.previousNames}}
- {{this}}{{ page.title }}
+ {% include content/support-grid.md %} {%- endif -%} {%- if page.excerpt -%} @@ -116,7 +117,6 @@
{% include sidebar/related-content.html items=page.related %}
{% endif %}
- {% include sidebar/related-categories.html %}
{% unless page.hide-feedback %}
{% include_cached sidebar/feedback.html %}
diff --git a/src/_layouts/page.html b/src/_layouts/page.html
index daee7dfb00..384280ac9a 100644
--- a/src/_layouts/page.html
+++ b/src/_layouts/page.html
@@ -33,10 +33,6 @@
{% include content/plan-grid.md %}
{%- endif -%}
- {%- if page.beta -%}
- {% include content/beta.md %}
- {%- endif -%}
-
{%- unless page.hide_toc -%}
{% include sidebar/mobile-menu-side.html %}
{%- endunless -%}
diff --git a/src/_redirects b/src/_redirects
index 2b01989242..e7f06745e7 100644
--- a/src/_redirects
+++ b/src/_redirects
@@ -9,3 +9,7 @@
/docs/reverse-etl/bigquery-setup/ /docs/connections/reverse-etl/reverse-etl-source-setup-guides/bigquery-setup/
/docs/reverse-etl/redshift-setup/ /docs/connections/reverse-etl/reverse-etl-source-setup-guides/redshift-setup/
/docs/reverse-etl/snowflake-setup/ /docs/connections/reverse-etl/reverse-etl-source-setup-guides/snowflake-setup/
+
+
+# Swift -> Apple
+/docs/connections/sources/catalog/libraries/mobile/swift/* /docs/connections/sources/catalog/libraries/mobile/apple/:splat
\ No newline at end of file
diff --git a/src/_sass/components/_badge.scss b/src/_sass/components/_badge.scss
index d2297a8f7e..db144da826 100644
--- a/src/_sass/components/_badge.scss
+++ b/src/_sass/components/_badge.scss
@@ -23,6 +23,10 @@
background-color: lighten(color(error), 10%);
color: white;
}
+ &--warning {
+ background-color: lighten(color(warning), 40%);
+ color: color(warning-dark);
+ }
&--none {
background-color: white;
diff --git a/src/_sass/components/_breadcrumbs.scss b/src/_sass/components/_breadcrumbs.scss
index 3a64ca55f1..f36c4fb034 100644
--- a/src/_sass/components/_breadcrumbs.scss
+++ b/src/_sass/components/_breadcrumbs.scss
@@ -40,6 +40,7 @@
&__link {
color: color(gray-800);
+ text-transform: capitalize;
&:hover {
color: color(primary);
diff --git a/src/_sass/components/_markdown.scss b/src/_sass/components/_markdown.scss
index 77cad1cbcf..9163332f61 100644
--- a/src/_sass/components/_markdown.scss
+++ b/src/_sass/components/_markdown.scss
@@ -1,11 +1,12 @@
.markdown {
+ counter-reset: list;
+
&>h1,
&>h2,
&>h3,
&>h4,
- &>h5,
- &>h6 {
+ &>h5{
position: relative;
cursor: pointer;
padding-left: 30px;
@@ -71,14 +72,6 @@
}
}
- &>h6 {
- margin-top: 8px;
-
- @include breakpoint(medium up) {
- margin-top: 16px;
- }
- }
-
&>p {
margin-top: 8px;
overflow-wrap: break-word;
@@ -253,6 +246,12 @@
}
}
+ table.horizontal-scroll {
+ display: block;
+ overflow-x: auto;
+ white-space: nowrap;
+ }
+
table.settings {
width: 100%;
table-layout: fixed;
@@ -322,6 +321,18 @@
}
}
+ h2.head-list::before {
+ counter-increment: list;
+ content: counter(list)". ";
+ position: initial;
+ top: 50%;
+ left: initial;
+ opacity: initial;
+ transform: translateY(-50%);
+ pointer-events: none;
+ transition: none;
+ cursor: pointer;
+ }
}
diff --git a/src/_sass/components/_reference-button.scss b/src/_sass/components/_reference-button.scss
index 409aa276b8..e931db413e 100644
--- a/src/_sass/components/_reference-button.scss
+++ b/src/_sass/components/_reference-button.scss
@@ -58,6 +58,20 @@
}
}
+ &__logo {
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ width: 40px;
+ height: 40px;
+ grid-area: icon;
+ margin-right: 25px;
+
+ svg {
+ max-height: 100%;
+ }
+ }
+
&__subtitle {
margin-bottom: 5px;
font-size: 12px;
diff --git a/src/_sass/components/_sample-form.scss b/src/_sass/components/_sample-form.scss
index 0188833e51..482e1d8fc8 100644
--- a/src/_sass/components/_sample-form.scss
+++ b/src/_sass/components/_sample-form.scss
@@ -38,13 +38,30 @@
input {
grid-column: 2 / 3;
+ color: #696f8c;
}
+
select, input {
font-size: 14px;
}
input[type=submit]{
grid-column: 1 / 3;
+ color: #474d66;
}
}
+.error-message {
+ color: red;
+ font-size: 12px;
+ grid-column: 2 / 3;
+ margin-top: 0px;
+ gap: 2px;
+ display: none;
+
+}
+
+.invalid-field {
+ outline: 2px red;
+}
+
diff --git a/src/_sass/components/_sidebar.scss b/src/_sass/components/_sidebar.scss
index e7b946cc3c..d3544ed8d0 100644
--- a/src/_sass/components/_sidebar.scss
+++ b/src/_sass/components/_sidebar.scss
@@ -53,6 +53,7 @@
& > * + * {
margin-top: 20px;
padding-top: 20px;
+ padding-bottom: 20px;
position: relative;
&::before {
diff --git a/src/_sass/elements/_code.scss b/src/_sass/elements/_code.scss
index b665e61124..6d63e8557a 100644
--- a/src/_sass/elements/_code.scss
+++ b/src/_sass/elements/_code.scss
@@ -40,13 +40,13 @@ pre[class*="language-"] {
pre[class*="language-"]::-moz-selection, pre[class*="language-"] ::-moz-selection,
code[class*="language-"]::-moz-selection, code[class*="language-"] ::-moz-selection {
text-shadow: none;
- background: color(gray-100);
+ background: rgb(179,215,264);
}
pre[class*="language-"]::selection, pre[class*="language-"] ::selection,
code[class*="language-"]::selection, code[class*="language-"] ::selection {
text-shadow: none;
- background: color(gray-100);
+ background: rgb(179,215,264);
}
@media print {
diff --git a/src/_sass/objects/_flex.scss b/src/_sass/objects/_flex.scss
index 1a3621848e..58198c0fc1 100644
--- a/src/_sass/objects/_flex.scss
+++ b/src/_sass/objects/_flex.scss
@@ -1,3 +1,5 @@
+@use "sass:math";
+
.flex {
$this: &;
@@ -29,8 +31,8 @@
@for $i from 1 through $flex-columns {
&--#{$i} {
- flex-basis: percentage($i / $flex-columns);
- max-width: percentage($i / $flex-columns);
+ flex-basis: percentage(math.div($i, $flex-columns));
+ max-width: percentage(math.div($i, $flex-columns));
}
}
@@ -42,8 +44,8 @@
@include breakpoint($breakpoint up) {
@for $i from 1 through $flex-columns {
&--#{$i}\@#{$breakpoint} {
- flex-basis: percentage($i / $flex-columns);
- max-width: percentage($i / $flex-columns);
+ flex-basis: percentage(math.div($i, $flex-columns));
+ max-width: percentage(math.div($i, $flex-columns));
}
}
}
diff --git a/src/_sass/objects/_gutter.scss b/src/_sass/objects/_gutter.scss
index b0fce6feb9..0368d4cb45 100644
--- a/src/_sass/objects/_gutter.scss
+++ b/src/_sass/objects/_gutter.scss
@@ -3,23 +3,23 @@
$size: map-get($gutter-sizes, $gutter-size);
- margin-right: -#{$size / 2};
- margin-left: -#{$size / 2};
+ margin-right: -#{$size * 0.5};
+ margin-left: -#{$size * 0.5};
& > * {
- padding-right: $size / 2;
- padding-left: $size / 2;
+ padding-right: $size * 0.5;
+ padding-left: $size * 0.5;
}
@each $name, $size in $gutter-sizes {
@if $name != $gutter-size {
&--#{$name} {
- margin-right: -#{$size / 2};
- margin-left: -#{$size / 2};
+ margin-right: -#{$size * 0.5};
+ margin-left: -#{$size * 0.5};
& > * {
- padding-right: $size / 2;
- padding-left: $size / 2;
+ padding-right: $size * 0.5;
+ padding-left: $size * 0.5;
}
}
}
@@ -29,12 +29,12 @@
@include breakpoint($breakpoint up) {
@each $name, $size in $gutter-sizes {
&--#{$name}\@#{$breakpoint} {
- margin-right: -#{$size / 2};
- margin-left: -#{$size / 2};
+ margin-right: -#{$size * 0.5};
+ margin-left: -#{$size * 0.5};
& > * {
- padding-right: $size / 2;
- padding-left: $size / 2;
+ padding-right: $size * 0.5;
+ padding-left: $size * 0.5;
}
}
}
diff --git a/src/_sass/objects/_waffle.scss b/src/_sass/objects/_waffle.scss
index 21f9246361..04bb116060 100644
--- a/src/_sass/objects/_waffle.scss
+++ b/src/_sass/objects/_waffle.scss
@@ -3,19 +3,19 @@
$size: map-get($waffle-sizes, $waffle-size);
- margin: -#{$size / 2};
+ margin: -#{$size * 0.5};
& > * {
- padding: $size / 2;
+ padding: $size * 0.5;
}
@each $name, $size in $waffle-sizes {
@if $name != $waffle-size {
&--#{$name} {
- margin: -#{$size / 2};
+ margin: -#{$size * 0.5};
& > * {
- padding: $size / 2;
+ padding: $size * 0.5;
}
}
}
@@ -25,10 +25,10 @@
@include breakpoint($breakpoint up) {
@each $name, $size in $waffle-sizes {
&--#{$name}\@#{$breakpoint} {
- margin: -#{$size / 2};
+ margin: -#{$size * 0.5};
& > * {
- padding: $size / 2;
+ padding: $size * 0.5;
}
}
}
diff --git a/src/api/config-api/index.md b/src/api/config-api/index.md
index 984edb8c39..42623261e2 100644
--- a/src/api/config-api/index.md
+++ b/src/api/config-api/index.md
@@ -68,6 +68,9 @@ When you create an access token, you'll give it a description, a workspace, and
> warning "Secret Token"
> You can not retrieve the plain-text `token` later, so you should save it in a secret manager. If you lose the `token` you can generate a new one.
+> info
+> As of February 1, 2024, new Config API tokens cannot be created in the app as Segment moves toward exclusive support for the [Public API](/docs/api/public-api/). [Migrate your implementation to the Public API](https://docs.segmentapis.com/tag/Migration){:target="_blank”} to access the latest features and available endpoints. To create a new Config API token, reach out to friends@segment.com for support.
+
### API Requests
Now that you have an access token, you can use this token to access the rest of the Config API by setting it in the `Authorization` header of your requests, for example:
diff --git a/src/api/public-api/index.md b/src/api/public-api/index.md
index 68f256927a..4e6fc4af27 100644
--- a/src/api/public-api/index.md
+++ b/src/api/public-api/index.md
@@ -13,6 +13,9 @@ All CRUD endpoints in the API follow REST conventions and use standard HTTP meth
description="Research and test the Public API's available endpoints."
%}
+> success "Getting started with the Public API"
+> If your application is built in Javascript / Typescript, Go, Java, or Swift, check out [Segment's Public API SDKs](https://docs.segmentapis.com/tag/Getting-Started#section/Install-and-use-an-SDK){:target="_blank"}.
+
## Config API vs Public API
The Public API includes the following benefits over the Config API:
@@ -24,9 +27,23 @@ The Public API includes the following benefits over the Config API:
| Higher rate limits | The Public API can offer higher rate limits when needed or different rate limits per endpoint or token. |
| Improved architecture | The Public API is built with improved security, checks for authentication, authorization, input validation, HTTPS exposed services, auto-scaling, and more in mind. |
| Cleaner mapping | The Public API uses unique IDs for reference, in place of slugs in the Config API. Unique IDs are, by design, unique. |
-| Available in Europe | The Public API is accessible to both US and EU-based workspaces. |
+| Available in Europe | The Public API is accessible to both US and EU-based workspaces. | |
| Increased reliability | The Public API features more stable endpoints, and a 99.8% success rate |
+## Create a Public API token
+
+> info "Only Workspace Owners can create a Public API token"
+> Only users with the Workspace Owner role can create a Public API token. For more information about roles, see Segment's [Roles](/docs/segment-app/iam/roles/) documentation.
+
+To create a Public API token in your Segment workspace:
+1. Navigate to Settings > Workspace settings > Access Management > Tokens.
+2. Click the **+ Create Token** button.
+3. Create a description for the token and assign it either Workspace Owner or Workspace Member access.
+4. Click **Create**.
+5. Copy your workspace token somewhere secure and click **Done**.
+
+To begin sending requests to the Public API, make sure to include the Public API Token into your HTTP requests with the `Authorization` Header and configured with `Bearer Token` and the value of the newly generated Public API token.
+
## API Token Security
@@ -36,7 +53,7 @@ Within seconds, GitHub scans each commit in public repositories for Public API t
Learn more about [GitHub's secret scanning program](https://docs.github.com/en/developers/overview/secret-scanning-partner-program){:target="_blank"}.
-### Frequently Asked Questions
+## FAQs
#### What should I do if I see a notification that my token was exposed?
In most cases, identifying and revoking an exposed token takes seconds. Segment recommends you check the [audit trail](/docs/segment-app/iam/audit-trail/) to ensure no unauthorized actions were taken with the token.
@@ -49,3 +66,37 @@ By automatically revoking the exposed token, Segment helps keep your workspace s
#### How do I enable this feature?
This feature is automatically enabled for all workspaces on Team or Business tier plans.
+#### What should I do when I see a CORS error?
+If you see a CORS error, this means you're attempting to make a request to the Public API on the front-end. The Public API is used for server-side only. To get rid of the error, move all Public API requests to a server.
+
+#### What User Role / Workspace permissions are required to generate Public API tokens?
+Only [users that have a `Workspace Owner` role](https://segment.com/docs/segment-app/iam/roles/#global-roles) can create Public API Tokens.
+
+## Troubleshooting
+#### The `Update Schema Settings in Source` endpoint returns error for field `forwardingViolationsTo` and `forwardingBlockedEventsTo`
+When you don't have a source to forward violations or blocked events to, then exclude the fields `forwardingViolationsTo` or `forwardingBlockedEventsTo` entirely from the request and the setting will be disabled.
+
+`PATCH` endpoint : `https://api.segmentapis.com/sources/{sourceId}/settings`
+```
+{
+ "group": {
+ "allowTraitsOnViolations": false,
+ "allowUnplannedTraits": false,
+ "commonEventOnViolations": "ALLOW"
+ },
+ "identify": {
+ "allowTraitsOnViolations": true,
+ "allowUnplannedTraits": true,
+ "commonEventOnViolations": "Block"
+ },
+ "track": {
+ "allowEventOnViolations": false,
+ "allowPropertiesOnViolations": false,
+ "allowUnplannedEventProperties": false,
+ "allowUnplannedEvents": false,
+ "commonEventOnViolations": "OMIT_PROPERTIES"
+ }
+ }
+```
+### What is the difference between a destination's Instance ID and Meta ID?
+The destination’s Instance ID is specific to a single destination within your workspace. The destination’s Meta ID, which is returned by the delivery metrics endpoint, identifies which integration you've set up. For example, if you had a `dev` Mixpanel (Actions) destination and a `prod` Mixpanel (Actions) destination, they would have the same Meta ID but two different Instance IDs.
diff --git a/src/api/public-api/query-language.md b/src/api/public-api/query-language.md
new file mode 100644
index 0000000000..73e93ae2c7
--- /dev/null
+++ b/src/api/public-api/query-language.md
@@ -0,0 +1,515 @@
+---
+title: Segment Query Language Reference
+plan: papi
+---
+
+Segment's query language lets you define audience segments and computed traits. With clear syntax and practical functionality, the language simplifies the process of defining conditions and computations, helping you extract valuable insights from customer data.
+
+This reference provides a comprehensive overview of the Segment query language.
+
+> info "Segment's query language in private beta"
+> Segment's query language is in private beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
+
+## Overview
+
+Audience definitions specify the criteria for identifying users or accounts as members of a particular audience, while computed trait definitions outline the logic for aggregating or calculating values stored as traits on user or account level profiles.
+
+With Segment's query language, you can create these definitions and use them with Segment APIs to generate audiences and computed traits.
+
+## Available functions and operators
+
+This section outlines the functions and operators you can use with the query language.
+
+### Syntax
+
+Follow these syntax rules when you create definitions:
+
+- All definitions consist of expressions connected by optional junctions.
+- Expressions are composed of chained functions, starting with an extractor and ending with a result.
+- `.` serves as the delimiter when chaining functions.
+- Audience definitions must return a boolean result (for example, a comparator), while computed trait definitions must return a scalar.
+- Functions have well-defined return types that determine the permissible functions in the call chain.
+- When you use junctions, `AND` holds precedence over `OR`, but parentheses offer control over expression combination.
+- Each definition allows a maximum of 50 primary expressions.
+
+### Syntactic sugar
+
+The language supports the following syntactic sugar adjustments:
+
+- The language automatically wraps a 'literal' extractor function around string or number inputs wherever a scalar expression expects them.
+- You can invoke the boolean comparator functions `equals`, `differs`, `greater_than`, `at_least`, `less_than`, and `at_most` by omitting the period and parenthesis and replacing the function name with the equivalent symbols `=`, `!=`, `>`, `>=`, `<`, and `<=`. Regardless of the syntactic sugar, the comparison still dictates the operations allowed in the call-chain.
+
+### Definition type
+
+The definition type (`USERS` or `ACCOUNTS`) determines whether the computation operates at the user or account level. For account-level audiences, you can apply additional functions `ANY` (to verify that all underlying users meet the defined conditions) and `ALL` (to check if any of the underlying users meet the defined conditions).
+
+These functions use the association between accounts and users to determine audience membership.
+
+## Functions
+
+The following tables list the query languages's available functions.
+
+### Extractors
+
+| `event` | |
+| ----------- | ------------------------------------------------------------------------------- |
+| Syntax | `event({s: String})`
`s` - the name of the event to build an extractor for |
+| Return Type | `VectorExtractor` |
+| Example | `event('Shoes Bought')` |
+
+| `trait` | |
+| ----------- | --------------------------------------------------------------------------------------------------- |
+| Syntax | `trait({s: String})`
`s` - the name of the the trait to reference |
+| Return Type | `ScalarExtractor` |
+| Description | Similar to the event operator, the trait operator is used to specify profile trait filter criteria. |
+| Notes | You can reference other audiences by using the audience key as the trait name. |
+| Example | `trait('total_spend')` |
+
+| `property` | |
+| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Syntax | `property({s: String})`
`s` - the name of the property to build an extractor for
In the context of funnel audiences, you can add a parent prefix to reference the parent event.
`property(parent: {s: String})` |
+| Return Type | `ScalarExtractor` |
+| Notes | Only valid within a `where` function or a Reducer. |
+| Example | `property('total')` |
+
+| `context` | |
+| ----------- | ----------------------------------------------------------------------------------- |
+| Syntax | `context({s: String})`
`s` - the name of the context to build an extractor for |
+| Return Type | `ScalarExtractor` |
+| Notes | Only valid within a `where` function or a Reducer. |
+| Example | `context('page.url')` |
+
+| `literal` | |
+| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Syntax | `literal({a: Any})`
`a` - the value to treat as a literal expression |
+| Operations allowed in call-chain | None allowed; typically used within another function, like a comparison (with syntactic sugar, this would appear on the right side of the comparison). The outer function or comparison dictates the operations allowed in the call-chain. |
+| Example | `literal(100)`
|
+
+
+
+### Filters
+
+| `where` | |
+| ----------- | ------------------------------------------------------------------------------------- |
+| Syntax | `where({e: Comparator})`
`e` - a subexpression terminating in a boolean Comparator |
+| Return Type | `StreamFilter` |
+| Description | Filters the stream to only items where a property satisfies a particular condition. |
+| Notes | The parameter is a sub-expression, something that terminates in a boolean Comparator. |
+| Example | `where({property('price_usd') > 100})` |
+
+| `sources` | |
+| ----------- | ------------------------------------------------------------------------------------- |
+| Syntax | `sources({exclude: {a: Array}})`
`a` - an array of source `ids` to exclude |
+| Return Type | `StreamFilter` |
+| Description | Filters the stream to only items whose source `id` does not match the exclusion list. |
+| Example | `sources({exclude: 'QgRHeujRJBM9j18yChyC', '/;hSBZDqGDPvXCKHbikPm'})` |
+
+| `within` | |
+| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Syntax | `within({d: Integer} {u: TimeUnit})`
`d` - duration value
u - hour (s) day (s)
In the context of funnel audiences, you can add a parent prefix to reference the parent event.
`within(parent: {d: Integer} {u: TimeUnit})` |
+| Return Type | `WindowedFilter` |
+| Description | Provides time windowing so that events are only looked at over a specified number of hours or days into the past. You can add a prefix to direct the evaluation to be relative to the timestamp of a different event. |
+| Example | `within(7 days)` |
+
+| `between` | |
+| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Syntax | `between({s: Integer} {su: TimeUnit}, {e: Integer} {eu: TimeUnit})`
`s` - start value
su - hour (s) day (s)
`e` - end value
eu - hour (s) day (s) |
+| Return Type | `WindowedFilter` |
+| Description | You can add a prefix to direct the evaluation to be relative to the timestamp of a different event. |
+| Example | `between(7 days, 10 days)` |
+
+
+### Reducers
+
+| `count` | |
+| ----------- | ---------------------------------------------------------------- |
+| Syntax | `count()` |
+| Return Type | `Scalar` |
+| Description | Counts the number of entries in a stream and returns the result. |
+| Example | `count()` |
+
+| `sum` | |
+| ----------- | ----------------------------------------------------------- |
+| Syntax | `sum({s: EventPropertyExtractor})`
`s` - property to sum |
+| Return Type | `Scalar` |
+| Example | `sum(property('spend'))` |
+
+| `avg` | |
+| ----------- | --------------------------------------------------------------- |
+| Syntax | `avg({s: EventPropertyExtractor})`
`s` - property to average |
+| Return Type | `Scalar` |
+| Example | `avg(property('spend'))` |
+
+| `max` | |
+| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Syntax | `max({s: EventPropertyExtractor})` or `max({s: EventPropertyExtractor} as type)`
`s` - property to get the maximum value of
`type` - number, string |
+| Return Type | `Scalar` |
+| Notes | If no type is passed, Segment assumes `number` as the `type` and selects the greatest value. You can override the behavior to select the max based on lexicographical ordering by specifying `as string`. |
+| Example | `max(property('spend'))`
`max(property('spend') as string)` |
+
+| `min` | |
+| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Syntax | `min({s: EventPropertyExtractor})` or `min({s: EventPropertyExtractor} as type)`
`s` - property to get the minimum value of
`type` - number, string |
+| Return Type | `Scalar`
+ |
+| Notes | If no type is passed, Segment assumes `number` as the `type` and selects the smallest value. You can override the behavior to select the max based on lexicographical ordering by specifying `as string`. |
+| Example | `min(property('spend'))`
`min(property('spend') as string)` |
+
+| `mode` | |
+| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Syntax | `mode({s: EventPropertyExtractor}, {d: Integer})` or `mode({s: EventPropertyExtractor} as type, {d: Integer})`
`s` - the property to find the most frequent value of
`d` - minimum frequency expected
`type` - number, string, array |
+| Return Type | `Scalar` |
+| Description | Find the most frequent value for a given property name. |
+| Notes | If no type is passed, Segment assumes `string` as the `type` and selects the most frequent value assuming all data is a string. `number` will behave the same as `string`. `array` will also behave the same way, except when used in combination with the `$` operator where instead of treating each individual value within the array separately Segment will instead treat the whole array as a string. |
+| Example | `mode(property('spend'), 2)`
`mode(property('spend') as array, 2)` |
+
+| `first` | |
+| ----------- | ------------------------------------------------------------------------------------------------ |
+| Syntax | `first({s: EventPropertyExtractor})`
`s` - the property to find the first value of |
+| Return Type | `Scalar` |
+| Description | Find the first value for the given property name within the stream of filterable data extracted. |
+| Example | `first(property('spend'))` |
+
+| `last` | |
+| ----------- | ----------------------------------------------------------------------------------------------- |
+| Syntax | `last({s: EventPropertyExtractor})`
`s` - the property to find the last value of |
+| Return Type | `Scalar` |
+| Description | Find the last value for the given property name within the stream of filterable data extracted. |
+| Example | `last(property('spend'))` |
+
+| `unique` | |
+| ----------- | ----------------------------------------------------------------------------------- |
+| Syntax | `unique({s: EventPropertyExtractor})`
`s` - property to get the unique values of |
+| Return Type | `ListScalar` |
+| Description | Generate a unique list of values for the given property name. |
+| Example | `unique(property('spend'))` |
+
+
+### Comparisons
+
+| `equals` | |
+| ----------- | ------------------------------------------------------------ |
+| Syntax | `equals({v: Scalar})`
`v` - value to compare for equality |
+| Return Type | `Comparator` |
+| Example | `equals(500)`
Syntactic Sugar: `== 500` |
+
+| `differs` | |
+| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Syntax | `differs({v: Scalar})`
`v` - value to compare for inequality |
+| Return Type | `Comparator` |
+| Notes | 'differs' only returns true if the value exists and is not equal. If null values need to be considered then use 'NOT (expression) = (value)' or add a condition to check for nulls '(expression) != (value) OR (expression).absent()'. |
+| Example | `differs(500)`
Syntactic Sugar: `!= 500` |
+
+| `absent` | |
+| ----------- | ----------------------------------------------------------------------------- |
+| Syntax | `absent()` |
+| Return Type | `Comparator` |
+| Description | Returns true when a value is null. Equivalent to `NOT (expression).exists()`. |
+| Example | `absent()` |
+
+| `exists` | |
+| ----------- | ----------------------------------------------------------------------------------------------- |
+| Syntax | `exists()` |
+| Return Type | `Comparator` |
+| Description | Returns true when a value is set, meaning not null. Equivalent to `NOT (expression).absent()`. |
+| Example | `exists()` |
+
+| `greater_than` | |
+| -------------- | ----------------------------------------------------- |
+| Syntax | `greater_than({n: Scalar})`
`n` - value to compare |
+| Return Type | `Comparator` |
+| Example | `greater_than(500)`
Syntactic Sugar: `> 500` |
+
+| `at_least` | |
+| -------------- | ------------------------------------------------- |
+| Syntax | `at_least({n: Scalar})`
`n` - value to compare |
+| Return Type | `Comparator` |
+| Example | `at_least(500)`
Syntactic Sugar: `>= 500` |
+
+| `less_than` | |
+| -------------- | ------------------------------------------------ |
+| Syntax | `less_than({n: Scalar})`
n - value to compare |
+| Return Type | `Comparator` |
+| Example | `less_than(500)`
Syntactic Sugar: `< 500` |
+
+| `at_most` | |
+| -------------- | ------------------------------------------------ |
+| Syntax | `at_most({n: Scalar})`
`n` - value to compare |
+| Return Type | `Comparator` |
+| Example | `at_most(500)`
Syntactic Sugar: `<= 500` |
+
+| `contains` | |
+| -------------- | ------------------------------------------------------------------------------------------ |
+| Syntax | `contains({a: Array})`
`a` - array of possible values |
+| Return Type | `Comparator` |
+| Description | Matches when the value contains one of the elements of the parameter array as a substring. |
+| Example | `contains('shoes','shirts')` |
+
+| `omits` | |
+| ----------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| Syntax | `omits({s: String})`
`s` - string to search for if missing in a containing string |
+| Return Type | `Comparator` |
+| Description | Evaluates to true when a substring isn't present in a containing string, equivalent to `NOT (expression).contains()`. |
+| Example | `omits('shoes')` |
+
+| `starts_with` | |
+| ------------- | -------------------------------------------------------------------------------------- |
+| Syntax | `starts_with({s: String})`
`s` - string to search for at start of containing string |
+| Return Type | `Comparator` |
+| Example | `starts_with('total')` |
+
+| `ends_with` | |
+| ----------- | ---------------------------------------------------------------------------------- |
+| Syntax | `ends_with({s: String})`
`s` - string to search for at end of containing string |
+| Return Type | `Comparator` |
+| Example | `ends_with('total')` |
+
+| `one_of` | |
+| ----------- | ---------------------------------------------------------------------------------- |
+| Syntax | `one_of({a: Array})`
`a` - array of possible values |
+| Return Type | `Comparator` |
+| Description | Matches when the value exactly matches one of the values from the parameter array. |
+| Example | `one_of('shoes','shirts')` |
+
+| `before_date` | |
+| ------------- | --------------------------------------------------------- |
+| Syntax | `before_date({t: Timestamp})`
`t` - ISO 8601 timestamp |
+| Return Type | `Comparator` |
+| Example | `before_date('2023-12-07T18:50:00Z')` |
+
+| `after_date` | |
+| ------------ | -------------------------------------------------------- |
+| Syntax | `after_date({t: Timestamp})`
`t` - ISO 8601 timestamp |
+| Return Type | `Comparator` |
+| Example | `after_date('2023-12-07T18:50:00Z')` |
+
+| `within_last` | |
+| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Syntax | `within_last({d: Integer} {u: TimeUnit})`
`d` - duration value
u - hour(s), day(s) |
+| Return Type | `Comparator` |
+| Description | Represents the date range between today and the past `d` days - inclusive where today represents the current date at the time Segment determines audience membership or calculates the trait. |
+| Example | `within_last(7 days)` |
+
+| `within_next` | |
+| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Syntax | `within_next({d: Integer} {u: TimeUnit})`
`d` - duration value
`u` - hour(s), day(s) |
+| Return Type | `Comparator` |
+| Description | Represents the date range between today and the next `d` days - inclusive where today represents the current date at the time Segment determines audience membership or calculates the trait. |
+| Example | `within_next(7 days)` |
+
+| `before_last` | |
+| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Syntax | `before_last({d: Integer} {u: TimeUnit})`
`d` - duration value
u - hour(s), day(s) |
+| Return Type | `Comparator` |
+| Description | Represents the date range between today - `d` days and any past date prior to that - inclusive where today represents the current date at the time Segment determines audience membership or calculates the trait. |
+| Example | `before_last(7 days)` |
+
+| `after_next` | |
+| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Syntax | `after_next({d: Integer} {u: TimeUnit})`
`d` - duration value
u - hour(s), day(s) |
+| Return Type | `Comparator` |
+| Description | Represents the date range between today + `d` days and any future date - inclusive where today represents the current date at the time Segment determines audience membership or calculates the trait. |
+| Example | `after_next(7 days)` |
+
+
+### Junctions
+
+| `AND` | |
+| ----------- | ---------------------------------------------------- |
+| Syntax | `{Comparator} AND {Comparator}` |
+| Base Type | `Junction` |
+| Return Type | `Comparator` |
+| Description | True only if both subexpressions evaluate to `true`. |
+
+| `OR` | |
+| ----------- | ------------------------------------------------- |
+| Syntax | `{Comparator} OR {Comparator}` |
+| Base Type | `Junction` |
+| Return Type | `Comparator` |
+| Description | True if either subexpression evaluates to `true`. |
+
+| `NOT` | |
+| ----------- | ---------------------------------------------------- |
+| Syntax | `NOT ({Comparator})` |
+| Base Type | `Junction` |
+| Return Type | `Comparator` |
+| Description | True only if the subexpression evaluates to `false`. |
+
+| `ANY` | |
+| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Syntax | `ANY ({Comparator})` |
+| Base Type | `Junction` |
+| Return Type | `Comparator` |
+| Description | Used to evaluate an aggregatable boolean expression to determine if any expression is true. Used to specify account-level audience queries that aggregate across user-level queries. |
+
+| `ALL` | |
+| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Syntax | `ALL ({Comparator})` |
+| Base Type | `Junction` |
+| Return Type | `Comparator` |
+| Notes | Used to evaluate an aggregatable boolean expression to determine if every expression is true. Used to specify account-level audience queries that aggregate across user-level queries. |
+
+
+## Return Type
+
+| `Extractor` | |
+|-------------|------------------------|
+| Operations | None included |
+
+| `VectorExtractor` (extends `Extractor`, `StreamFilter`) | |
+| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Base Type | `Extractor`, `StreamFilter` |
+| Operations allowed in call-chain | `where`, `sources`, `within`, `between`, `count`, `sum`, `avg`, `max`, `min`, `mode`, `first`, `last`, `unique` (inherited from `StreamFilter`) |
+| Notes | A `VectorExtractor` represents extractions of data sets that need to be filtered and reduced to a scalar. Adds `isVector` property to entire expression. |
+
+
+| `ScalarExtractor` (extends `Extractor`, `Scalar`) | |
+| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Base Type | `Extractor`, `Scalar` |
+| Operations allowed in call-chain | `equals`, `differs`, `absent`, `exists`, `greater_than`, `at_least`, `less_than`, `at_most`, `contains`, `omits`, `starts_with`, `ends_with`, `one_of`, `before_date`, `after_date`, `within_last`, `before_last`, `after_next` (inherited from `Scalar`) |
+| Notes | A `ScalarExtractor` represents extractions of a single data element, like a field value or a trait value. |
+
+| `EventPropertyExtractor` (extends `Extractor`) | |
+| ---------------------------------------------- | ---------------------------------------------------- |
+| Base Type | `Extractor`, `Scalar` |
+| Operations allowed in call-chain | None |
+| Notes | Used to refer to properties for comparison purposes. |
+
+| `Filter` | |
+| -------------------------------- | ------------- |
+| Operations allowed in call-chain | None included |
+
+| `StreamFilter` (extends `Filter`) | |
+| --------------------------------- | --------------------------------------------------------------------------------------------------------------- |
+| Base Type | `Filter` |
+| Operations allowed in call-chain | `where`, `sources`, `within`, `between`, `count`, `sum`, `avg`, `max`, `min`, `mode`, `first`, `last`, `unique` |
+
+| `WindowedFilter` (extends `StreamFilter`) | |
+| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
+| Base Type | `StreamFilter` |
+| Operations allowed in call-chain | `where`, `sources`, `within`, `between`, `count`, `sum`, `avg`, `max`, `min`, `mode`, `first`, `last`, `unique` |
+
+| `Scalar` | |
+| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Operations allowed in call-chain | `equals`, `differs`, `absent`, `exists`, `greater_than`, `at_least`, `less_than`, `at_most`, `contains`, `omits`, `starts_with`, `ends_with`, `one_of`, `before_date`, `after_date`, `within_last`, `before_last`, `after_next`, `within_next` |
+
+| `ListScalar` | |
+| -------------------------------- | ------- |
+| Operations allowed in call-chain | `count` |
+
+| `Comparator` | |
+| -------------------------------- | ---------------------------------------------------------------------------------- |
+| Base Type | `Comparator` |
+| Operations allowed in call-chain | None allowed; once an expression is terminated with a Comparator, it is completed. |
+
+| `Junction` | |
+| ---------- | --------------------------------------------------- |
+| Base Type | `Junction` |
+| Notes | Preserves any set properties set by subexpressions. |
+
+## Examples
+
+### Audiences
+
+Suppose you wanted to collect all users who performed the `Shoes Bought` event at least once within the last seven days, where the purchase price was greater than or equal to 100.
+
+Another way to think of this scenario would be:
+
+- Collect all users who performed the `Shoes Bought` event.
+- Filter down to only consider events with a price greater than or equal to 100.
+- Filter for events that occurred within the last seven days.
+- Only include users who have one or more of the previous events.
+
+Here's how you could do that in Segment's query language:
+
+```sql
+event('Shoes Bought').where( property('price') >= 100 ).within(7 days).count() >= 1
+```
+
+#### Bought and returned
+
+This example collects:
+
+- all users who performed the `Shoes Bought` event at least once within the last 30 days
+- where the price was greater than or equal to the average spend
+- and the user performed the `Shoes Returned` event at least once, five days after the `Shoes Bought` event
+
+```sql
+event('Shoes Bought').where(
+property('price') >= trait('avg_spend')
+AND
+event('Shoes Returned').within(parent: 5 days).count() >= 1
+).within(30 days).count() >= 1
+```
+
+#### Did not perform `Shoes Bought`
+
+This example collects all users who did not perform the `Shoes Bought` event at least once and don't have a `total_spend` trait with a value greater than `200`:
+
+```sql
+NOT ( event('Shoes Bought').count() >= 1 AND trait('total_spend') > 200 )
+```
+
+#### Bought with minimum total spend
+
+This example collects all accounts where all associated users performed the `Shoes Bought` event at least once and have a `total_spend` trait greater than `200`:
+
+```sql
+ALL ( event('Shoes Bought').count() >= 1 AND trait('total_spend') > 200 )
+```
+
+#### No users bought at least once
+
+This example collects all accounts where no associated users performed the `Shoes Bought` event at least once:
+
+```sql
+ALL NOT event('Shoes Bought').count() >= 1
+```
+
+#### Any users bought at least once
+
+This example collects all accounts where any associated users performed the `Shoes Bought` event at least once:
+
+```sql
+ANY event('Shoes Bought').count() >= 1
+```
+
+### Computed Traits
+
+Suppose you wanted to calculate the average spend based on all `Shoes Bought` events performed within the last 30 days for each user.
+
+Another way to think of this would be:
+
+- Find all `Shoes Bought` events.
+- Filter down to only consider events that occurred within the last 30 days.
+- For these events, calculate the average spend for each user.
+
+Here's how you could do that in Segment's query language:
+
+```sql
+event('Shoes Bought').within(30 days).avg(property('spend'))
+```
+
+#### Calculate minimum spend
+
+This example calculates the minimum spend for each user, based on all `Shoes Bought` events, where the price was greater than `100` and the brand was `My_Brand`:
+
+```sql
+event('Shoes Bought').where( property('price') > 100 AND property('brand') = 'My Brand' ).min(property('spend'))
+```
+
+#### Calculate first seen spend
+
+This example calculates the first-seen spend value for each user, based on all `Shoes Bought` events performed within the last 30 days:
+
+```sql
+event('Shoes Bought').within(30 days).first(property('spend'))
+```
+
+#### Most frequent spend value
+
+This example calculates the most frequent spend value for each user, based on all `Shoes Bought` events performed within the last 30 days. It only considers spend values that have a minimum frequency of `2`:
+
+```sql
+event('Shoes Bought').within(30 days).mode(property('spend'), 2)
+```
diff --git a/src/assets/pdf/faq-segment-dissolution-vat.pdf b/src/assets/pdf/faq-segment-dissolution-vat.pdf
index 546d93ea91..907707752d 100644
Binary files a/src/assets/pdf/faq-segment-dissolution-vat.pdf and b/src/assets/pdf/faq-segment-dissolution-vat.pdf differ
diff --git a/src/connections/alerting.md b/src/connections/alerting.md
new file mode 100644
index 0000000000..c838645131
--- /dev/null
+++ b/src/connections/alerting.md
@@ -0,0 +1,61 @@
+---
+title: Connections Alerting
+beta: true
+---
+
+Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection.
+
+To access Connections Alerting, select an event-streaming connection (like a web library source or cloud mode destination) and click the **Alerts** tab.
+
+On the Alerts tab, you can create alerts and view all active alerts for this connection. You can only edit or delete the alerts that you create.
+
+## Source volume alerts
+
+You can create an alert that notifies you when the volume of events received by your source in the last 24 hours changes beyond a percentage you set. For example, if you set a change percentage of 4% and your source received 100 events over the first 24 hours, Segment would notify you the following day if your source ingested fewer than 96 or more than 104 events.
+
+To receive a source volume alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see the [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.
+
+
+
+To create a source volume alert:
+1. In your workspace, navigate to Connections, select Sources, and select the Event streams tab.
+2. Select the [event streams source](/docs/connections/sources/#event-streams-sources) you'd like to configure alerts for.
+2. Select the Alerts tab and click **Create alert**.
+3. On the Create alert sidesheet, enter a percentage of source volume change that you'd like to be notified for.
+4. Select one or more of the following alert channels:
+ - **Email**: Select this to receive notifications at the provided email address.
+ - **Slack**: Select this to send alerts to one or more channels in your workspace.
+ - **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app.
+5. Click **Save**.
+
+To make changes to a source volume alert, select the icon in the Actions column for the alert and click **Edit**.
+
+To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**.
+
+> info "Deleting alerts created by other users requires Workspace Owner permissions"
+> All users can delete source volume alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
+
+## Successful delivery rate alerts
+
+You can create an alert that notifies you when the volume of events successfully received by your destination in the last 24 hours falls below a percentage you set. For example, if you set a percentage of 99%, Segment notifies you if your destination had a successful delivery rate of 98% or below.
+
+To receive a successful delivery rate alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see the [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.
+
+To create a successful delivery rate alert:
+1. Navigate to the [cloud-mode destinations](/docs/connections/destinations/#:~:text=Cloud%2Dmode%3A%20The%20sources%20send%20data%20directly%20to%20the%20Segment%20servers%2C%20which%20then%20translate%20it%20for%20each%20connected%20downstream%20destination%2C%20and%20send%20it%20on.) you'd like to configure alerts for.
+2. Select the Alerts tab and click **Create alert**.
+3. On the Create alert sidesheet, enter a percentage. You will receive events if your successful delivery rate falls below this percentage.
+4. Select one of the following alert channels:
+ - **Email**: Select this to receive notifications at either the email address associated with your account or another email address that you enter into this field.
+ - **Slack**: Select this and enter a Slack webhook URL and channel name to send alerts to a channel in your Slack workspace.
+ - **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app.
+5. Click **Save**.
+
+To make changes to a successful delivery rate alert, select the icon in the Actions column for the alert and click **Edit**.
+
+To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**.
+
+> info "Deleting alerts created by other users requires Workspace Owner permissions"
+> All users can delete successful delivery alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
+
+Segment generates delivery alerts for failed deliveries and successful deliveries, which are the last two stages of the delivery pipeline. As a result, alerts are based on Segment's attempts to send qualified events to your destination, excluding those filtered out by business rules (like protocols, destination filters, or mappings).
diff --git a/src/connections/auto-instrumentation/configuration.md b/src/connections/auto-instrumentation/configuration.md
new file mode 100644
index 0000000000..b7ed3975c7
--- /dev/null
+++ b/src/connections/auto-instrumentation/configuration.md
@@ -0,0 +1,313 @@
+---
+title: Generate Events from Signals
+hidden: true
+---
+
+This guide is a reference to configuring, generating, and using signals in the Signals SDK with Auto-Instrumentation. On this page, you'll find details on:
+
+- Setting up and managing signal types in the Signals SDK
+- Creating custom rules to capture and translate signals into actionable analytics events
+- Example rules that you can use as a basis for further customization
+
+This guide assumes that you've already added the Signals SDK to your application. If you haven't yet, see the [Auto-Instrumentation Setup](/docs/connections/auto-instrumentation/setup/) guide for initial setup.
+
+> info "Auto-Instrumentation Pilot"
+> Auto-Instrumentation is currently in pilot and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment doesn't recommend Auto-Instrumentation for use in a production environment, as Segment is actively iterating on and improving the user experience.
+
+> success "Enable Auto-Instrumentation"
+> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
+
+## Signals configuration
+
+Using the Signals Configuration object, you can control the destination, frequency, and types of signals that Segment automatically tracks within your application. The following tables detail the configuration options for both Signals-Swift and Signals-Kotlin.
+
+### Signals-Swift
+
+| `Option` | Required | Value | Description |
+| ---------------------- | -------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `writeKey` | Yes | String | Source write key |
+| `maximumBufferSize` | No | Integer | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. |
+| `relayCount` | No | Integer | Relays signals to Segment every Xth event. Default is `20`. |
+| `relayInterval` | No | TimeInterval | Relays signals to segment every X seconds. Default is `60`. |
+| `broadcasters` | No | `SignalBroadcaster` | An array of broadcasters. These objects forward signal data to their destinations, like `WebhookBroadcaster` or `DebugBroadcaster` writing to the developer console. Default is `SegmentBroadcaster`. |
+| `useUIKitAutoSignal` | No | Bool | Tracks UIKit component interactions automatically. Default is `false`. |
+| `useSwiftUIAutoSignal` | No | Bool | Tracks SwiftUI component interactions automatically. Default is `false`. |
+| `useNetworkAutoSignal` | No | Bool | Tracks network events automatically. Default is `false`. |
+| `allowedNetworkHosts` | No | Array | An array of allowed network hosts. |
+| `blockedNetworkHosts` | No | Array | An array of blocked network hosts. |
+
+
+### Signals-Kotlin
+
+| `Option` | Required | Value | Description |
+| ------------------- | -------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `writeKey` | Yes | String | Source write key |
+| `maximumBufferSize` | No | Integer | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. |
+| `broadcastInterval` | No | Integer | Broadcasts signals to Segment every X event. Default is `60`. |
+| `broadcasters` | No | `List` | An array of broadcasters. These objects forward signal data to their destinations, like `WebhookBroadcaster` or `DebugBroadcaster` writing to the developer console. Default is `SegmentBroadcaster`. |
+
+
+## Converting signals to events
+
+After you set up the Signals SDK to capture the signals you want to target, you can create rules in your Segment workspace to translate the captured signals into traditional Segment analytics events. These rules are deployed in your application the next time a user launches your app.
+
+### Getting started with rule creation
+
+1. In your Segment workspace, go to to **Connections > Auto-Instrumentation** and click on a source.
+2. Click **Create Rules**.
+
+### Using the Rules Editor
+
+The Rules Editor is where you define rules that transform raw signal data into analytics events. In the editor, you write functions that convert signals into events and then call them in the `processSignal()` function.
+
+The Rules Editor also lets you test your rules with recent signals to verify that they produce the data you need before you deploy.
+
+The following example tracks all Screen events:
+
+```javascript
+function screenCall(currentSignal) {
+ if (currentSignal.type == SignalType.Navigation && currentSignal.data.action == NavigationAction.Entering) {
+ analytics.screen(currentSignal.data.screen, null, null)
+ }
+}
+
+function processSignal(signal) {
+ screenCall(signal)
+}
+```
+
+## Signal definitions
+
+Signals come in various types, each associated with specific data that you can use to create analytics events. This section contains code samples that detail each signal type. Because Segment has standardized these definitions across both the Signals-Swift and Signals-Kotlin libraries, they're useful when you create rules in your Segment workspace.
+
+### Base signal
+
+The Base Signal serves as the foundation for all other signal types. It's defined by the `RawSignal` interface, where `T` represents the data type associated with the signal.
+
+This interface ensures that every signal inherits essential properties:
+
+```java
+interface RawSignal {
+ var anonymousId: String //
+ var type: SignalType // Specifies the signal category.
+ var timestamp: String // The exact time when the signal was generated.
+ var index: Int // An integer representing the signal's position.
+ var data: T // The specific data of type `T` associated with the signal.
+}
+```
+
+### Signal Types
+
+The Signal Type enum defines the different types of signals the SDK can collect:
+
+```java
+enum SignalType {
+ Interaction, // User interactions like clicks or touches.
+ Navigation, // Navigation events.
+ Network, // Network requests and responses.
+ LocalData, // Data loaded from local or other external sources.
+ Instrumentation, // Events generated from Segment Track/Screen/... events.
+ UserDefined // Custom events defined by the user.
+}
+```
+
+### Interaction signals
+
+The SDK collects Interaction signals when you enable one of the `UIAutoSignal` options, like `useSwiftUIAutoSignal: true`. These signals primarily track user interactions with UI components:
+
+```java
+class InteractionData {
+ var component: String // The type of UI component interacted with, like "Button" or "Image".
+ var title: String? // Optional title of the component, if applicable.
+ var data: Object? // Additional data related to the interaction, if any.
+}
+
+class InteractionSignal extends RawSignal {
+ type = SignalType.UIInteraction // Sets the signal type to UI Interaction.
+}
+```
+
+### Navigation signals
+
+The SDK collects Navigation signals when you enable one of the `UIAutoSignal` options, like `useSwiftUIAutoSignal: true`. These signals are generated when a user interacts with navigation components in your application's UI, giving you insight into how users move through and interact with your application:
+
+```java
+enum NavigationAction {
+ Forward, // Navigation to the next item or page
+ Backward, // Navigation to the previous item or page
+ Modal, // Opening a modal window
+ Entering, // Entering a new screen
+ Leaving, // Leaving a screen
+ Page, // Navigation involving a full page
+ Popup // Interaction with a popup
+}
+
+class NavigationData {
+ var action: NavigationAction // The type of navigation action performed.
+ var screen: String // The screen or component name involved in the navigation.
+}
+
+class NavigationSignal extends RawSignal {
+ type = SignalType.Navigation // Sets the signal type to Navigation.
+}
+```
+
+### Network signals
+
+The SDK collects Network signals when you enable the `useNetworkAutoSignal` option in your Signals Configuration, like `useNetworkAutoSignal: true`. These signals are generated when your application makes network requests:
+
+```java
+enum NetworkAction {
+ Request, // A network request is made.
+ Response // A response is received.
+}
+
+class NetworkData {
+ var action: NetworkAction // The type of network action, either Request or Response.
+ var url: String // The URL involved in the network action.
+ var statusCode: Int? // The HTTP status code of the response, if applicable.
+ var data: Object? // Additional data associated with the network action.
+}
+
+class NetworkSignal extends RawSignal {
+ type = SignalType.Network // Sets the signal type to Network.
+}
+```
+
+### Local Data signals
+
+The SDK collects Local Data Signals when data gets loaded from local soures, like SQLite databases or local caches. These signals help track how your application manages local data:
+
+```java
+enum LocalDataAction {
+ Loaded, // Data was loaded from a local source.
+ Updated, // Existing data was updated.
+ Saved, // New data was saved locally.
+ Deleted, // Data was deleted from a local source.
+ Undefined // Any other unspecified local data action.
+}
+
+class LocalData {
+ var action: LocalDataAction // The type of action performed on the local data.
+ var identifier: String // A unique identifier for the data, like "Loaded User Info".
+ var data: Object? // Additional details or data associated with the action.
+}
+
+class LocalDataSignal extends RawSignal {
+ type = SignalType.LocalData // Sets the signal type to LocalData.
+}
+```
+
+### Instrumentation signals
+
+The SDK collects Instrumentation Signals when [traditional Segment analytics events](/docs/connections/spec/) are invoked:
+
+```java
+enum EventType {
+ Track, //
+ Screen, //
+ Identify, //
+ Group, //
+ Alias, //
+ Unknown // Any other unspecified event type.
+}
+
+class InstrumentationData {
+ type: EventType // The type of Segment event.
+ rawEvent: Object? // Additional details of the event.
+}
+
+class InstrumentationSignal extends RawSignal {
+ type = SignalType.Instrumentation // Sets the signal type to Instrumentation.
+}
+```
+
+### User-defined signals
+
+You can also define your own signals. Use the following example as an implementation guideline:
+
+```java
+interface MyCustomData {
+ var event: String // A custom event description or identifier.
+}
+
+class MyCustomSignal extends RawSignal {
+ type = SignalType.UserDefined // Sets the signal type to User Defined.
+}
+```
+
+## Example rule implementations
+
+You can use the Signals data definitions on this page to create tracking rules.
+
+### Example: Identify users
+
+Building off of the screen tracking example, you could create a rule that identifies users:
+
+```javascript
+function detectIdentify(currentSignal) {
+ var loginType;
+
+ // Check if the signal is related to network activity on a login URL
+ if (currentSignal.type == SignalType.Network && currentSignal.data.url.includes("login")) {
+ loginType = "login";
+ }
+
+ // If a login type was detected, identify the user
+ if (loginType) {
+ var traits = new Object();
+ traits.loggedIn = true; // Set user status to logged in
+ let loginData = currentSignal.data.data.content; // Extract login data from the signal
+ traits.userName = loginData.userName; // Capture the user's name
+
+ if (loginType === "login") {
+ var userId = loginData.userId; // Get userID from login data
+ analytics.identify(userId, traits); // Identify the user with the Identify call
+ }
+ }
+}
+
+//...other functions
+
+function processSignal(signal) {
+ //...other functions
+ detectIdentify(signal); // Process the Identify call based on incoming signals
+}
+```
+
+
+### Example: Track `Add to Cart` events
+
+This rule shows how you could implement the core ordering events from [the e-commerce Spec](/docs/connections/spec/ecommerce/v2/#core-ordering-overview):
+
+```javascript
+function trackAddToCart(currentSignal) {
+ // Check if the signal is an interaction with the "Add To Cart" button
+ if (currentSignal.type == SignalType.Interaction && currentSignal.data.title == "Add To Cart") {
+ var properties = new Object(); // Initialize an object to store event properties
+
+ // Find the network response signal for additional data
+ let network = signals.find(currentSignal, SignalType.Network, (signal) => {
+ return signal.data.action === NetworkAction.Response;
+ });
+
+ if (network) {
+ // Extract and assign product details from the network response
+ properties.price = network.data.data.content.price; // Product price
+ properties.currency = network.data.data.content.currency ?? "USD"; // Currency, defaulting to USD if undefined
+ properties.productId = network.data.data.content.id; // Product ID
+ properties.productName = network.data.data.content.title; // Product name
+ }
+
+ // Track the "Add To Cart" event with the defined properties
+ analytics.track(currentSignal.data.title, properties);
+ }
+}
+
+//...other functions
+
+function ProcessSignals(signal) {
+ //...other functions
+ trackAddToCart(signal); // Process the "Add To Cart" tracking based on incoming signals
+}
+```
diff --git a/src/connections/auto-instrumentation/images/autoinstrumentation_signals.png b/src/connections/auto-instrumentation/images/autoinstrumentation_signals.png
new file mode 100644
index 0000000000..52d290ec73
Binary files /dev/null and b/src/connections/auto-instrumentation/images/autoinstrumentation_signals.png differ
diff --git a/src/connections/auto-instrumentation/index.md b/src/connections/auto-instrumentation/index.md
new file mode 100644
index 0000000000..e90e23bb9e
--- /dev/null
+++ b/src/connections/auto-instrumentation/index.md
@@ -0,0 +1,38 @@
+---
+title: Auto-Instrumentation
+hidden: true
+---
+
+Auto-Instrumentation simplifies tracking in your websites and apps by eliminating the need for a traditional Segment instrumentation.
+
+> info "Auto-Instrumentation Pilot"
+> Auto-Instrumentation is currently in pilot and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment doesn't recommend Auto-Instrumentation for use in a production environment, as Segment is actively iterating on and improving the user experience.
+
+> success "Enable Auto-Instrumentation in your workspace"
+> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
+
+## Background
+
+Gathering actionable and timely data is crucial to the success of your business. However, collecting this data in real time has historically proven to be challenging.
+
+As your business needs change, keeping instrumentation up-to-date across all of your digital properties can be time-consuming, often taking weeks or months. This delay can lead to lost insights, frustration for your marketers and developers, and open-ended support of your Segment instrumentation.
+
+## Auto-Instrumentation as a solution
+
+With just a few lines of code, Auto-Instrumentation handles device tracking for you, helping you focus on collecting the data that's essential to your business and letting your marketers and data analysts gather and update data without relying on engineering teams.
+
+Some Auto-Instrumentation advantages include:
+
+- **JavaScript-based instrumentation logic**: Configure and refine your instrumentation logic entirely within JavaScript, simplifying the development process and reducing dependencies on other environments.
+- **Rapid iteration**: Update your instrumentation logic without the need to constantly release new versions of your mobile app, enabling faster iterations and improvements.
+- **Bypass update delays**: Avoid the typical delays associated with app update cycles and app store approvals. Auto-Instrumentation lets you update your tracking setups or fix errors immediately, ensuring your data collection remains accurate and timely.
+
+## How it works
+
+After you [integrate the Analytics SDK and Signals SDK into your application](/docs/connections/auto-instrumentation/setup/), Segment begins to passively monitor user activity like button clicks, page navigation, and network data. Segment captures these events as "signals" and sends them to your Auto-Instrumentation source in real time.
+
+In Segment, the Auto-Instrumentation source lets you view raw signals. You can then [use this data to create detailed analytics events](/docs/connections/auto-instrumentation/configuration/) based on those signals, enriching your insights into user behavior and applicatino performance.
+
+## Privacy
+
+Auto-Instrumentation removes personally identifiable information (PII) from breadcrumbs before they get sent to Segment. No user data is visible to Segment.
diff --git a/src/connections/auto-instrumentation/setup.md b/src/connections/auto-instrumentation/setup.md
new file mode 100644
index 0000000000..841aefc31a
--- /dev/null
+++ b/src/connections/auto-instrumentation/setup.md
@@ -0,0 +1,148 @@
+---
+title: Auto-Instrumentation Setup
+hidden: true
+---
+
+This guide outlines the steps required to set up the Signals SDK in your applications using Swift or Kotlin.
+
+You'll learn how to add Auto-Instrumentation sources, integrate dependencies, and ensure that your setup captures and processes data as intended.
+
+> info "Auto-Instrumentation Pilot"
+> Auto-Instrumentation is currently in pilot and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment doesn't recommend Auto-Instrumentation for use in a production environment, as Segment is actively iterating on and improving the user experience.
+
+> success "Enable Auto-Instrumentation"
+> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
+
+## Step 1: Add a source and get its write key
+
+You'll first need to add a source and copy its write key:
+
+1. In your Segment workspace, navigate to **Connections > Auto-Instrumentation** and click **Add source**.
+2. Select a source, give the source a name, and click **Save**.
+3. Return to **Connections > Sources** to view your sources.
+4. In the **My sources** table, find and click the new source you just set up.
+5. In the **Initialize the Client** section, look for and copy the `writeKey` displayed in the code block.
+
+## Step 2: Add dependencies and initialization code
+
+Next, you'll need to add the Signals SDKs to your Swift and Kotlin development environments.
+
+### Swift
+
+Follow these steps to integrate the Signals SDK into your Swift application:
+
+1. Use Swift Package Manager to add the Signals SDK from the following repository:
+
+ ```zsh
+ https://github.com/segmentio/Signals-swift.git
+ ```
+
+2. Add the initialization code:
+
+ ```swift
+ // Configure Analytics with your settings
+ {... ....}
+
+ // Set up the Signals SDK configuration
+ let config = Signals.Configuration(
+ writeKey: "", // Replace with the write key you previously copied
+ maximumBufferSize: 100,
+ useSwiftUIAutoSignal: true,
+ useNetworkAutoSignal: true
+ )
+
+ // Locate and set the fallback JavaScript file for edge functions
+ let fallbackURL = Bundle.main.url(forResource: "MyEdgeFunctions", withExtension: "js")
+
+ // Apply the configuration and add the Signals plugin
+ Signals.shared.useConfiguration(config)
+ Analytics.main.add(plugin: LivePlugins(fallbackFileURL: fallbackURL))
+ Analytics.main.add(plugin: Signals.shared)
+ ```
+
+Verify that you replaced `` with the actual write key you copied in Step 1.
+
+#### SwiftUI projects
+
+If your app is written in SwiftUI, you'll need to add a `TypeAlias.swift` file to your project that captures interaction and navigation Signals, like in this example:
+
+```swift
+import Foundation
+import Signals
+
+typealias Button = SignalButton
+typealias NavigationStack = SignalNavigationStack
+typealias NavigationLink = SignalNavigationLink
+typealias TextField = SignalTextField
+typealias SecureField = SignalSecureField
+```
+
+### Kotlin
+
+Follow these steps to integrate the Signals SDK into your Kotlin application:
+
+1. Update your module’s Gradle build file to add the right dependencies:
+
+ ```kotlin
+ dependencies {
+ // Add the Analytics Kotlin library
+ implementation("com.segment.analytics.kotlin:android:1.15.0")
+ // Add a live plugin for real-time data handling
+ implementation("com.segment.analytics.kotlin:analytics-kotlin-live:1.0.0")
+ // Add the core Signals library
+ implementation("com.segment.analytics.kotlin.signals:core:0.0.1")
+ // Compose plugin for Jetpack Compose UI tracking
+ implementation("com.segment.analytics.kotlin.signals:compose:0.0.1")
+ // OkHttp3 plugin for network activity tracking
+ implementation("com.segment.analytics.kotlin.signals:okhttp3:0.0.1")
+ }
+ ```
+
+2. Add the following code to your application to initialize the Signals SDK:
+
+ ```kotlin
+ // Configure Analytics with your settings
+ {... ....}
+
+ // Add live plugins for real-time analytics
+ analytics.add(LivePlugins())
+
+ // Configure and add the Signals plugin
+ Signals.configuration = Configuration(
+ writeKey = "", // Replace with the write key you previously copied
+ maximumBufferSize = 1000,
+ broadcasters = listOf(SegmentBroadcaster(analytics))
+ )
+
+ // Add the Compose plugin for UI events and screen tracking
+ analytics.add(SignalsComposeTrackingPlugin())
+ ```
+
+3. (Optional:) If you want to track network activity, configure your OkHttpClient to use the Signals OkHttp3 plugin:
+
+ ```kotlin
+ private val okHttpClient = OkHttpClient.Builder()
+ .addInterceptor(SignalsOkHttp3TrackingPlugin())
+ .build()
+ ```
+
+4. Build and run your app.
+
+## Step 3: Verify and deploy events
+
+Next, you'll need to verify signal emission and [create rules](/docs/connections/auto-instrumentation/configuration/#example-rule-implementations) to convert those signals into events:
+
+1. In your Segment workspace, return to **Connections > Auto-Instrumentation** and click on the new source you created.
+2. Verify that signals appear as expected on the dashboard.
+
+ 
+
+3. Click **Create Rules**.
+4. In the Rules Editor, add a rule that converts signal data into an event.
+5. Click **Preview**, then click **Save & Deploy**.
+
+Segment displays `Rule updated successfully` to verify that it saved your rule.
+
+## Next steps
+
+This guide walked you through initial Signals SDK/Auto-Instrumentation setup. Next, read the [Auto-Instrumentation Signals Implementation Guide](/docs/connections/auto-instrumentation/configuration/), which dives deeper into Signals and offers examples rules.
diff --git a/src/connections/aws-privatelink.md b/src/connections/aws-privatelink.md
new file mode 100644
index 0000000000..20f5a27eb6
--- /dev/null
+++ b/src/connections/aws-privatelink.md
@@ -0,0 +1,67 @@
+---
+title: Amazon Web Services PrivateLink
+---
+
+[Amazon Web Services' PrivateLink](https://aws.amazon.com/privatelink/){:target="_blank”} is an AWS service that provides private connectivity between VPCs without exposing traffic to the public Internet. Keeping traffic in the Amazon network reduces the data security risk associated with exposing your Warehouse traffic to the Internet.
+
+> info ""
+> Segment's PrivateLink integration is currently in private beta and is governed by Segment’s [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank”}. Only warehouses located in region `us-east-1` are eligible for PrivateLink. You might incur additional networking costs while using AWS PrivateLink.
+
+During the Private Beta, you can set up AWS PrivateLink for [Databricks](#databricks), [RDS Postgres](#rds-postgres), and [Redshift](#redshift).
+
+## Databricks
+
+> info "Segment recommends reviewing the Databricks documentation before attempting AWS PrivateLink setup"
+> The setup required to configure the Databricks PrivateLink integration requires front-end and back-end PrivateLink configuration. Review the [Databricks documentation on AWS PrivateLink](https://docs.databricks.com/en/security/network/classic/privatelink.html){:target="_blank”} to ensure you have everything required to set up this configuration before continuing.
+
+### Prerequisites
+Before you can configure AWS PrivateLink for Databricks, complete the following prerequisites in your Databricks workspace:
+- Databricks account must be on the [Enterprise pricing tier](https://www.databricks.com/product/pricing/platform-addons){:target="_blank”} and use the [E2 version](https://docs.databricks.com/en/archive/aws/end-of-life-legacy-workspaces.html#e2-architecture){:target="_blank”} of the platform.
+- Databricks workspace must use a [Customer-managed VPC](https://docs.databricks.com/en/security/network/classic/customer-managed-vpc.html){:target="_blank”} and [Secure cluster connectivity](https://docs.databricks.com/en/security/network/classic/secure-cluster-connectivity.html){:target="_blank”}.
+ - Configure your [VPC](https://docs.databricks.com/en/security/network/classic/customer-managed-vpc.html){:target="_blank”} with DNS hostnames and DNS resolution
+ - Configure a [security group](https://docs.databricks.com/en/security/network/classic/customer-managed-vpc.html#security-groups){:target="_blank”} with bidirectional access to 0.0.0/0 and ports 443, 3306, 6666, 2443, and 8443-8451.
+
+### Configure PrivateLink for Databricks
+To configure PrivateLink for Databricks:
+1. Follow the instructions in Databricks' [Enable private connectivity using AWS PrivateLink](https://docs.databricks.com/en/security/network/classic/privatelink.html){:target="_blank”} documentation. You must create a [back-end](https://docs.databricks.com/en/security/network/classic/privatelink.html#private-connectivity-overview){:target="_blank”} connection to integrate with Segment's front-end connection.
+2. After you've configured a back-end connection for Databricks, request access to Segment's PrivateLink integration by reaching out to your Customer Success Manager (CSM).
+3. Your CSM sets up a call with Segment R&D to continue the onboarding process.
+
+The following Databricks integrations support PrivateLink:
+ - [Databricks storage destination](/docs/connections/storage/catalog/databricks/)
+ - [Databricks Reverse ETL source](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/databricks-setup/)
+
+## RDS Postgres
+
+### Prerequisites
+Before you can configure AWS PrivateLink for RDS Postgres, complete the following prerequisites in your Databricks workspace:
+- **Set up a Network Load Balancer (NLB) to route traffic to your Postgres database**: Segment recommends creating a NLB that has target group IP address synchronization, using a solution like AWS Lambda.
+- **Configure your NLB with one of the following settings**:
+ - Disable the **Enforce inbound rules on PrivateLink traffic** setting
+ - Add an inbound rule that allows traffic belonging from Segment's `us-east-1` PrivateLink/Edge CIDR: `10.248.64.0/18`
+
+### Configure PrivateLink for RDS Postgres
+1. Create a Network Load Balancer VPC endpoint service using the instructions in the [Create a service powered by AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html){:target="_blank”} documentation.
+2. Reach out to your Customer Success Manager (CSM) for more details about Segment's AWS principal.
+3. Add the Segment AWS principal as an “Allowed Principal” to consume the Network Load Balancer VPC endpoint service you created in step 1.
+4. Reach out to your CSM and provide them with the Service name for the service that you created above. Segment's engineering team provisions a VPC endpoint for the service in the Segment Edge VPC.
+5. After creating the VPC, Segment provides you with private DNS so you can update the **Host** in your Segment app settings or create a new Postgres integration.
The following RDS Postgres integrations support PrivateLink:
+ - [RDS Postgres storage destination](/docs/connections/storage/catalog/postgres/)
+ - [RDS Postgres Reverse ETL source](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/postgres-setup/)
+
+## Redshift
+
+### Prerequisites
+- **You're using the RA3 node type**: To access Segment's PrivateLink integration, use an RA3 instance.
+- **You've enabled cluster relocation**: Cluster relocation migrates your cluster behind a proxy and keeps the cluster endpoint unchanged, even if your cluster needs to be migrated to a new Availability Zone. A consistent cluster endpoint makes it possible for Segment's Edge account and VPC to remain connected to your cluster. To enable cluster relocation, follow the instructions in the AWS [Relocating your cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-recovery.html){:target="_blank”} documentation.
+- **Your cluster is using a port within the ranges 5431-5455 or 8191-8215**: Clusters with cluster relocation enabled [might encounter an error if updated to include a port outside of this range](https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-recovery.html#:~:text=You%20can%20change%20to%20another%20port%20from%20the%20port%20range%20of%205431%2D5455%20or%208191%2D8215.%20(Don%27t%20change%20to%20a%20port%20outside%20the%20ranges.%20It%20results%20in%20an%20error.)){:target="_blank”}.
+
+### Configure PrivateLink for Redshift
+Implement Segment's PrivateLink integration by taking the following steps:
+1. Let your Customer Success Manager (CSM) know that you're interested in PrivateLink. They will share information with you about Segment’s Edge account and VPC.
+2. After you receive the Edge account and VPC, [grant cluster access to Segment's Edge account and VPC](https://docs.aws.amazon.com/redshift/latest/gsg/rs-gsg-connect-to-cluster.html){:target="_blank”}.
+3. Reach back out to your CSM and provide them with the Cluster identifier for your cluster and your AWS account ID.
+4. Segment creates a Redshift managed VPC endpoint within the Segment Redshift subnet on your behalf, which creates a PrivateLink Endpoint URL. Segment then provides you with the internal PrivateLink Endpoint URL.
+5. After Segment provides you with the URL, use it to update or create new Redshift integrations. The following integrations support PrivateLink:
+ - [Redshift storage destination](/docs/connections/storage/catalog/redshift/)
+ - [Redshift Reverse ETL source](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/redshift-setup/)
diff --git a/src/connections/delivery-overview.md b/src/connections/delivery-overview.md
new file mode 100644
index 0000000000..2cd1501545
--- /dev/null
+++ b/src/connections/delivery-overview.md
@@ -0,0 +1,118 @@
+---
+title: Delivery Overview
+---
+
+Delivery Overview is a visual observability tool designed to help Segment users diagnose event delivery issues for any cloud-streaming destination receiving events from cloud-streaming sources.
+
+> info "Delivery Overview for RETL destinations, Storage destinations, and Engage Audience Syncs currently in development"
+> This means that Segment is actively developing Delivery Overview features for RETL destinations, Storage destinations, and Engage Audience syncs. Some functionality may change before Delivery Overview for these integrations becomes generally available.
+>
+> Delivery Overview is generally available for streaming connections (cloud-streaming sources and cloud-streaming destinations).
+> All users of Delivery Overview have access to the Event Delivery tab, and can configure delivery alerts for their destinations.
+
+## Key features
+
+Delivery Overview has three core features:
+- [Pipeline view](#pipeline-view): a visual overview of each step your data takes during the delivery process
+- [Breakdown table](#breakdown-table): contains more detail about the events that were processed at each pipeline step
+- [Discard table](#discard-table): contains details about the events that failed or were filtered out of your process and allows you to inspect samples of them
+
+You can refine these tables using the time picker and the metric toggle, located under the destination header. With the time picker, you can specify a time period (last 10 minutes, 1 hour, 24 hours, 7 days, 2 weeks, or a custom date range over the last two weeks) for which you'd like to see data. With the metric toggle, you can switch between seeing metrics represented as percentages (for example, *85% of events* or *a 133% increase in events*) or as counts (*13 events* or *an increase of 145 events*.) Delivery Overview shows percentages by default.
+
+### Pipeline view
+The pipeline view provides insights into each step your data is processed by enroute to the destination, with an emphasis on the steps where data can be discarded due to errors or your filter preferences. Each step provides details into counts, change rates, and event details (like the associated Event Type or Event Names), and the discard steps (Failed on ingest, Filtered at source, Filtered at destination, & Failed delivery) provide you with the reasons events were dropped before reaching the destination. Discard steps also include how to control or alter that outcome, when possible. The pipeline view also shows a label between the Filtered at destination and Failed delivery steps indicating how many events are currently pending retry.
+
+The pipeline view shows the following steps:
+
+- **Successfully received**: Events that Segment ingested from your source
+- **Failed on ingest**: Events that Segment received, but were dropped due to internal data validation rules
+- **Filtered at source**: Events that were discarded due to schema settings or [Protocols](/docs/protocols/) Tracking Plans
+- **Filtered at destination**: Events that were discarded due to [Destination Filters](/docs/guides/filtering-data/#destination-filters), [filtering in the Integrations object](/docs/guides/filtering-data/#filtering-with-the-integrations-object), [Destination Insert functions](/docs/connections/functions/insert-functions/), or [per source schema integration filters](/docs/guides/filtering-data/#per-source-schema-integrations-filters). [Actions destinations](/docs/connections/destinations/actions/) also have a filtering capability: for example, if your Action is set to only send Identify events, all other event types will be filtered out. Actions destinations with incomplete triggers or disabled mappings are filtered out at this step. [Consent Management](/docs/privacy/consent-management/) users also see events discarded due to consent preferences.
+- **Failed delivery**: Events that have been discarded due to errors or unmet destination requirements
+- **Successful delivery**: Events that were successfully delivered to the destination
+
+Actions destinations also include a mapping dropdown, which allows you to select a [mapping](/docs/connections/destinations/actions/#customize-mappings) to filter the events in the Filtered at destination, Failed delivery and Successful delivery pipeline steps. The following image shows an Actions destination filtered to include only Track Page View events in the last three pipeline steps:
+
+
+
+### Breakdown table
+The breakdown table provides you with greater detail about the selected events.
+
+To open the breakdown table, select either the first step in the pipeline view (Successfully received,) the last step in the pipeline view (Successful delivery,) or select a discard step and then click on a discard reason.
+
+The breakdown table displays the following details:
+- **Event type**: The Segment spec event type (Track call vs. Identify call, for example)
+- **Event name**: The event name, provided by you or the source (*not available for inspection at all steps*)
+- **App version**: The app/release version, provided by you or the source (*not available for inspection at all steps*)
+- **Event count**: How many of each event either successfully made it through this pipeline step (in the case of the first or last steps in the pipeline view) or were filtered out (if you access it from a discard table)
+- **% Change**: Insight into how the event counts differ from the last comparable time range as a percentage1
+
+1: *Segment calculates the related change percentage by subtracting the percent of events impacted in the previous time period from the percent of impacted events in the current time period. For example, if last week 15% of your events were filtered at a source, but this week, 22% of your events were filtered at a source, you would have a related change percentage of 7%.*
+
+### Discard table
+The discard table provides you with greater detail about the events that failed to deliver or were filtered out of your sources and destinations.
+
+To open the discard table, click on one of the discard steps. If you click on a row in the discard table, you can see the breakdown table for the discarded events.
+
+The discard table displays the following details:
+
+- **Discard reason**: Any relevant error code, message, or description associated with the event's failure. When possible, Delivery Overview links to any troubleshooting information you can use to get your events up and running again. Clicking on a discard reason brings you to the [breakdown table](#breakdown-table,) where you can see more detail about discarded events. For more context about discard reasons, see the [Troubleshooting](#troubleshooting) documentation.
+- **Details & Samples**: View up to ten samples over the selected time range. Examine the error message and reason for the error or discard and inspect the payloads involved with the attempted transaction (*not available for inspection at all steps*)
+- **Event count**: How many of each event were discarded in this pipeline step
+- **% Change**: Insight into how the event counts differ from the last comparable time range as a percentage1
+
+1: *Segment calculates the related change percentage by subtracting the percent of events impacted in the previous time period from the percent of impacted events in the current time period. For example, if last week 15% of your events were filtered at a source, but this week, 22% of your events were filtered at a source, you would have a related change percentage of 7%.*
+
+## When should I use Delivery Overview?
+Delivery Overview is useful to diagnose delivery errors in the following scenarios:
+- **When setting up a destination, tracking plan, or filter for the first time**: With Delivery Overview, you can verify that the data you're sending to a new destination, a new tracking plan, or a new filter arrives in your destination as expected.
+- **When data is missing from your destination**: The pipeline view can help you see where your data is getting "stuck" on the way to your destination, which can help you quickly diagnose and address problems in your data pipeline.
+- **When emission or delivery volume fluctuates out of expected norms**: Delivery Overview will highlight where the largest rate change(s) occurred and what events were associated with the change.
+
+> info "Delivery Overview in Engage Destinations"
+> Because Engage uses sources for multiple purposes, you can expect to see `filtered at destination` events with the integrations object in destinations linked to Engage. Engage uses the integrations object to route events to destinations you've added to your audiences, traits, and journey steps. As a result, some events aren't meant to be delivered by the destination, so the integrations object filters them.
+
+## Where do I find Delivery Overview?
+To view the Delivery Overview page:
+1. Sign into Segment.
+2. From the homepage, navigate to **Connection** > **Destinations** and click on the destination you'd like to investigate.
+3. Select the **Delivery Overview** tab from the destination header.
+
+## How do I use Delivery Overview?
+To use Delivery Overview:
+
+1. Navigate to the destination you'd like to review, and select **Delivery Overview** from the destination header.
+2. On the **Delivery Overview** tab, select a time period from the time picker. The time picker reflects data in the user's local time.
___Optional___: *Turn the metric toggle off if you'd like to see the quantity of events as counts instead of percentages. Delivery Overview shows percentages by default.*
+3. Select a success or discard step to view additional context about the events that passed through that step.
+
+## How does Delivery Overview differ from other Segment monitoring and observability tools?
+With Source Debugger or Event Delivery, you can only verify that events are successfully making it from your source or to your destination. If events fail, you have to troubleshoot to see where in the pipeline your events are getting stuck. With Event Tester, you can verify that your event makes it from your source to your destination, but if the results aren't what you expected, you're stuck troubleshooting your source, filters, tracking plans, and destinations.
+
+With Delivery Overview, you can verify that your source receives your events, that any filters and tracking plans work as expected, and that events successfully make it to your destination. Any errors or unexpected behavior can be identified using the pipeline view, leading to quicker resolution.
+
+## How can I configure alerts?
+
+You can use the Event Delivery alerting features (Delivery Alerts) by selecting the **Alerts** tab in the destination header. Once you enable alerts, if the successful delivery rate of all events is less than the threshold percentage in the last 24 hours, you'll be notified through in-app notification and/or workspace email.
+
+Note that this is dependent on your [notification settings](/docs/segment-app/#segment-settings). For example, if the threshold is set to 99%, then you'll be notified each time less than 100% of events fail.
+
+You can also use Connections Alerting, a feature that allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection.
+
+Connections Alerting allows you to create two different alerts:
+- **Source volume alerts**: These alerts notify you if your source ingests an abnormally small or large amount of data. For example, if you set a change percentage of 4%, you would be notified when your source ingests less than 96% or more than 104% of the typical event volume.
+- **Successful delivery rate alerts**: These alerts notify you if your destination's successful delivery rate falls outside of a percentage that you set. For example, if you set a percentage of 99%, you would be notified if you destination had a successful delivery rate of 98% or below.
+
+## How "fresh" is the data in Delivery Overview?
+The data in Delivery Overview has an expected latency of approximately 30 seconds after event ingestion, but this may vary, depending on the features you’ve enabled in your workspace and spikes in volume. Segment delays the data visible in the Delivery Overview UI by 5 minutes to allow for more precise metric correlation. Segment does not impose the 5 minute delay if you access data using the Public API.
+
+## Why is the Delivery Overview page only available for cloud-mode destinations?
+Similar to Segment's [Event Delivery](/docs/connections/event-delivery/) feature, the Delivery Overview page is only available for server-side integrations (also known as cloud-mode destinations). You won't be able to use the Delivery Overview page for client side integrations (also known as device-mode destinations) because device-mode data is sent directly to the destination tool's API. In order to report on deliverability, data must be sent to destinations using a server-side connection.
+
+## Troubleshooting
+
+The Delivery Overview pipeline steps Failed on Ingest, Filtered at Source, Filtered at Destination, and Failed Delivery display a [discard table](#discard-table) with information about why your events failed or were discarded.
+
+This table provides a list of all possible discard reasons available at each pipeline step.
+
+{% include content/delivery-overview-discards.html %}
+
\ No newline at end of file
diff --git a/src/connections/destinations/actions.md b/src/connections/destinations/actions.md
index b77f0a9ef3..6681fb62b6 100644
--- a/src/connections/destinations/actions.md
+++ b/src/connections/destinations/actions.md
@@ -1,18 +1,14 @@
---
title: Destination Actions
+plan: dest-actions
---
-{% include content/plan-grid.md name="dest-actions" %}
-
The Destination Actions framework improves on classic destinations by enabling you to see and control how Segment sends the event data it receives from your sources, to actions-based destinations. Each Action in a destination lists the event data it requires, and the event data that is optional.
You can also choose which event types, event names, or event property values trigger an Action. These Triggers and mappings make it possible to send different versions of the Action, depending on the context from which it is triggered.
Each Actions-framework Destination you see in the Segment catalog represents a feature or capability of the destination which can consume data from your Segment source. The Action clearly lists which data from the events it requires, and which data is optional. For example, Amplitude requires that you always send a `LogEvent` , or Slack always requires a `PostMessage`. Each Action also includes a default mapping which you can modify.
-{% include content/ajs-upgrade.md %}
-
-
## Benefits of Destination Actions
- **Easier setup**: Users see fewer initial settings which can decrease the time spent configuring the destination.
@@ -70,9 +66,6 @@ To set up a new Actions-framework destination for the first time:
## Migrate a classic destination to an actions-based destination
-{% include content/ajs-upgrade.md %}
-
-
Moving from a classic destination to an actions-based destination is a manual process. Segment recommends that you follow the procedure below:
1. Create the actions-based destination with your development or test source.
@@ -82,6 +75,69 @@ Moving from a classic destination to an actions-based destination is a manual pr
5. Verify that data is flowing from the development or test source to the partner tool.
6. Repeat the steps above with your production source.
+### Migrate your destination filters from the classic destination to the actions destination
+
+> warning ""
+> You can only migrate your destination filters using the Public API if you're on the business tier plan. This functionality isn't available in the Segment app.
+
+To migrate your destination filters to your actions destination from the classic destination:
+1. Send a request to the Public API endpoint.
+ - Use [List Filters from Destination](https://docs.segmentapis.com/tag/Destination-Filters#operation/listFiltersFromDestination){:target="_blank"} . The `destinationId` can be found in the URL while viewing the destination in your Segment workspace.
+2. Grab the response and parse through the `data.filters` object. Each object returned inside the `data.filters` object is an individual filter associated with the specified destination.
+4. Send individual `POST` requests to the Public API endpoint.
+ - Use [Create Filter for Destination](https://docs.segmentapis.com/tag/Destination-Filters/#operation/createFilterForDestination){:target="_blank"} , for each of the filters from step 2.
+ - Specify the Actions `destinationId`, found in the URL when viewing that destination. The body of the request is the individual filters from step 2.
+6. If the bodies of those requests don't already include the field `"enabled": true`, make sure to enable each of those filters after you create them.
+
+### Migrate to an actions-based destination using Destination Filters
+For a more comprehensive migration from a classic destination to an actions-based destination, follow the steps outlined below. This implementation strategy is only available for customers on a Segment Business Tier plan with access to [Destination Filters](/docs/connections/destinations/destination-filters/). By adding additional line of defense with Destination Filters, you remove the possibility of duplicate events or dropped events and ensure that events sent before/after a specified `received_at` timestamp are sent to each destination.
+
+This migration strategy involves configuring a destination filter on both the Classic destination and the Actions destination. Configure the classic destination filter to block events by the `received_at` field with a certain value, and the Actions destination to drop events until the `received_at` timestamp field reaches that same value. Destination Filters within the UI have a limitation where they cannot access any top-level fields, but this is not a limitation for [Destination Filters](https://docs.segmentapis.com/tag/Destination-Filters/){:target="_blank”} created by the [Public API](https://segment.com/docs/api/public-api/){:target="_blank”} using [FQL](https://segment.com/docs/api/public-api/fql/){:target="_blank”}. Because the `received_at` is a top-level field in the payload, you'll need to create a destination filter with the Public API and submit the request with that FQL information described below.
+
+By combining these Filters, Segment sends events through the Classic integration up until a specified time and then blocks events after that time. Then the Actions integration blocks events until that specified time, and only allows events beginning at that specified time.
+
+The following code samples show you how you can create filters for your destinations using the [Create Filter for Destination](https://docs.segmentapis.com/tag/Destination-Filters#operation/createFilterForDestination){:target="_blank”} Public API operation.
+
+#### Classic destination
+_Endpoint_: `POST` `https://api.segmentapis.com/destination/classic_destination_id_from_url/filters`
+```
+// JSON BODY :
+{
+ "sourceId": "add_source_id_here",
+ "destinationId": "classic_destination_id_from_url",
+ "title": "drop event after (timestamp) received_at > value April 4, 2023 19:55pm",
+ "description": "drop event after (timestamp) received_at > value April 4, 2023 19:55pm",
+ "if": "(received_at >= '2023-04-21T19:55:00.933Z')",
+ "actions": [
+ {
+ "type":"DROP"
+ }
+ ],
+ "enabled": true
+}
+```
+
+#### Actions destination
+_Endpoint_: `POST` `https://api.segmentapis.com/destination/actions_destination_id_from_url/filters`
+```
+// JSON BODY :
+{
+ "sourceId": "add_source_id_here",
+ "destinationId": "actions_destination_id_from_url",
+ "title": "drop event before (timestamp) received_at < value April 4, 2023 19:55pm",
+ "description": "drop event before (timestamp) received_at < value April 4, 2023 19:55pm",
+ "if": "(received_at < '2023-04-21T19:55:00.933Z')",
+ "actions": [
+ {
+ "type":"DROP"
+ }
+ ],
+ "enabled": true
+}
+```
+
+After configuring the Destination Filter on both the Classic and Actions destination, see each destination's Filters tab and enable the filters. After completing the migration, you can disable the Classic destination on the Settings page, and remove each of the filters from both destinations.
+
## Edit a destination action
You can add or remove, disable and re-enable, and rename individual actions from the Actions tab on the destination's information page in the Segment app. Click an individual action to edit it.
@@ -89,6 +145,8 @@ From the edit screen you can change the action's name and mapping, and toggle it
+When an Action is created, it's disabled by default, to ensure that it's only used after being fully configured. To begin sending data through an Action, enable it on the Actions page by selecting the toggle so that it appears blue.
+
## Disable a destination action
If you find that you need to stop an action from running, but don't want to delete it completely, you can click the action to select it, then click the toggle next to the action's name to disable it. This takes effect within minutes, and disables the action until you reenable it.
@@ -119,11 +177,13 @@ If necessary, click **New Mapping** to create a new, blank action.
1. In the edit panel, define the [conditions](#conditions) under which the action should run.
2. Test those conditions to make sure that they correctly match an expected event.
This step looks for events that match the criteria in the [debugger queue](/docs/connections/sources/debugger/), so you might need to Trigger some events with the expected criteria to test your conditions. You can skip the test step if needed, and re-try it at any time.
-3. Next, set up the data mapping from the Segment format to the destination tool format.
-4. Test the mapping with data from a sample event.
- The edit panel shows you the mapping output in the format for the destination tool. You can change your mapping as needed and re-test.
-5. When you're satisfied with the mapping, click **Save**. Segment returns you to the Mappings table.
-6. In the Mappings table **Status** column, verify that the **Enabled** toggle is on for the mapping you just customized.
+3. Select data models to [enrich your events](/docs/unify/linked-profiles/linked-events/) with.
+4. Set up the data mapping from the Segment format to the destination tool format.
+- You can click the Source field, then select the **Enrichments** tab to view and select Enrichments to use.
+5. Test the mapping with data from a sample event.
+ The edit panel shows you the mapping output in the format for the destination tool. The **Select Object** option sends the entire object from the event, while the **Edit Object** option lets you map each individual property. You can change your mapping as needed and re-test.
+6. When you're satisfied with the mapping, click **Save**. Segment returns you to the Mappings table.
+7. In the Mappings table **Status** column, verify that the **Enabled** toggle is on for the mapping you just customized.
> info ""
@@ -133,7 +193,9 @@ If necessary, click **New Mapping** to create a new, blank action.
The coalesce function takes a primary value and uses it if it is available. If the value isn't available, the function uses the fallback value instead.
+### Replace function
+The replace function allows you to replace a string, integer, or boolean with a new value. You have the option to replace up to two values within a single field.
### Conditions
@@ -141,7 +203,7 @@ The coalesce function takes a primary value and uses it if it is available. If t
> Self-service users can add a maximum of two conditions per Trigger.
-The following type filters and operators are available to help you build conditions:
+Mapping fields are case-sensitive. The following type filters and operators are available to help you build conditions:
- **Event type** (`is`/`is not`). This allows you to filter by the [event types in the Segment Spec](/docs/connections/spec).
- **Event name** (`is`, `is not`, `contains`, `does not contain`, `starts with`, `ends with`). Use these filters to find events that match a specific name, regardless of the event type.
@@ -150,6 +212,10 @@ The following type filters and operators are available to help you build conditi
You can specify nested properties using dot notation, for example `context.app.name`. If the property might appear in more than one format or location, you can use an ANY statement and add conditions for each of those formats. For example, you might filter for both `context.device.type = ios` as well as `context.os.name = "iPhone OS``"`
The `does` `not exist` operator matches both a `null` value or a missing property.
{% comment %}
+
+> info "Valid property and trait values"
+> Property and trait names must begin with the characters: [a-z], [A-Z] or '_'. Property and trait names don't support special characters in the first character. If you save a property or trait with a special character in the first character, you'll get an Invalid Trigger error.
+
> info "Event property operators and supported data types"
> Operators support matching on values with a **string** data type:
> - `is`, `is not`, `contains`, `does not contain`, `starts with`, `ends with`
@@ -172,7 +238,10 @@ The available operators depend on the property's data type:
You can combine criteria in a single group using **ALL** or **ANY**. Use an ANY to “subscribe” to multiple conditions. Use ALL when you need to filter for very specific conditions. You can only create one group condition per destination action. You cannot created nested conditions.
> info "Unsupported Special Characters"
-> Mappings do not support the use of double quotes " or a tilde ~ in the trigger fields.
+> Mappings do not support the use of double quotes " or a tilde ~ in the trigger fields. In mapping fields, the . character is not supported unless it's being used to access an object key. If a string has a . in it, that is not supported.
+
+> info "Limitations"
+> Mapping fields don't support dot notation. For example, properties.amount.cost or properties_amount.cost aren't supported.
> info "Destination Filters"
> Destination filters are compatible with Destination Actions. Consider a Destination Filter when:
@@ -181,12 +250,33 @@ You can combine criteria in a single group using **ALL** or **ANY**. Use an ANY
>
> If your use case does not match these criteria, you might benefit from using Mapping-level Triggers to match only certain events.
-## FAQ & Troubleshooting
+## FAQ and troubleshooting
### Validation error when using the Event Tester
When you send an event with an actions destination Event Tester that doesn't match the trigger of any configured and enabled mappings, you'll see an error message that states, *You may not have any subscriptions that match this event.* To resolve the error, create a mapping with a trigger to handle the event being tested, or update the test event's payload to match the trigger of any existing mappings.
+### Data not sending downstream
+
+If no mappings are enabled to trigger on an event that has been received from the connected source, the destination will not send any events. Ensure that at least one mapping has been configured and enabled in the destination mappings for an event that you would like to reach downstream.
+
+> info ""
+> Events without mappings enabled to handle them display as being discarded due to "No matching mapping" in a destination's Delivery Overview.
+
### Multiple mappings triggered by the same event
When the same event triggers multiple mappings, a request will be generated for each mapping that's configured to trigger on an event. For example, for the *Subscription Updated* event, if two mappings are enabled and both have conditions defined to trigger on the *Subscription Updated* event, the two requests will be generated and sent to the destination for each *Subscription Updated* event.
+
+### Oauth "access token expired" message shown in Segment UI
+Access Tokens that were generated from initial authorization, for example, when you connect a destination via Oauth, are always short-lived. Commonly, the token remains valid for 30 minutes to 1 hour. When Segment receives 401 error responses from the destination after a token has expired, it will automatically make another request to the destination for a new token and will then retry the event. Therefore, 401 responses are sometimes expected and do not indicate an event failure. There are three event flows when events are received and sent to a destination:
+
+- through source
+- through event tester
+- through actions tester in mapping screen
+
+The underlying systems for these flows have their own copy of the token, which can expire at different points in time.
+Threfore, if you see a 401 error in a sample response, it is likely that you’ll also see another request was made after it, to ask the downstream destination for a new token. Then one more request was made to actually send the data in your payload to the downstream destination.
+
+### Is it possible to map a field from one event to another?
+
+Segment integrations process events through mappings individially. This means that no context is held that would allow you to map a value from one event to the field of a subsequent event. Each event itself must contain all of the data you'd like to send downstream in regards to it. For example, you cannot send `email` in on an Identify call and then access that same `email` field on a Track call that comes in later if that Track call doesn't also have `email` set on it.
diff --git a/src/connections/destinations/add-destination.md b/src/connections/destinations/add-destination.md
index f38593aaa2..a28a475d20 100644
--- a/src/connections/destinations/add-destination.md
+++ b/src/connections/destinations/add-destination.md
@@ -2,13 +2,17 @@
title: Sending Segment Data to Destinations
---
-You've decided how to format your data, and collected it using [Segment Sources](/docs/connections/sources/). Now what do you do with it? You send the data to Destinations!
+You've decided how to format your data, and collected it using [Segment Sources](/docs/connections/sources/). Now what do you do with it? You send the data to Destinations.
Destinations are tools or services which can use the data sent from Segment to power analytics, marketing, customer outreach, and more.
> info ""
-> Each Segment Workspace has its own set of destinations, which are connected to the workspace's sources. When you add or modify a destination, make sure you're working with the correct workspace!
+> Each Segment Workspace has its own set of destinations, which are connected to the workspace's sources. When you add or modify a destination, make sure you're working with the correct workspace.
+> info "Healthcare and Life Sciences (HLS) customers can encrypt data flowing into their destinations"
+> HLS customers with a HIPAA eligible workspace can encrypt data in fields marked as Yellow in the Privacy Portal before they flow into an event stream, cloud-mode destination.
+>
+> To learn more about data encryption, see the [HIPAA Eligible Segment documentation](/docs/privacy/hipaa-eligible-segment/#data-encryption).
## Adding a destination
@@ -31,7 +35,7 @@ There are two ways to add a destination to your deployment: using the Segment we
8. Click the toggle at the top of the Settings page to enable the destination.
> success ""
-> If you have more than one instance of the same destination, you can click **Copy Settings From Other Destination** to save yourself time entering the settings values.
+> If you have more than one instance of the same destination, you can click **Copy Settings From Other Destination** to save yourself time entering the settings values manually.
#### Adding a destination to a specific Segment Source
@@ -58,7 +62,7 @@ You can use the Segment Public API to add destinations to your workspace using t
Adding a destination can have a few different effects, depending on which sources you set up to collect your data, and how you configured them.
-#### Analytics.js
+### Analytics.js
If you are using [Segment's JavaScript library, Analytics.js](/docs/connections/sources/catalog/libraries/website/javascript/), then Segment handles any configuration changes you need for you. If you're using Analytics.js in cloud-mode, the library sends its tracking data to the Segment servers, which route it to your destinations. When you change which destinations you send data to, the Segment servers automatically add that destination to the distribution list.
@@ -66,13 +70,13 @@ If you're using Analytics.js in device-mode, then Analytics.js serves as a wrapp
You can enable device-mode for some destinations from the destination's Settings page in the Segment web app. You don't need to use the same mode for all destinations in a workspace; some can use device-mode, and some can use cloud-mode.
-#### Mobile sources
+### Mobile sources
By default, Segment's [mobile sources](/docs/connections/sources/catalog/#mobile) send data to Segment in cloud-mode to help minimize the size of your apps. In cloud-mode the mobile source libraries forward the tracking data to the Segment servers, which route the data to the destinations. Since the Segment servers know which destinations you're using, you don't need to take any action to add destinations to mobile apps using cloud-mode.
However, if the destination you're adding has features that run on the user's device, you might need to update the app to package that destination's SDK with the library. Some destinations require that you package the SDK, and some only offer it
-#### Server sources
+### Server sources
Segment's [server sources](/docs/connections/sources/catalog/#server) run on your internal app code, and never have access to the user's device. They run in cloud-mode only, and forward their tracking calls to the Segment servers, which forward the data to any destinations you enabled.
@@ -98,6 +102,19 @@ For example, you might set up a single Segment source to send data both to separ
You can also connect multiple instances of a destination to help you smoothly migrate from one configuration to another. By sending each version the same data, you can check and validate the new configuration without interrupting use of the old one.
+However, there are a few considerations:
+
+Device-mode destinations do not support connecting multiple instances of the destination to the same source. If you try to a connect an additional instance of a device-mode destination to your source, the option to add a second instance does not appear.
+
+Mobile sources, and the legacy Project source, can connect to multiple instances of destinations that operate only in cloud-mode. Mobile and Project sources cannot connect to multiple instances of destinations that operate in both cloud-mode and device-mode. Non-mobile sources can only connect to _one_ device-mode instance of a destination.
+
+Multi-instance support is not available for most hybrid Actions destinations or Web mode Actions destinations.
+
+Segment does not support connecting a single source to multiple instances of a [Data Lakes](/docs/connections/storage/data-lakes/) destination.
+
+> warning "Non-mobile sources can only connect to _one_ device-mode instance of a destination"
+> You cannot connect a source to more than one instance of a destination that operates only in device-mode. For more information about device-mode restrictions, see the [Sending Segment data to Destinations](/docs/connections/destinations/add-destination/#connecting-one-source-to-multiple-instances-of-a-destination:~:text=Multi%2Dinstance%20destinations-,and,-Device%2Dmode) documentation.
+
> success ""
> If your organization is on a Segment Business tier plan, you can use [Replay](/docs/guides/what-is-replay/) to send historical data to new instances of a destination.
@@ -114,6 +131,8 @@ Some destinations do not support having multiple instances connected to the same
You can create unique destination filters for each destination instance connected to the same source.
+> info ""
+> Some destinations don't support multiple instances connected to the same source. If this is the case, you won't see the option to add a second instance of that destination.
### Connect multiple sources to one instance of a destination
diff --git a/src/connections/destinations/catalog/1flow-analytics/index.md b/src/connections/destinations/catalog/1flow-analytics/index.md
index e108e006db..a48bc5ee5e 100644
--- a/src/connections/destinations/catalog/1flow-analytics/index.md
+++ b/src/connections/destinations/catalog/1flow-analytics/index.md
@@ -5,7 +5,7 @@ hidden: true
published: false
---
-[1Flow](https://1flow.app/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses.
+[1Flow](https://1flow.app/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses.
Using 1Flow, you can reach users _in-the-moment_ while they are interacting with your website or application, to collect highly contextual user insights that help you improve your product offering and customer experience.
@@ -17,7 +17,7 @@ This destination is maintained by 1Flow. For any issues with the destination, [c
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2. Search for **1Flow** in the Destinations Catalog, and select the **1Flow** destination.
3. Choose which Source should send data to the 1Flow destination.
-4. Go to the [1Flow dashboard](https://dashboard.1flow.app/){:target="\_blank"} and find the **API Key** in Project Settings.
+4. Go to the [1Flow dashboard](https://dashboard.1flow.app/){:target="_blank"} and find the **API Key** in Project Settings.
5. Enter the **API Key** in the 1Flow destination settings in Segment.
## Supported methods
diff --git a/src/connections/destinations/catalog/1flow-mobile-plugin/index.md b/src/connections/destinations/catalog/1flow-mobile-plugin/index.md
new file mode 100644
index 0000000000..3d5f58188a
--- /dev/null
+++ b/src/connections/destinations/catalog/1flow-mobile-plugin/index.md
@@ -0,0 +1,133 @@
+---
+title: 1Flow Mobile Plugin Destination
+id: 64dd07c1fed86b6866cd93f5
+beta: true
+---
+
+[1Flow](https://1flow.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses.
+
+Using 1Flow, you can reach users _in-the-moment_ while they are interacting with your website or application, to collect highly contextual user insights that help you improve your product offering and customer experience
+
+The 1Flow Mobile Plugin Destination is open-source and available on GitHub. You can view these repositories here:
+
+- [iOS](https://github.com/1Flow-Inc/segment-1flow-ios.git){:target="_blank"}
+- [Android](https://github.com/1Flow-Inc/segment-1flow-android.git){:target="_blank"}
+
+This destination is maintained by 1Flow. For any issues with the destination, [contact Support team](mailto:support@1flow.app).
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then search for **1Flow Mobile Plugin**.
+2. Click **Add Destination**.
+4. Select an existing Source to connect to 1Flow Mobile Plugin.
+5. Go to 1flow.ai -> Settings -> Project Settings, copy the 1Flow project key, and paste it into the Destination Settings in Segment.
+6. Depending on the mobile source you’ve selected, include 1Flow's library by adding the following lines to your dependency configuration.
+
+## iOS
+
+### Step 1: Add Segment1Flow Package using Swift Package Manager
+
+In the Xcode File menu, click Add Packages. You'll see a dialog where you can search for Swift packages. In the search field, enter the URL to this repo.
+
+- `https://github.com/1Flow-Inc/segment-1flow-ios`
+
+You'll then have the option to pin to a version, or specific branch, as well as which project in your workspace to add it to. Once you've made your selections, click the Add Package button.
+
+### Step 2: Initialize Segment and add 1Fow Destination
+
+```
+import Segment1Flow
+...
+let config = Configuration(writeKey: "YOUR_WRITE_KEY_HERE")
+let analytics = Analytics(configuration: config)
+analytics.add(plugin: OneFlowDestination())
+```
+
+## Android
+
+### Step 1: Install Segment1Flow Package
+
+- If gradle version is 6.5 or lower, include the below repository in your project's build.gradle file:
+
+```
+allprojects{
+ repositories{
+ google()
+ jcenter()
+ maven{url 'https://jitpack.io'}
+ }
+}
+```
+
+- If gradle version is higher than 6.5, add the below code in settings.gradle.
+
+```
+dependencyResolutionManagement {
+ repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+ repositories {
+ google()
+ mavenCentral()
+ maven{url 'https://jitpack.io'}
+ }
+}
+```
+
+- Add dependency in your app's build.gradle file:
+
+```
+compileSdkVersion 34
+....
+defaultConfig {
+ ....
+ minSdkVersion 21
+ }
+dependencies {
+ ....
+
+ implementation 'com.segment.analytics.android:analytics:4.11.3'
+ implementation "com.github.1Flow-Inc:segment-1flow-android:2023.09.26"
+}
+```
+
+### Step 2: Initialize Segment and add 1Flow Destination
+```
+Analytics analytics = new Analytics.Builder(context, "YOUR_WRITE_KEY_HERE")
+ .use(OneFlowIntegration.FACTORY)
+ ...
+ .build();
+ ...
+ Analytics.setSingletonInstance(analytics);
+
+```
+
+## Supported methods
+
+### Identify
+If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
+
+```swift
+analytics.identify(userId: "peter@example.com", traits: [
+ "name": "Peter Gibbons",
+ "email": "peter@example.com",
+ "mobile": 1234567890
+])
+```
+When you call identify method of segment, it will be equivalent to `logUser` of 1Flow. `userId` will be `userID` and `traits` will be `userDetails`.
+
+### Track
+If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
+
+```swift
+analytics.track(name: "ButtonClicked")
+```
+Any value passed in `name`, will be eventName and if you have passed any event property, then it will be event `parameters`.
+
+### Screen
+
+Send [Screen](/docs/connections/spec/screen) calls to record which mobile app screens users have viewed. For example:
+
+```swift
+analytics.screen(title: "Home")
+```
+
+Segment sends Screen calls to 1Flow as a `screen_[name]` event (or `screen_view` if a screen name isn't provided).
diff --git a/src/connections/destinations/catalog/1flow-web-actions/index.md b/src/connections/destinations/catalog/1flow-web-actions/index.md
new file mode 100644
index 0000000000..3d8000dd5e
--- /dev/null
+++ b/src/connections/destinations/catalog/1flow-web-actions/index.md
@@ -0,0 +1,7 @@
+---
+title: '1Flow Web (Actions) Destination'
+hidden: true
+id: 656773f0bd79a3676ab2733d
+published: false
+beta: true
+---
diff --git a/src/connections/destinations/catalog/1flow/index.md b/src/connections/destinations/catalog/1flow/index.md
index 9c132ec9ad..508e5bfd85 100644
--- a/src/connections/destinations/catalog/1flow/index.md
+++ b/src/connections/destinations/catalog/1flow/index.md
@@ -5,7 +5,7 @@ redirect_from:
- '/connections/destinations/catalog/1flow-analytics'
---
-[1Flow](https://1flow.app/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses.
+[1Flow](https://1flow.app/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses.
Using 1Flow, you can reach users _in-the-moment_ while they are interacting with your website or application, to collect highly contextual user insights that help you improve your product offering and customer experience.
@@ -16,7 +16,7 @@ This destination is maintained by 1Flow. For any issues with the destination, [c
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2. Search for **1Flow** in the Destinations Catalog, and select the **1Flow** destination.
3. Choose which Source should send data to the 1Flow destination.
-4. Go to the [1Flow dashboard](https://dashboard.1flow.app/){:target="\_blank"} and find the **API Key** in Project Settings.
+4. Go to the [1Flow dashboard](https://dashboard.1flow.app/){:target="_blank"} and find the **API Key** in Project Settings.
5. Enter the **API Key** in the 1Flow destination settings in Segment.
## Supported methods
diff --git a/src/connections/destinations/catalog/2mee/index.md b/src/connections/destinations/catalog/2mee/index.md
index dbdb52227e..03706fdde7 100644
--- a/src/connections/destinations/catalog/2mee/index.md
+++ b/src/connections/destinations/catalog/2mee/index.md
@@ -3,19 +3,19 @@ title: 2mee Destination
rewrite: true
id: 60b5d0a01f3726b85dc05aab
---
-[2mee](https://2mee.com ) is a Human Hologram platform that automatically cuts the person out from the background, removing the visual clutter, and places them in the familiar context of your phone or website so that they dominate the screen.
+[2mee](https://2mee.com){:target="_blank”} is a Human Hologram platform that automatically cuts the person out from the background, removing the visual clutter, and places them in the familiar context of your phone or website so that they dominate the screen.
This destination is maintained by 2mee. For any issues with the destination, [contact the 2mee Support team](mailto:support@2mee.com).
## Getting Started
-{% include content/connection-modes.md %}
+
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2. Search for **2mee** in the Destinations Catalog and it.
3. Click **Configure 2mee**.
4. Choose which Source should send data to the 2mee destination.
-5. Go to 2mee and copy the [API Key and Application ID](https://docs.2mee.com/documentation/segment) from the 2mee Dashboard.
+5. Go to 2mee and copy the [API Key and Application ID](https://docs.2mee.com/documentation/segment){:target="_blank”} from the 2mee Dashboard.
6. Go back to Segment and paste the API Key and Application ID you just copied in the 2mee destination settings. Make sure to paste the API Key in this format: `Bearer `.
## Supported methods
@@ -41,7 +41,7 @@ Identify calls with a `userId` not mapped to a device fails with a `400` error c
Send [Track](/docs/connections/spec/track/) calls to track the actions your users perform.
-Configure the HoloCapsule setting in the [2mee](https://go.2mee.com/) app.
+Configure the HoloCapsule setting in the [2mee](https://go.2mee.com/){:target="_blank”} app.
Segment requires the `userId`. Track calls without a `userId` or with a `userId` not mapped to a device fail with a `400` code.
diff --git a/src/connections/destinations/catalog/aampe/index.md b/src/connections/destinations/catalog/aampe/index.md
index cb88137ad0..7907db07c3 100644
--- a/src/connections/destinations/catalog/aampe/index.md
+++ b/src/connections/destinations/catalog/aampe/index.md
@@ -3,18 +3,18 @@ title: Aampe Destination
id: 6188d844be5cf0e3b59189d2
---
-[Aampe](https://aampe.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) uses automated, rapid learning to personalize notifications, and continuously learns what messages bring value to your customer.
+[Aampe](https://aampe.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} uses automated, rapid learning to personalize notifications, and continuously learns what messages bring value to your customer.
This destination is maintained by Aampe. For any issues with the destination, [contact the Aampe Support team](mailto:support@aampe.com).
## Getting Started
-{% include content/connection-modes.md %}
+
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2. Search for "Aampe" in the Destinations Catalog, and select the "Aampe" destination.
3. Choose which Source should send data to the "Aampe" destination.
-4. Go to the [Data Integrations page](https://compose.aampe.com/configure/integrations) on Aampe Composer, click on "Add Integration", select "Segment" and click "Next".
+4. Go to the [Data Integrations page](https://compose.aampe.com/configure/integrations){:target="_blank”} on Aampe Composer, click on "Add Integration", select "Segment" and click "Next".
5. Copy the Segment API Key from the resulting page.
6. Enter this key in "API Key" in the "Aampe" destination settings in Segment.
@@ -24,7 +24,7 @@ Aampe supports the following methods, as specified in the [Segment Spec](/docs/c
### Track
-Segment sends [Track](/docs/connections/spec/track) calls to Aampe as a `track` event. These are used by Aampe to display engagement activity and reports in the [Aampe Composer](https://compose.aampe.com). You can use these to configure goals that are used for monitoring and creating campaigns. It may take up to 24 hours for events to show up in the Aampe Composer.
+Segment sends [Track](/docs/connections/spec/track) calls to Aampe as a `track` event. These are used by Aampe to display engagement activity and reports in the [Aampe Composer](https://compose.aampe.com){:target="_blank”}. You can use these to configure goals that are used for monitoring and creating campaigns. It may take up to 24 hours for events to show up in the Aampe Composer.
```js
analytics.track("Login Button Clicked");
diff --git a/src/connections/destinations/catalog/ab-smartly/index.md b/src/connections/destinations/catalog/ab-smartly/index.md
index 69ab594c63..fc0bd62b8d 100644
--- a/src/connections/destinations/catalog/ab-smartly/index.md
+++ b/src/connections/destinations/catalog/ab-smartly/index.md
@@ -19,12 +19,12 @@ Segment provides specific implementation details for A/B Smartly in the sections
## Getting Started
-{% include content/connection-modes.md %}
+
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2. Search for "A/B Smartly" in the Destinations Catalog, and select the "A/B Smartly" destination.
3. Choose which Source should send data to the "A/B Smartly" destination.
-4. Go to the A/B Smartly dashboard(https://your-org-name.absmartly.com/apikey/list), find and copy the "API key" that you created for segment.
+4. Go to the A/B Smartly dashboard(https://your-org-name.absmartly.com/apikey/list){:target="_blank”}, find and copy the "API key" that you created for segment.
5. Enter the "API Key" in the "A/B Smartly" destination settings in Segment.
6. If the integration requests for an Application name go to your A/B Smartly dashboard (`https://your-org-name.absmartly.com/application/create`) and create an Application named "Segment", or whatever you would like to call it. Use that name in the Application field of the integration settings.
7. Add also your A/B Smartly Collector endpoint. It's the same endpoint that you are using in all your A/B Smartly SDKs.
diff --git a/src/connections/destinations/catalog/ab-tasty-client-side/index.md b/src/connections/destinations/catalog/ab-tasty-client-side/index.md
index baeef06db8..9e6650338a 100644
--- a/src/connections/destinations/catalog/ab-tasty-client-side/index.md
+++ b/src/connections/destinations/catalog/ab-tasty-client-side/index.md
@@ -13,7 +13,7 @@ AB Tasty maintains this destination. For any issues with the destination, [conta
## Getting Started
-{% include content/connection-modes.md %}
+
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2. Search for **AB Tasty** in the Destinations Catalog, and select the **AB Tasty** destination.
diff --git a/src/connections/destinations/catalog/actable-predictive/index.md b/src/connections/destinations/catalog/actable-predictive/index.md
index 1117f93698..9bd0d14706 100644
--- a/src/connections/destinations/catalog/actable-predictive/index.md
+++ b/src/connections/destinations/catalog/actable-predictive/index.md
@@ -10,8 +10,6 @@ private: true
[Actable Predictive](https://actable.com/predictive-suite){:target="_blank"} is a standalone marketing-specific customer prediction tool. It trains models on your customer’s behavioral data, and provides regular automated scoring of new data against those models. The scoring output is tailored to drive higher levels of customer engagement, lower levels of churn, and increased incidence of purchases.
-{% include content/ajs-upgrade.md %}
-
## Benefits of Actable Predictive (Actions)
Actable Predictive (Actions) provides the following benefits:
diff --git a/src/connections/destinations/catalog/action-rokt-audiences/index.md b/src/connections/destinations/catalog/action-rokt-audiences/index.md
new file mode 100644
index 0000000000..90ca64b9b6
--- /dev/null
+++ b/src/connections/destinations/catalog/action-rokt-audiences/index.md
@@ -0,0 +1,72 @@
+---
+title: Rokt Audiences (Actions) Destination
+hide-personas-partial: true
+hide-boilerplate: true
+hide-dossier: false
+private: true
+hidden: true
+beta: true
+id: 643697130067c2f408ff28ca
+redirect_from:
+ - "/connections/destinations/catalog/actions-rokt-audiences"
+---
+{% include content/plan-grid.md name="actions" %}
+
+Rokt Audiences (Actions) destination enables advertisers to send Segment Persona Audiences to Rokt using Rokt's Audience API.
+
+By using Segment's Persona Audiences with Rokt, you can increase the efficiency of your ad campaigns through suppression and targeting of existing or new customers.
+
+## Benefits of Rokt Audiences (Actions)
+
+Benefits of the Rokt Audiences (Actions) destination include:
+- **Improved email matching**: This integration creates a direct connection between Segment and Rokt for a 100% match rate of email identifiers.
+
+- **Easy setup**: This destination only requires your Advertiser API key.
+
+- **Batching events and support for large audiences**: This destination supports batching which enables Rokt to receive large audiences without discrepancies.
+
+- **Near real-time audience updates**: The actions destination helps Rokt receive real-time events and add or remove users from Rokt audiences appropriately.
+
+## Getting started
+
+### Prerequisites:
+
+Before connecting to the Rokt Audiences destination, you must have an account with Rokt and receive your API key.
+
+### Add the destination:
+To add the Rokt Audiences (Actions) destination:
+
+1. From your Segment workspace, go to **Connections > Catalog** and select the **Destinations** tab of the catalog.
+
+2. Search for **Rokt Audiences (Actions)** and select the destination.
+
+3. Click **Add destination**.
+
+4. Select the space in Engage to use as the Source as this destination only supports sending Engage Audiences to Rokt.
+
+5. On the **Settings** tab, enter the name of your destination. For example, `Rokt audiences – `.
+
+6. Enter your Rokt **API key**.
+
+7. Click **Save Changes**.
+
+8. In the **Mappings** tab, click **+ New Mapping** and select **Add Users to Audience**. Don't change any defaults.
+
+9. Under the **Configure actions fields**, set **Enable Batching** to *Yes* and click **Save**.
+
+7. Repeat steps 8 and 9 for **Remove Users from Audience**.
+
+8. **Enable** both mappings.
+
+9. Go to the **Settings** tab and select the toggle to **Enable** the destination.
+
+10. Select your space, and navigate to **Engage > Audiences**. Select the source audience that you want to send to your Rokt Audiences (Actions) destination.
+
+11. Click **Add Destinations** and select the Rokt Audience (Actions) destination you created. In the settings that appear on the right-hand side, toggle the **Send Track** option on and **Send Identify**. Click **Save**.
+
+Your Rokt Audiences (Actions) destination is now ready to receive audiences, and your Persona audiences are now accessible in your Rokt Advertiser dashboard. Keep in mind that it can take 12-24 hours for the first sync when the number of email identifies are in the millions.
+
+> warning ""
+> You can only connect **one** Engage audience to a single instance of the Rokt Audience (Actions) destination. If you have multiple audiences, repeat the above process to create a new Rokt Audience (Actions) destination and connect the audience to a new destination each time.
+
+{% include components/actions-fields.html %}
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-1flow/index.md b/src/connections/destinations/catalog/actions-1flow/index.md
new file mode 100644
index 0000000000..d28826117d
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-1flow/index.md
@@ -0,0 +1,50 @@
+---
+title: 1Flow Web (Actions) Destination
+id: 656773f0bd79a3676ab2733d
+beta: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[1Flow](https://1flow.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses.
+
+
+1Flow is an easy-to-use, yet powerful in-app survey and messaging software. Using 1Flow, you can reach users in-the-moment while they are interacting with your website or mobile app, to collect highly contextual user insights that help you improve your product offering and customer experience.
+
+When you use the 1Flow Web (Actions) Destination, Segment loads the [1Flow SDK](https://1flow.ai/docs/install-sdk/javascript){:target="_blank"} for you. The 1Flow library enables you to track and identify user events on your website and interact with the 1Flow messenger window.
+
+
+## Getting started
+
+1. From Segment, navigate to **Connections > Catalog**, then select **Destinations**.
+2. Search for and select **1Flow Web (Actions) Destination**.
+3. Select the web source that will send data to 1Flow web (Actions) and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/source/catalog/libraries/website/javascript).
+4. On the **Settings** tab, input your 1Flow **PROJECT API KEY** and other destinations settings.
+5. Follow the step in the Destinations Actions docs to [customizing mappings](/docs/connections/destinations/action/#customizing-mappings).
+6. Enable the destination and configured mappings.
+
+{% include components/actions-fields.html %}
+
+## Supported methods
+
+### Identify
+
+The 1Flow destination will automatically ingest a User ID and any values sent over your Identify spec as [traits](https://docs.1flow.ai/install-sdk/javascript#de21ec0a453d443b88ca4bc1b12dc6bf){:target="_blank"}, as long as session capture is enabled in 1Flow.
+
+When you call Segment's Identify method, it will be equivalent to `logUser` of 1Flow. Identify calls that do not have a User ID value are not sent to 1Flow.
+- Segment's `userId` is `userID` in 1Flow
+- Segment's `traits` is `userDetails` in 1Flow
+
+### Track
+
+The 1Flow destination automatically ingests any user actions tracked over your Track spec as [events](https://docs.1flow.ai/install-sdk/javascript#d19201d97efa4ea4b81be6a351709332){:target="_blank"}, as long as session capture is enabled in 1Flow.
+
+
+## Troubleshooting
+
+### Requests to 1Flow return a 404 response
+
+If you are seeing 404 responses in your browser's network tab, you've likely encountered one of two issues:
+
+- You set the wrong App ID on the 1Flow Actions (Web) destination settings page.
+- You set the wrong Regional Data Hosting value on the 1Flow Actions (Web) destination settings page. 1Flow gates regional endpoints by plan level, so you may not have access to EU data hosting.
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-absmartly/index.md b/src/connections/destinations/catalog/actions-absmartly/index.md
new file mode 100644
index 0000000000..b318e27a96
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-absmartly/index.md
@@ -0,0 +1,170 @@
+---
+title: ABsmartly (Actions) Destination
+id: 64f703d1f6e9aa0a283ae3e2
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[ABsmartly](https://absmartly.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} provides an on-premise, full-stack experimentation platform for engineering and product teams that do continuous experimentation embedded into their development process. ABsmartly's real-time analytics help engineering and product teams ensure that new features will improve the customer experience without breaking or degrading performance and/or business metrics.
+
+This destination is maintained by ABsmartly. For any issues with the destination, [contact ABsmartly's Support](mailto:support@absmartly.com).
+
+## Benefits of ABsmartly (Actions) vs ABsmartly Classic
+
+- **Easier Setup**: Actions-based destinations are easier to configure with clear default settings, letting you quickly get started.
+- **Control and clearer mapping**: Actions-based destinations enable you to define the mapping between the data Segment receives from your source and the data Segment sends to ABsmartly.
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**.
+2. Search for "ABsmartly" in the Catalog, select **ABsmartly (Actions)**, and choose which of your sources to connect the destination to.
+3. Add the following Connection Settings:
+ - **Collector Endpoint**: Your ABsmartly Collector REST Endpoint. Usually `https://.absmartly.io/v1`
+ - **API Key**: An existing API Key. Created under Settings > API Keys in the ABsmartly Web Console.
+ - **Environment**: The environment where the events are originated matching an existing environment in ABsmartly. Created under Settings > Environments in the ABsmartly Web Console.
+5. Enable the _Track Calls_ mapping to send events to ABsmartly.
+
+{% include components/actions-fields.html %}
+
+> info ""
+> If you need support setting things up, you can contact the ABsmartly support team on Slack or [via email](mailto:support@absmartly.com).
+
+# Sending exposures to Segment
+
+It can be useful to send experiment exposures to Segment for visibility from
+other destinations. The Segment Spec includes the [Experiment Viewed semantic event](/docs/connections/spec/ab-testing/)
+for this purpose.
+
+> info ""
+> By default, the _Track Calls_ mapping will filter and not send any events with the name `Experiment Viewed` to ABsmartly.
+
+You can [install a custom event logger](https://docs.absmartly.com/docs/SDK-Documentation/getting-started#using-a-custom-event-logger){:target="_blank"} in ABsmartly and send exposures directly to Segment.
+
+```javascript
+analytics.ready(function() {
+ // initialize ABsmartly SDK
+ const sdk = new absmartly.SDK({
+ endpoint: 'https://your-absmartly-endpoint.absmartly.io/v1',
+ apiKey: '',
+ environment: 'development',
+ application: 'YOUR-APP',
+ eventLogger: (context, eventName, data) => {
+ if (eventName == "exposure") {
+ // filter only relevant and interesting exposures
+ // if the assigned flag is false, this exposure was a treatment call that did not result in an assignment
+ // this can happen if, for example, the experiment is no longer running, but treatment() calls are still in the application code
+ if (exposure.assigned) {
+ analytics.track("Experiment Viewed", {
+ experiment_id: exposure.id,
+ experiment_name: exposure.name,
+ variation_id: exposure.variant,
+ variation_name: "ABCDEFG"[exposure.variant],
+ });
+ }
+ }
+ },
+ });
+
+ const context = sdk.createContext(request);
+ context.attribute("user_agent", navigator.userAgent);
+
+ context.ready().then((response) => {
+ console.log("ABSmartly Context ready!");
+ console.log(context.treatment("test-exp"));
+ }).catch((error) => {
+ console.log(error);
+ });
+});
+```
+
+### Publishing experiment exposures through Segment
+
+To publish experiment exposures through Segment, you must first configure
+and enable the _Exposures (Verbatim)_ mapping in your ABsmartly (Actions) destination.
+
+By enabling the _Exposures (Verbatim)_ mapping in Segment, you replace the direct flow of exposure events from the ABsmartly SDK to the ABsmartly collector and instead send them to Segment
+for processing by the destination function.
+
+This can be achieved by instantiating the ABsmartly SDK with a custom context publisher.
+
+The custom publisher will publish an `Experiment Viewed` Segment event with ABsmartly's exposure data in the `properties.exposure` field as well
+as the normal semantic data that Segment recommends for this event.
+
+Here is an example in Javascript.
+
+```javascript
+analytics.ready(function() {
+ // initialize ABSmartly SDK
+ const sdk = new absmartly.SDK({
+ endpoint: 'https://your-absmartly-endpoint.absmartly.io/v1',
+ apiKey: '',
+ environment: 'development',
+ application: 'YOUR-APP',
+ });
+
+ // ABSmartly publisher implementation that publishes ABSmartly exposures to Segment,
+ // instead of directly to the ABSmartly Collector
+ // these will then be pushed by the ABSmartly segment integration to the ABSmartly collector
+ class SegmentContextPublisher extends absmartly.ContextPublisher {
+ constructor(segment) {
+ super();
+
+ this._segment = segment;
+ }
+
+ publish(request, sdk, context) {
+ // NOTE: only exposures are expected to come via this route
+ // other types of events should be tracked through the Segment API
+ if (request.exposures) {
+ for (const exposure of request.exposures) {
+ this._segment.track(`Experiment Viewed`, {
+ experiment_id: exposure.id,
+ experiment_name: exposure.name,
+ variation_id: exposure.variant,
+ variation_name: "ABCDEFG"[exposure.variant],
+ exposure: Object.assign({},
+ {
+ exposures: [exposure],
+ },
+ // add anything else in the a/b smartly payload that are not exposures or goals
+ ...Object.entries(request)
+ .filter(e => (e[0] !== 'exposures') && (e[0] !== 'goals'))
+ .map(e => ({[e[0]]: e[1]}))
+ )
+ });
+ }
+ }
+
+ return Promise.resolve();
+ }
+ }
+
+ // set this as the default publisher - all contexts created from now on will use it by default
+ sdk.setContextPublisher(new SegmentContextPublisher(analytics));
+
+ const request = {
+ units: {
+ userId: analytics.user().id(),
+ anonymousId: analytics.user().anonymousId(),
+ },
+ };
+
+ window.context = sdk.createContext(request);
+ context.attribute("user_agent", navigator.userAgent);
+
+ context.ready().then((response) => {
+ console.log("ABSmartly Context ready!");
+ console.log(context.treatment("test-exp"));
+ }).catch((error) => {
+ console.log(error);
+ });
+});
+```
+
+
+## Migration from the classic ABsmartly destination
+
+To migrate from the classic ABsmartly destination to ABsmartly (Actions), disconnect the classic ABsmartly destination before enabling the ABsmartly (Actions) destination to avoid duplicate experimentation events.
+
+---
+
diff --git a/src/connections/destinations/catalog/actions-acoustic/assets/20240422_152537_image.png b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_152537_image.png
new file mode 100644
index 0000000000..f5b13c6d39
Binary files /dev/null and b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_152537_image.png differ
diff --git a/src/connections/destinations/catalog/actions-acoustic/assets/20240422_152921_image.png b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_152921_image.png
new file mode 100644
index 0000000000..c297729e3a
Binary files /dev/null and b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_152921_image.png differ
diff --git a/src/connections/destinations/catalog/actions-acoustic/assets/20240422_153616_image.png b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_153616_image.png
new file mode 100644
index 0000000000..7f7822a489
Binary files /dev/null and b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_153616_image.png differ
diff --git a/src/connections/destinations/catalog/actions-acoustic/assets/20240422_155823_image.png b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_155823_image.png
new file mode 100644
index 0000000000..c7c7af67cc
Binary files /dev/null and b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_155823_image.png differ
diff --git a/src/connections/destinations/catalog/actions-acoustic/assets/20240422_155857_image.png b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_155857_image.png
new file mode 100644
index 0000000000..3bf84044bb
Binary files /dev/null and b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_155857_image.png differ
diff --git a/src/connections/destinations/catalog/actions-acoustic/assets/20240422_160007_image.png b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_160007_image.png
new file mode 100644
index 0000000000..6dc64a03a6
Binary files /dev/null and b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_160007_image.png differ
diff --git a/src/connections/destinations/catalog/actions-acoustic/assets/20240422_161221_image.png b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_161221_image.png
new file mode 100644
index 0000000000..60e0508489
Binary files /dev/null and b/src/connections/destinations/catalog/actions-acoustic/assets/20240422_161221_image.png differ
diff --git a/src/connections/destinations/catalog/actions-acoustic/index.md b/src/connections/destinations/catalog/actions-acoustic/index.md
new file mode 100644
index 0000000000..a774d5d5a4
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-acoustic/index.md
@@ -0,0 +1,105 @@
+---
+title: Acoustic (Actions) Destination
+id: 64edec5a4f881f992e432b81
+beta: true
+hidden: true
+---
+{% include content/plan-grid.md name="actions" %}
+
+[Acoustic Connect](https://acoustic.com/?utm_source=segmentio&utm_medium=docs&utm_Connect=partners){:target="_blank”} provides multichannel marketing without all the hassle. Automate campaigns and messages across SMS, mobile push, group messaging, email, and social media based on real-time customer signals and intent across the customer journey.
+
+Trigger promotional and transactional messages based on customer preferences and behaviors to support onboarding, customer activation, cross-sell, and re-engagement strategies. Scale personalization and treat your customers as individuals with an automated view and understanding of the customer by pulling real-time behavior like intent so marketers don't have to manually segment users and audiences.
+
+The Acoustic (Actions) Destination is maintained by Acoustic. For support, visit the [Acoustic Help Center](https://help.goacoustic.com/hc/en-us){:target="_blank"}.
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Find the Destinations Actions item "Acoustic (Actions)" in the left navigation, and click it.
+3. Click **Configure Acoustic (Actions)**.
+4. Select an existing source to connect to Acoustic (Actions).
+
+{% include components/actions-fields.html %}
+
+### Edit basic settings
+
+For some configuration options, you will need information from your Connect Org. Others will need the help of your Customer Success and/or Services resources. If you do not recognize the options here or need help, reach out to your Acoustic Customer Success or Services resource for help.
+
+- **Name**: Enter a name to help you identify this destination definition in Segment.
+
+- **Customer Prefix**: **Important** - Segment recommends that you use your Acoustic Connect Org name and a dataflow tag, like *CustomerAcme_Prod_* or *CustomerAcme_test1_* or *CustomerAcme_MktData3_*. Be sure to replace any spaces with an underscore and **be sure to end the string with an underscore '_'**.
+
+> info ""
+> Work with your Acoustic Customer Success or Services resource to align this string with the Acoustic definition that defines your unique table for this data set.
+
+- **S3 Bucket Access Point Alias**: The Alias of the Access Point created for your access to the S3 Bucket. Available from your Acoustic Customer Success or Services resource.
+
+- **S3 Access Key**: S3 Access Key for the S3 bucket. Available from your Acoustic Customer Success or Services resource.
+
+- **S3 Secret** S3 Secret credential for the S3 bucket. Available from your Acoustic Customer Success or Services resource.
+
+- **S3 Region**: Should always be `us-east-1` unless directed by Acoustic otherwise.
+
+- **Version**: No Need to Edit - Provides a metatag to confirm the version currently in effect. The current version is shown as: "Last-Modified: 02.01.2024 10.30.43", "Version 1.7"
+
+When all config options are defined and confirmed, as well as all Filter and Mapping configurations completed (see below), be sure to "Enable" and "Save Changes" for the Destination.
+
+When enabled, Segment will send data to Acoustic (Actions) based on configuration in the Mappings tab.
+
+> info ""
+> You can define multiple destinations to send unique data to different Connect Tables, simply create the definition with a unique name and Customer Prefix to align the mapped data to the respective Connect table.
+
+
+### Defining filters
+
+The Destination dialog includes a Filter tab. If you have a significant volume of Events and data attributes from the source you wish to use, a good first step would be to define Filter(s) to limit the data being sent to the connection from the defined source(s). Mapping is then used to define the specific set of attribute data and columns to be written to Acoustic.
+
+For example, for a Connection definition of an audience source, a `traits.email` or similar attribute filter would be necessary to assure only Identify Events with a valid value in the traits section (to be mapped to `UniqueRecipientId`) will be sent to the Acoustic Destination.
+
+
+
+Keep in mind that the Acoustic (Actions) Destination ignores events without a valid `UniqueRecipientId` attribute, therefore a common filter would be to avoid sending any events to the connection that don't have a valid attribute to be mapped to `UniqueRecipientId`. In many cases, this will be a valid email address but other Unique Id attribute, such as `CustID`, can be used.
+
+
+
+
+### Defining mapping
+
+The Destination dialog also contains a Mapping tab. The Acoustic (Action) Destination currently supports Segment Track and Identity Events along with all attributes of those events. In the Mapping dialog, initial Mapping templates are included as an aid. All of the provided mapping fields are optional, but you'll need to use at least one, in addition to the required attributes, to map the data you want to write to Acoustic Connect.
+
+
+
+Mapping provides the means to map Segment event data to Connect Columns. The value you map to a key is the value of the column with the same name as the key in Connect. That is, if you map the value of `trait.firstName` to the Key "firstname", the value mapped will show up in Connect in the column "firstname".
+
+You'll want to work with the Acoustic Services team to define a Connect Table that will **have all of the columns you intend to map**. The details of this table are also needed in the Destination's Settings dialog.
+
+Here we can see the mapping for `UniqueRecipientID`. `UniqueRecipientId` is required. The Acoustic (Actions) Destination will not accept any event that does not contain a `UniqueRecipientId` attribute.
+
+Avoid editing 'type' or 'timestamp' mappings. These are required and pre-mapped. As noted above, even these values will show up in the respective columns as the Key names, that is, there will be a column in your table in Connect of 'type' and 'timestamp', and each will hold the respective mapped values of the event data.
+
+
+
+Following the required attributes are a series of helpful predefined mapping structures. Each of these are optional, but at least one must be used to provide data beyond the required attributes previously noted.
+
+The first is a standard Key and Value mapping dialog. You can use this dialog to map each attribute provided by the Track or Identify event data one by one. That is, you can map `traits.firstname` to "firstname", then another Key/Value of `traits.lastname` to "lastname", and so on, until you have mapped all that you want to store in Connect.
+
+
+
+The mapping sections that follow allow you to map whole sections or even the special use-case of an array of data that needs to be flattened in order to be useful, as in this example of flattening the `properties.products` array to individual attributes.
+
+
+
+You can also map whole sections, which will provide all of the attributes of the section mapped through to Connect.
+
+
+
+With the Mapping completed, click **Save**.
+
+With all configuration completed, you'll want to confirm data being written to the defined Table in Connect.
+
+### Delivery report
+
+Additionally, if you see `Nesting Depth Exceeded` in your Delivery report, this indicates that an array of data is being sent through that is too deep. In other words, the array has too many levels and cannot be flattened. In this case, you'll need to revisit mapping that data to a flatter structure, that is, the attribute has a simple value versus the complex value structure that is coming through. Complex values, many layered values, are not useable and will not be accepted.
+
+
+
diff --git a/src/connections/destinations/catalog/actions-aggregations-io/index.md b/src/connections/destinations/catalog/actions-aggregations-io/index.md
new file mode 100644
index 0000000000..320b8797c4
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-aggregations-io/index.md
@@ -0,0 +1,21 @@
+---
+title: Aggregations.io (Actions) Destination
+id: 659eb601f8f615dac18db564
+beta: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[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.
+
+This destination is maintained by Aggregations.io. For any issues with the destination, [contact their Support team](mailto:help@aggregations.io).
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Find the Destinations Actions item in the left navigation, and click it.
+3. Click **Configure Aggregations.io (Actions)**.
+4. Select an existing Source to connect to Aggregations.io (Actions).
+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"}.
+
+{% include components/actions-fields.html %}
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-airship/index.md b/src/connections/destinations/catalog/actions-airship/index.md
new file mode 100644
index 0000000000..11d47fe5a9
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-airship/index.md
@@ -0,0 +1,42 @@
+---
+title: Airship (Actions) Destination
+id: 6475c5c14f7db4914bcd512f
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+
+[Airship](https://app.segment.com/airship/destinations/catalog/actions-airship){:target="_blank"} provides an end-to-end solution for capturing value across the entire customer app lifecycle — from acquisition and activation to engagement and loyalty. It starts with Airship’s market-leading app store optimization (ASO) solutions promoting app discovery and downloads. Then the unified journey orchestration, content creation and experimentation solutions kick in. App teams can quickly design, deploy and iterate no-code native app experiences and cross-channel campaigns — bridging inside-the-app experiences with outside-the-app messaging.
+
+Airship maintains this destination. For any issues with the destination, [contact the Airship Support team](mailto:support@airship.com).
+
+> success ""
+> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Airship Segment destination. There's also a page about the [non-Actions Airship destination](/docs/connections/destinations/catalog/airship/). Both of these destinations receive data from Segment.
+
+## Benefits of Airship (Actions) vs Airship Classic
+
+Airship (Actions) provides the following benefits over the classic Airship destination:
+
+- **Flexibility**. Complete flexibility for mapping your data from any Segment event type to one of three Airship endpoints. Make optimal use of data from Segment to trigger Automations, audience segmentation, or to personalize end-users in-app experiences and messages.
+- **Additional functionality**. Supports email registration, named user association, as well as delete for GDPR compliance. This is in addition to the previously supported custom events, tag management, and attributes.
+- **Reporting**. Better and more meaningful feedback from the Airship API. This integration calls the Airship API directly, so the endpoint response shows precisely how the integration is performing.
+
+
+## Getting started
+
+1. From the Segment web app, navigate to **Connections > Catalog**, and select the **Destinations** tab in the catalog.
+2. Search for *Airship (Actions)* and select it.
+3. Click **Configure Airship (Actions)**.
+4. Select an existing Source to connect to Airship (Actions).
+5. Name the destination and choose between filling in the settings manually or copying from an existing instance.
+6. Click **Create Destination**.
+7. Enter your Access Token and App Key. You can get your access token and app key by going to your Airship project and navigating to **Settings > Partner Integrations** and selecting Segment. Following the instructions there will create a Tag Group, Attributes, and provide the Access Token and App Key.
+8. Select the appropriate data center.
+
+{% include components/actions-fields.html %}
+
+## Named User ID
+Named User is an Airship concept for identifying users and associating them with devices and delivery addresses. For more information, see [Airship | Named Users](https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/named-users/){:target="_blank"}. This integration does not perform the association of a Named User to a delivery address, configure that in either the mobile/web SDK or through a custom workflow out of band from this integration.
+
+
+
diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_api_keys.png b/src/connections/destinations/catalog/actions-algolia-insights/images/algolia_api_keys.png
similarity index 100%
rename from src/connections/destinations/catalog/algolia-insights/images/algolia_api_keys.png
rename to src/connections/destinations/catalog/actions-algolia-insights/images/algolia_api_keys.png
diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_app_id_dropdown.png b/src/connections/destinations/catalog/actions-algolia-insights/images/algolia_app_id_dropdown.png
similarity index 100%
rename from src/connections/destinations/catalog/algolia-insights/images/algolia_app_id_dropdown.png
rename to src/connections/destinations/catalog/actions-algolia-insights/images/algolia_app_id_dropdown.png
diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_dashboard_settings.png b/src/connections/destinations/catalog/actions-algolia-insights/images/algolia_dashboard_settings.png
similarity index 100%
rename from src/connections/destinations/catalog/algolia-insights/images/algolia_dashboard_settings.png
rename to src/connections/destinations/catalog/actions-algolia-insights/images/algolia_dashboard_settings.png
diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_settings_menu.png b/src/connections/destinations/catalog/actions-algolia-insights/images/algolia_settings_menu.png
similarity index 100%
rename from src/connections/destinations/catalog/algolia-insights/images/algolia_settings_menu.png
rename to src/connections/destinations/catalog/actions-algolia-insights/images/algolia_settings_menu.png
diff --git a/src/connections/destinations/catalog/algolia-insights/images/destination_settings.png b/src/connections/destinations/catalog/actions-algolia-insights/images/destination_settings.png
similarity index 100%
rename from src/connections/destinations/catalog/algolia-insights/images/destination_settings.png
rename to src/connections/destinations/catalog/actions-algolia-insights/images/destination_settings.png
diff --git a/src/connections/destinations/catalog/algolia-insights/images/mapping_tab.png b/src/connections/destinations/catalog/actions-algolia-insights/images/mapping_tab.png
similarity index 100%
rename from src/connections/destinations/catalog/algolia-insights/images/mapping_tab.png
rename to src/connections/destinations/catalog/actions-algolia-insights/images/mapping_tab.png
diff --git a/src/connections/destinations/catalog/algolia-insights/images/mapping_tab_edit.png b/src/connections/destinations/catalog/actions-algolia-insights/images/mapping_tab_edit.png
similarity index 100%
rename from src/connections/destinations/catalog/algolia-insights/images/mapping_tab_edit.png
rename to src/connections/destinations/catalog/actions-algolia-insights/images/mapping_tab_edit.png
diff --git a/src/connections/destinations/catalog/algolia-insights/images/rename_events.png b/src/connections/destinations/catalog/actions-algolia-insights/images/rename_events.png
similarity index 100%
rename from src/connections/destinations/catalog/algolia-insights/images/rename_events.png
rename to src/connections/destinations/catalog/actions-algolia-insights/images/rename_events.png
diff --git a/src/connections/destinations/catalog/algolia-insights/index.md b/src/connections/destinations/catalog/actions-algolia-insights/index.md
similarity index 87%
rename from src/connections/destinations/catalog/algolia-insights/index.md
rename to src/connections/destinations/catalog/actions-algolia-insights/index.md
index a7fae0ae16..3c4290a156 100644
--- a/src/connections/destinations/catalog/algolia-insights/index.md
+++ b/src/connections/destinations/catalog/actions-algolia-insights/index.md
@@ -1,12 +1,11 @@
---
-title: Algolia Insights Destination
+title: Algolia Insights (Actions) Destination
rewrite: true
redirect_from:
- '/connections/destinations/catalog/algolia/'
- - '/connections/destinations/catalog/actions-algolia-insights/'
-id: 5d373a350abf930001a6b70f
+id: 63e52bea7747fbc311d5b872
---
-This [Algolia Insights](https://www.algolia.com/products/analytics/) destination is a means of facilitating sending [Insights Events](https://www.algolia.com/doc/guides/sending-events/getting-started/). Sending these events is a required step for using several Algolia features:
+With the [Algolia Insights (Actions)](https://www.algolia.com/products/analytics/){:target="_blank"} destination, you can send [Insights Events](https://www.algolia.com/doc/guides/sending-events/getting-started/){:target="_blank"}. It's required to send Insight Events to use these Algolia features:
- Click and conversion analytics
- A/B Testing
@@ -14,10 +13,7 @@ This [Algolia Insights](https://www.algolia.com/products/analytics/) destination
- Personalization
- Algolia Recommend
-This destination is maintained by [Algolia](https://www.algolia.com/). For any issues with the destination, [contact the Algolia team](mailto:hey@algolia.com).
-
-{% include content/beta-note.md %}
-
+This destination is maintained by [Algolia](https://www.algolia.com/){:target="_blank”}. For any issues with the destination, [contact the Algolia team](mailto:hey@algolia.com).
## Getting Started
@@ -48,7 +44,7 @@ index.search('query', {
})
```
-Once this is enabled you will be able to send properties like queryId in your segment events. You can read more about how to send Algolia-related data to Segment from [the documentation at Algolia](https://www.algolia.com/doc/guides/sending-events/implementing/connectors/segment/).
+Once this is enabled you will be able to send properties like queryId in your segment events. You can read more about how to send Algolia-related data to Segment from [the documentation at Algolia](https://www.algolia.com/doc/guides/sending-events/implementing/connectors/segment/){:target="_blank”}.
## Mapping Events
diff --git a/src/connections/destinations/catalog/actions-ambee/index.md b/src/connections/destinations/catalog/actions-ambee/index.md
new file mode 100644
index 0000000000..2a16d7d4bc
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-ambee/index.md
@@ -0,0 +1,123 @@
+---
+title: "Ambee (Actions) Destination"
+hidden: true
+beta: true
+id: 647f2f7ce3b561ab931c2b77
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+Ambee provides self-serve predictive analytics for businesses,
+using machine learning to automate audience insights and
+recommendations based on climate and environmental datasets. Ambee
+offers actionable air quality and pollen data that can reinforce your
+climate strategy, simplify personalization and enhance business
+outcomes.
+
+This destination is maintained by Ambee. For any issues with the
+destination, contact Ambee's [Support
+Team](https://support.getambee.com/portal/en/home){:target="_blank"}.
+
+## Getting started
+
+
+1. From the **Segment** web app, click **Catalog**, then click
+**Destinations**.
+2. Find the **Destinations Actions** item in the left navigation, and click
+it.
+3. Click Configure **Ambee**
+4. Select an existing Source to connect to **Ambee** (Actions).
+
+{% include components/actions-fields.html %}
+
+## Settings
+
+### Segment write key
+
+The write key is a unique identifier for each Source. It lets Segment
+know which Source is sending the data and which destinations should
+receive that data.
+
+To find a write key, you first need to create a non-cloud Source such as
+a website, server, or mobile source.
+
+Then, in the Source, navigate to **Settings** > **API Keys**.
+
+
+### API Key
+
+To start working with Ambee as your destination, you'll need
+Ambee's API Key. Sign up for Ambee [here](https://auth.ambeedata.com/users/register?redirectUrl=https://api-dashboard.getambee.com){:target="_blank"}.
+
+Once you are signed in, you will get your limited-period API key on the
+dashboard's homepage. If your use case requires data in bulk, you'll
+need to subscribe to Ambee's [enterprise
+plan](https://www.getambee.com/pricing){:target="_blank"}. During
+subscription, you'll need to specify your choice of API: **air quality**
+and/or **pollen**.
+
+After subscription, you can use Ambee's air quality and/or pollen data
+by pasting your API key under **the API Key section** in **Mapping**.
+
+## Ambee Destination Mapping
+
+### Ambee Air Quality Subscription
+
+Ambee's air quality subscription helps you personalize and position your
+messaging with emails, SMS, and push notifications to improve user
+engagement on your website based on air quality triggers for locations
+across the world. You can also retarget messaging based on your user's
+geo-location, for example:
+
+- Promote the sale of your EVs in highly polluted areas
+
+- Advertise anti-pollution products like masks, skincare, and more, during highly polluted durations
+
+- Showcase ads for smart air purifiers in highly polluted localities
+
+The table below shows the AQI risk levels, their associated value, and
+what each category means for the public. Ambee uses globally valid data
+that follows US EPA standards to provide relevant recommendations. If
+you are subscribed to **air quality** you can select the risk levels
+for AQI from the drop-down box under **the air quality** section.
+
+ | AQI risk levels | Index Values | What it means |
+ |---------------------|-----------------|-----------------------------|
+ | Good | 0-50 | Air quality is good and poses little or no risk. |
+ | Moderate | 51-100 | Air quality is acceptable; however, there may be some health concerns for a small number of extremely sensitive people. |
+ | Unhealthy for sensitive groups | 101-150 | When air quality is in this range, people in sensitive groups may experience health effects when engaging in outdoor activities. |
+ | Unhealthy | 151-200 | When air quality is in this range, everyone who is active outdoors may experience effects. Members of sensitive groups are likely to experience more serious effects. |
+ | Very unhealthy | 201-300 | When air quality is in this range, it is expected that there will be widespread effects among general population and more serious effects in members of sensitive groups. |
+ | Hazardous | 301-500 | Air quality in this range triggers health warnings of emergency conditions. The entire population is more likely to be affected by serious health effects.
+
+### Ambee Pollen Subscription
+
+Ambee's pollen subscription helps you contextualize and hyper-target
+your marketing and advertising campaigns with emails, SMS, and push
+notifications to improve user engagement with the help of pollen
+triggers for locations across the world. You can also personalize your
+ad content based on the user's geolocation, for example:
+
+- Advertise anti-allergy tissues based on high pollen condition
+
+- Promote OTC medicines to allergy sufferers
+
+NAB recommends the risk levels below to understand the risks
+users are exposed to, and help them take preventative measures to
+reduce exposure to pollen. Ambee uses the NAB-compliant index to
+provide accurate insights. If you are subscribed to **pollen**, you can
+select the risk levels for pollen from the drop-down box under the
+**pollen** section.
+
+| Risk Level | Tree | Grass | Weed | What it means |
+|---------------|---------|-----------|-------------|-----------------|
+| Low | 0-95 | 0-29 | 0-20 | Individuals susceptible to pollen may experience mild allergic symtoms. |
+| Moderate | 96-207 | 30-60 | 21-77 | Many individuals sensitive to pollen may experience allergic symptoms. |
+| High | 208-703 | 61-341 | 78-266 | Most individuals with any sensitivity to pollen will experience allergic symptoms. Extremely sensitive groups could experience serious symptoms. |
+| Very High | 704+ | 342+ | 267+ | Almost all individuals with any sensitivity to pollen will experience symptoms. |
+
+### IP Address
+
+Ambee will fetch the user's IP address to trigger air quality and/or
+pollen notifications for device mode with analytics.js or mobile
+(android/iOS).
diff --git a/src/connections/destinations/catalog/actions-amplitude/index.md b/src/connections/destinations/catalog/actions-amplitude/index.md
index ddc638457a..e543879bf8 100644
--- a/src/connections/destinations/catalog/actions-amplitude/index.md
+++ b/src/connections/destinations/catalog/actions-amplitude/index.md
@@ -23,11 +23,11 @@ Amplitude (Actions) provides the following benefits over the classic Amplitude d
- **Clearer mapping of data**. Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to the destination.
- **Support for Amplitude's HTTP API v2**. Amplitude (Actions) is built on the latest version of [Amplitude's HTTP API](https://developers.amplitude.com/docs/http-api-v2){:target="_blank"}.
- **Revenue is a top-level property**. Amplitude (Actions) elevates `revenue` to a top-level property in requests sent to Amplitude. This enables inclusion of this data in Amplitude features like customer LTV reports.
-- **Session tracking in cloud-mode**. Amplitude (Actions) supports sending session details from cloud-mode sources.
+- **Tracking in cloud-mode**. Amplitude (Actions) supports sending details from cloud-mode sources.
## Getting started
-1. Before you start, go to your [Amplitude workspace](https://analytics.amplitude.com){:target="_blank"}. Click **Settings** in the bottom left, then click **Projects** in the left menu. Select your **Project**. Copy the Amplitude API Key and Secret Key for the project.
+1. Before you start, go to your [Amplitude workspace](https://analytics.amplitude.com){:target="_blank"}. Click **Settings** in the top right and then click **Organization Settings** to navigate to your **Projects** in the menu. Select your **Project**. Copy the Amplitude API Key and Secret Key for the project.
2. From the Segment web app, click **Catalog**, then click **Destinations**.
3. Find the Destinations Actions item in the left navigation, and click it.
4. Click the "Amplitude" item to select it and click **Configure**.
@@ -51,13 +51,17 @@ To manually add the Log Purchases Action:
### Connection Modes for Amplitude (Actions) destination
-The Amplitude (actions) destination does not offer a device-mode connection mode. If you're using one of Segment's new libraries ([Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](https://github.com/segmentio/analytics-swift) or [Kotlin](https://github.com/segmentio/analytics-kotlin)) with the Actions-framework version of the destination, you do not need the device-mode connection.
+The Amplitude (Actions) destination does not offer a device-mode connection mode. Previous deployments of the Amplitude Segment destination required the device-mode connection to use the `session_id` tracking feature. However, the Amplitude (Actions) destination now includes session ID tracking by default when you use Segment's ([Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/) library.
+### Track sessions
-Most previous deployments of the Amplitude Segment destination used the device-mode connection to use the `session_id` tracking feature. The new Actions-framework Amplitude destination, includes session ID tracking by default. When connected to the Analytics.js 2.0 source, Segment automatically loads a plugin on your website for session tracking and enrichment as an alternative to the Amplitude SDK. This means you don't need to bundle any software to run on the user's device, or write any code. It also means that you can use more of the Segment platform features on data going to Amplitude, such as Protocols filtering and transformations, and Profiles Identity Resolution.
+Session tracking is available with Segment's new libraries: [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](/docs/connections/sources/catalog/libraries/mobile/apple/) or [Kotlin](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/).
-Session tracking is available with Segment's new libraries: [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](https://github.com/segmentio/analytics-swift) or [Kotlin](https://github.com/segmentio/analytics-kotlin)
+When connected to the Analytics.js 2.0 source, Segment automatically loads a plugin on your website for session tracking and enrichment as an alternative to the Amplitude SDK. This means you don't need to bundle any software or write any code to run on the user's device, and can use more of the Segment platform features for data going to Amplitude, like [Protocols filtering and transformations](/docs/protocols/) and [Unify Identity Resolution](/docs/unify/identity-resolution/).
+If you're using one of Segment's [Swift](/docs/connections/sources/catalog/libraries/mobile/apple/), [Kotlin](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/), or [React Native](/docs/connections/sources/catalog/libraries/mobile/react-native/) libraries, you will need to include the Amplitude destination plugin to enable session tracking.
+
+You can read more about Amplitude's [tracking sessions](https://help.amplitude.com/hc/en-us/articles/115002323627-Track-sessions){:target="_blank”} feature in Amplitude's documentation.
### Device ID Mappings
The Amplitude destination requires that each event include either a Device ID or a User ID. If a User ID isn't present, Amplitude uses a Device ID, and vice versa, if a Device ID isn't present, Amplitude uses the User ID.
@@ -68,24 +72,23 @@ By default, Segment maps the Segment property `context.device.id` to the Amplitu
JavaScript sources automatically enable session tracking.
-The session ID Segment passes to Amplitude stores locally in a key-value pair. View the value associated with the `analytics_session_id`key to access the session ID.
+The session ID Segment passes to Amplitude stores locally in a key-value pair. View the value associated with the `analytics_session_id`key to access the session ID. The session ID is set to timeout every 30 minutes by default.
### Enable Amplitude session tracking for Swift
-To enable session tracking in Amplitude when using the [Segment Swift library](https://github.com/segmentio/analytics-swift):
+To enable session tracking in Amplitude when using the [Segment Swift library](https://github.com/segmentio/analytics-swift){:target="_blank”}:
1. Enable `trackApplicationLifecycleEvents` in your configuration.
-2. Add the [Amplitude Session plugin](https://github.com/segmentio/analytics-swift/blob/main/Examples/destination_plugins/AmplitudeSession.swift
-) to your project.
-3. Initialize the plugin ([example](https://github.com/segmentio/analytics-swift/blob/main/Examples/apps/DestinationsExample/DestinationsExample/AppDelegate.swift))
+2. Add the [Amplitude Session plugin](https://github.com/segment-integrations/analytics-swift-amplitude/blob/main/Sources/SegmentAmplitude/AmplitudeSession.swift){:target="_blank”} to your project.
+3. Initialize the plugin ([example](https://github.com/segmentio/analytics-swift/blob/main/Examples/apps/DestinationsExample/DestinationsExample/AppDelegate.swift){:target="_blank”})
```swift
analytics?.add(plugin: AmplitudeSession(name: "Amplitude"))
```
### Enable Amplitude session tracking for Kotlin
-To enable session tracking in Amplitude when using the [Segment Kotlin library](https://github.com/segmentio/analytics-kotlin):
+To enable session tracking in Amplitude when using the [Segment Kotlin library](https://github.com/segmentio/analytics-kotlin){:target="_blank”}:
1. Enable `trackApplicationLifecycleEvents` in your configuration.
-2. Add the [Amplitude Session plugin](https://github.com/segmentio/analytics-kotlin/blob/main/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins/AmplitudeSession.kt) to your project.
+2. Add the [Amplitude Session plugin](https://github.com/segment-integrations/analytics-kotlin-amplitude/blob/main/lib/src/main/java/com/segment/analytics/kotlin/destinations/amplitude/AmplitudeSession.kt){:target="_blank”} to your project.
2. Initialize the plugin
```kotlin
analytics.add(AmplitudeSession())
@@ -93,8 +96,8 @@ To enable session tracking in Amplitude when using the [Segment Kotlin library](
### Enable Amplitude session tracking for iOS
-To enable session tracking in Amplitude when using the [Segment iOS library](https://github.com/segmentio/analytics-ios):
-1. Add the [Amplitude Session middleware](https://github.com/segment-integrations/analytics-ios-integration-amplitude/blob/amplitude-session/Pod/Classes/SEGAmplitudeSession.m) to your project.
+To enable session tracking in Amplitude when using the [Segment iOS library](https://github.com/segmentio/analytics-ios){:target="_blank”}:
+1. Add the [Amplitude Session middleware](https://github.com/segment-integrations/analytics-ios-integration-amplitude/blob/amplitude-session/Pod/Classes/SEGAmplitudeSession.m){:target="_blank”} to your project.
2. Add the middleware & enable `trackApplicationLifecycleEvents` in your configuration:
```objective-c
NSString *const SEGMENT_WRITE_KEY = @" ... ";
@@ -106,8 +109,8 @@ To enable session tracking in Amplitude when using the [Segment iOS library](htt
### Enable Amplitude session tracking for Android
-To enable session tracking in Amplitude when using the [Segment Android library](https://github.com/segmentio/analytics-android):
-1. Add the [Amplitude Session middleware](https://github.com/segment-integrations/analytics-android-integration-amplitude/blob/master/src/main/java/com/segment/analytics/android/integrations/amplitude/AmplitudeSessionId.java) to your project.
+To enable session tracking in Amplitude when using the [Segment Android library](https://github.com/segmentio/analytics-android){:target="_blank”}:
+1. Add the [Amplitude Session middleware](https://github.com/segment-integrations/analytics-android-integration-amplitude/blob/master/src/main/java/com/segment/analytics/android/integrations/amplitude/AmplitudeSessionId.java){:target="_blank”} to your project.
```gradle
implementation 'com.segment.analytics.android.integrations:amplitude:3.1.0'
```
@@ -172,7 +175,7 @@ Property names should be `camelCase` for Android implementations, and `snake_cas
If `true`, the destination sends events to Amplitude's `batch` endpoint rather than the `httpapi` endpoint. Because Amplitude's `batch` endpoint throttles traffic less restrictively than the Amplitude `httpapi` endpoint, enabling this setting can help to reduce 429 errors (throttling errors) from Amplitude.
-Amplitude's `batch` endpoint throttles data when the rate of events sharing the same `user_id` or `device_id` exceeds an average of 1,000/second over a 30-second period. See the Amplitude documentation for more about [429 errors and throttling in Amplitude](https://developers.amplitude.com/#429s-in-depth).
+Amplitude's `batch` endpoint throttles data when the rate of events sharing the same `user_id` or `device_id` exceeds an average of 1,000/second over a 30-second period. See the Amplitude documentation for more about [429 errors and throttling in Amplitude](https://developers.amplitude.com/#429s-in-depth){:target="_blank”}.
{% endcapture %}
@@ -202,10 +205,11 @@ To use Amplitude's groups with Segment, you must enable the following Action set
## Migration from Amplitude Classic
-{% include content/ajs-upgrade.md %}
-
Keep the following in mind if you plan to move to Amplitude (Actions) from a classic Amplitude destination.
+> info ""
+> In some cases, Amplitude Classic uses different default mappings than Amplitude (Actions). For example, the `Viewed Home Page` event in Amplitude Classic will be `Viewed Home` in Amplitude Actions, unless you configure it as `Viewed Home Page`. Be sure to follow the steps in the Destination Actions documentation to [customize your mappings](/docs/connections/destinations/actions/#customizing-mappings). Review how events appear in each destination, and configure the Actions' mappings properly to maintain continuity between Classic and Actions destinations.
+
### Amplitude (Actions) uses Amplitude's HTTP API v2
> warning ""
@@ -214,7 +218,15 @@ Keep the following in mind if you plan to move to Amplitude (Actions) from a cla
You configure the Amplitude (Actions) destination through Filters and Actions. Consult the table below for information about configuring your Amplitude (Actions) destination similarly to your classic Amplitude destination.
> info ""
-> Contact Segment support if you find features missing from the Amplitude (Actions) destination that were available in the classic Amplitude destination.
+> Contact Segment support if you find features missing from the Amplitude (Actions) destination that were available in the classic Amplitude destination.
+
+### Set Once/Set Always fields
+
+Amplitude restricts the mixing of top-level user properties with `$set`, `$setOnce`, or `$setAlways` operations in a single request, [as outlined in Amplitude’s documentation](https://www.docs.developers.amplitude.com/analytics/apis/identify-api/#user_properties-supported-operations){:target="_blank"}.
+
+To circumvent this within Segment, users can opt to exclusively map event parameters to either the **User Properties** field or to one of the user property operations (Set Once and/or Set Always) available in mappings. If you use the **Set Once** and/or **Set Always** fields, include all relevant fields in their respective mappings and do not configure mappings for **User Properties** in the same request.
+
+Conversely, to send top-level user properties, map only to the **User Properties** field and exclude mappings for the **Set Once** and **Set Always** fields.
{% include components/actions-map-table.html name="amplitude" %}
diff --git a/src/connections/destinations/catalog/actions-app-fit/index.md b/src/connections/destinations/catalog/actions-app-fit/index.md
new file mode 100644
index 0000000000..8ee9b0d2e5
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-app-fit/index.md
@@ -0,0 +1,26 @@
+---
+title: AppFit (Actions) Destination
+id: 64b67be0d0dd66094c162ca7
+beta: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[AppFit](https://appfit.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} integrates with Segment to help teams stay on top of their key business metrics. Successful teams look at their app metrics on a consistent basis and use that data to make decisions about their business.
+
+When you connect AppFit to your Segment account, you get a top level dashboard for your mobile phone and weekly reminders to review your metrics. If you see a metric that doesn't look right, AppFit lets you flag it and add comments so everyone can discuss what's going on right from their phone.
+
+This destination is maintained by AppFit. For any issues with the destination, [contact their Support team](mailto:support@appfit.io).
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Find the Destinations Actions item in the left navigation, and click it.
+3. Click **Configure AppFit**.
+4. Select an existing Source to connect to AppFit (Actions).
+
+To find your API key, go to the AppFit app and click on Connectors in the main menu. If you already have a Segment Destination connector created, you can click on it and find your API key there, otherwise you can create a new connector by clicking on "Create New Connector" and selecting "Segment Destination"
+
+{% include components/actions-fields.html %}
+
+
diff --git a/src/connections/destinations/catalog/actions-attio/index.md b/src/connections/destinations/catalog/actions-attio/index.md
new file mode 100644
index 0000000000..7c2e0f94d6
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-attio/index.md
@@ -0,0 +1,201 @@
+---
+title: Attio (Actions) Destination
+hide-boilerplate: true
+id: 64c031541451bb784943f809
+beta: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+Powerful, flexible and data-driven, [Attio](https://attio.com){:target="_blank”} makes it easy to build the
+exact CRM that your business needs.
+
+This destination allows you to use your existing Segment events to create or update
+records in Attio, for example creating Attio User records from Segment Identify events.
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Search for **Attio (Actions)** and select it.
+3. Click **Add destination**, then follow the setup instructions.
+4. Click **Connect to (destination name)** to select the Attio Workspace you'd like to connect to.
+
+
+
+## Identify User
+
+Create or update a **Person** using the provided email address, then create or update a
+related **User** using the same address. By default, this mapping runs for `identify`
+events.
+
+*This mapping is a special form of [Assert Record](#assert-record), because it asserts
+both a Person and User and links them together. If you only need to assert either a Person
+or User, you should configure [Assert Record](#assert-record) instead.*
+
+In Attio, a **Person** represents a human. People have names, email addresses, Twitter
+profiles, email and calendar interactions, etc.
+
+Meanwhile, a **User** is a user of your product. Users might have feature flags,
+permission levels, etc. A Person can have multiple Users, for example if they exist in
+different workspaces or have different sets of permissions, but are ultimately the same
+Person.
+
+> info ""
+> To use the User standard object, you'll need to make sure it's activated first. Visit
+> your [Workspace Settings > Objects](https://app.attio.com/_/settings/data/objects){:target="_blank”} page
+> and click the "Activate" button next to the Users object.
+
+This mapping makes the assumption that your Segment event includes two properties:
+
+ 1. An `email_address` property, to create or update a Person
+ 2. A `id` property, to create or update an associated User
+
+ You can specify additional attributes to be mapped on the **Edit Mapping** page.
+
+For example, you could set some additional properties on the Person using these Mapping
+Fields under "Additional Person attributes". The column on the left should contain
+properties from your event, or custom text, and the column on the right should reference
+attributes on that object type in Attio, represented by their slug.
+
+> info ""
+> Every Attio attribute has both an ID and a slug, and you can use either to reference
+> those attributes in this action. To find this value, on the object settings page, select
+> the "Attributes" tab, locate your attribute, then click on the **︙** button and select
+> "Copy slug".
+
+Here's an example configuration that sets the `description`, `name` and `company`
+attributes on the Person object:
+
+| Select event variable | Enter key name | Notes |
+|-----------------------------------------|----------------|--------------------------------------------------------------------|
+| `traits.description` | description | |
+| `traits.last_name`, `traits.first_name` | name | Person names must be formatted as `Last name(s), First name(s)` |
+| `traits.domain` | company | A Company relationship can be populated using the Company's domain |
+
+You can also use the same approach to specify additional properties on the User object.
+Please note that by default, the User object doesn't specify many attributes; the
+expectation is that you'll add your own that make the most sense for your product. All
+custom attributes can be specified here, please see [attribute types](#attribute-types)
+below for more information.
+
+## Group Workspace
+
+Create or update a **Company** using the provided domain, then create or update a
+**Workspace** using the provided name. By default, this mapping runs for `group` events.
+
+*This mapping is a special form of [Assert Record](#assert-record), because it asserts
+both a Company and Workspace and links them together. If you only need to assert either a
+Company or Workspace, you should configure [Assert Record](#assert-record) instead.*
+
+In Attio, a **Company** can have names and domains, as well as enriched properties like
+ARR or category.
+
+Meanwhile, a **Workspace** represents a group of Users in your product. Workspaces might
+have feature flags, billing configurations, customer support representatives, etc. A
+Company can have many Workspaces.
+
+> info ""
+> To use the Workspace standard object, you'll need to make sure it's activated first. Visit
+> your [Workspace Settings > Objects](https://app.attio.com/_/settings/data/objects) page
+> and click the "Activate" button next to the Workspaces object.
+
+This mapping makes the assumption that your Segment event includes two properties:
+
+ 1. A `domain` property, to create or update a Company
+ 2. A `id` property, to create or update an associated Workspace
+
+You can specify additional attributes to be mapped on the **Edit Mapping** page.
+
+For example, you could set some additional properties on the Company using these Mapping
+Fields under "Additional Company attributes". The column on the left should contain
+properties from your event, or custom text, and the column on the right should reference
+attributes on that object type in Attio, represented by their slug. For example:
+
+| Select event variable | Enter key name |
+|-----------------------------------------|----------------|
+| `traits.twitter_handle` | twitter |
+
+Similarly, you can also set some additional properties on the Workspace. All
+custom attributes can be specified here, please see [attribute types](#attribute-types)
+below for more information.
+
+## Assert Record
+
+Create or update a single type of Object, given a matching attribute name and value. For
+example, you could assert that a Company exists using a given `domain` property.
+
+This mapping makes the assumption that your data includes the matching property. For the
+following example, assume you have domain and twitter properties, like so:
+
+```json
+{
+ "type": "identify",
+ "traits": {
+ "domain": "app.attio.com",
+ "twitter_handle": "@attio"
+ }
+}
+```
+
+First, you'll need to set the "Attio Object" property - it should pre-populate with all of
+the activated objects in your Attio instance. Then, you'll need to set the "Matching
+Attribute" property. This is the slug for the attribute in Attio, and must also be present
+in your "Attributes" mapping in the next form. In this example, you'll select "Company" as
+the Attio Object, and "domains" as the Matching Attribute.
+
+You would then need to ensure the Attributes mapping is populated like so:
+
+| Select event variable | Enter key name |
+|-----------------------------------------|----------------|
+| `traits.domain` | domains |
+| `traits.twitter_handle` | twitter |
+
+When this mapping runs, Attio will try to find an existing Company where one of the
+domains matches the one you've provided here. If it finds it, it will update the `twitter`
+attribute with the value `"@attio"`. If it doesn't find it, a new Company will be created
+with both the domain and twitter handles above.
+
+## Batching support
+
+This action supports batching. You can toggle batching using the **Edit Mapping > Enable
+Batching** property.
+
+Batching sends groups of events to Attio in a single request, rather than individually,
+which can improve stability & correctness if you are sending a lot of events.
+
+However, there are a couple of caveats to be aware of:
+
+ 1. Attio will process these events asynchronously, which means it might take a few
+ seconds between Attio acknowledging the request and the record updates appearing in
+ your Attio workspace.
+
+ 2. Invalid events will be silently dropped. This can happen if your mapping
+ configuration points to a non-existent Attio attribute, or you're trying to write the
+ wrong attribute type (for example: writing a number to a domain attribute). We recommend you
+ continue to use the **Send test event** feature on the mapping page to check
+ configurations before saving them.
+
+## Attribute types
+
+The Attio Action can write all types of attribute to Attio. Below is an example of the
+format that each attribute must be; please note that you'll get validation failures if any
+of these are incorrect. To unset an attribute, you can also pass `null` as the value.
+
+| `type` | Format | Example values |
+|----------------------|-----------------------------------------------------------------------------------------|-------------------------------------------------------------|
+| `actor-reference` | An email address of a workspace member | `"alice@attio.com"` |
+| `checkbox` | Boolean | `true`, `false` |
+| `currency` | Number with up to 4 decimal places | `99`, `29.9999` |
+| `date` | YYYY-MM-DD | `"2023-09-28"` |
+| `domain` | `{domain}.{tld}` | `"app.attio.com"`, `"www.example.com"` |
+| `email` | A valid email address | `"person@example.com"` |
+| `location` | String with all valid address parts (street address, city, state, country, and postal code) combined | "1 Infinite Loop, Cupertino, CA, US" |
+| `number` | Number, stored as a 64 bit float | `42.192`, `17` |
+| `personal-name` | Last name(s), First name(s) *(note the comma in the middle)* | `"Bloggs, Joe"` |
+| `phone-number` | [E.164 format](https://en.wikipedia.org/wiki/E.164), starting with `+...` | `"+15558675309"` |
+| `pipeline` | A UUID or title representing the status | `"open"`, `"closed"` |
+| `rating` | Integer from 0 to 5 | `0`, `5` |
+| `record-reference` | To a person, an email. To a company, a domain. UUID of other entity always supported. | `"person@example.com"`, `"app.attio.com"`, `"0677efa..."` |
+| `select` | A UUID or title representing the option | `"open"` |
+| `text` | String | `"A piece of text"` |
+| `timestamp` | ISO8601, e.g. YYYY-MM-DDTHH:MM:SS | `"2023-09-28 04:39:17.000"` |
diff --git a/src/connections/destinations/catalog/actions-blend-ai/index.md b/src/connections/destinations/catalog/actions-blend-ai/index.md
index 8116e0b56e..2e1892a274 100644
--- a/src/connections/destinations/catalog/actions-blend-ai/index.md
+++ b/src/connections/destinations/catalog/actions-blend-ai/index.md
@@ -8,10 +8,7 @@ id: 64244158b33d1380a79dc85c
[Blend-AI](https://blnd.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} identifies the most valuable product interaction in your product data and cross references it with new incoming leads.
-Blend-AI maintains this destination. For any issues with the destination, [contact their Support
-team](mailto:support@blnd.ai).
-
-{% include content/ajs-upgrade.md %}
+Blend-AI maintains this destination. For any issues with the destination, [contact their Support team](mailto:support@blnd.ai).
## Getting started
diff --git a/src/connections/destinations/catalog/actions-braze-cloud/index.md b/src/connections/destinations/catalog/actions-braze-cloud/index.md
index 819a866821..29ef730c8f 100644
--- a/src/connections/destinations/catalog/actions-braze-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-braze-cloud/index.md
@@ -6,7 +6,7 @@ hidden: true
---
{% include content/plan-grid.md name="actions" %}
-[Braze](https://www.braze.com/), formerly Appboy, is an engagement platform that empowers growth by helping marketing teams to build customer loyalty through mobile, omni-channel customer experiences.
+[Braze](https://www.braze.com/){:target="_blank”}, formerly Appboy, is an engagement platform that empowers growth by helping marketing teams to build customer loyalty through mobile, omni-channel customer experiences.
> success ""
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Braze Segment destination. There's also a page about the [non-Actions Braze destination](/docs/connections/destinations/catalog/braze/). Both of these destinations receives data _from_ Segment. There's also the [Braze source](/docs/connections/sources/catalog/cloud-apps/braze//), which sends data _to_ Segment!
@@ -20,20 +20,22 @@ Braze Cloud Mode (Actions) provides the following benefit over Braze Classic:
## Getting Started
1. From the Segment web app, click **Catalog**.
-2. Search for "Braze" in the Catalog, select **Braze Cloud Mode (Actions)**, and choose which of your sources to connect the destination to.
-3. Add the following Connection Settings:
+2. Search for "Braze" in the Catalog, select **Braze**, and choose which of your sources to connect the destination to.
+3. Select "Actions" under the Destination framework options.
+4. Add the following Connection Settings:
- **API Key**: Created under Developer Console in the Braze Dashboard.
- **App ID**: The app identifier used to reference specific Apps in requests made to the Braze API. Created under Developer Console in the Braze Dashboard.
- **REST Endpoint**: Your Braze REST Endpoint. For more information, see [API Overview](https://www.braze.com/docs/api/basics/){:target="_blank"} in the Braze documentation.
+## Batching data to Braze
+
+You can batch data sent to Braze within Cloud Mode Actions. Batch sizes are capped at 75 events, and these batches will accumulate over a 30-second period before being flushed. Request batching is done per-action mapping. For example, Identify calls (attributes) will be batched in a request, and Track calls (custom events) will be batched in a second request. Braze recommends enabling this feature as it reduces the number of requests being sent from Segment to Braze, reducing the risk of the destination hitting Braze rate limits and retrying requests.
{% include components/actions-fields.html %}
## Migration from Braze Classic
-{% include content/ajs-upgrade.md %}
-
Keep the following in mind if you plan to move to Braze (Actions) from the classic Braze destination.
{% include components/actions-map-table.html name="braze-cloud" %}
diff --git a/src/connections/destinations/catalog/actions-braze-cohorts/index.md b/src/connections/destinations/catalog/actions-braze-cohorts/index.md
index 339f77ffcf..21b46b7286 100644
--- a/src/connections/destinations/catalog/actions-braze-cohorts/index.md
+++ b/src/connections/destinations/catalog/actions-braze-cohorts/index.md
@@ -37,6 +37,7 @@ To connect the Braze Cohorts destination:
10. Under Select mappings, input the Audience Key you copied in Step 2 as the “Segment Engage Audience Key.” Do not change any other defaults. Click **Save** and toggle to enable the mapping.
* **Note:** Users can be added or removed from cohorts through `ExternalId`, `DeviceId`, or the `UserAlias` object. The priority is `ExternalId`, then `DeviceId`, and finally `UserAlias` if all are provided.
* The Audience Key must be manually entered to ensure users in the Engage Audience are sent to the correct cohort in Braze. For every Engage Audience you want to send to Braze, a separate **Sync Audience** mapping must be created. You can create up to 50 mappings within an instance of the Braze Cohorts destination.
+ * Create the mapping with trigger conditions: `Event Name` is `Audience Entered/Exited` and `Event Property` `audience_key` is ``. Hardcode the audience key in the "Segment Engage Audience Key" field of the mapping.
11. Navigate back to **Engage > Audiences** and click on the Audience from Step 1.
@@ -46,7 +47,24 @@ The setup is complete and the Audience will start syncing to Braze Cohorts. Segm
To sync additional Audiences from your Engage space, create a separate mapping in the Braze Cohorts destination. Navigate to **Connections > Destinations**, search and select the Braze Cohorts destination, and follow Steps 9-11 above.
+If you are creating multiple mappings in one Braze Cohorts destination, Segment recommends clearing the default subscription for all your mappings from `Event Name is Audience Entered or Event Name is Audience Exited` to `Event Property audience_key is `, replacing `` with the Audience Key copied as per step 2 above.
+
> info ""
> A user can only be added to a cohort if the user already exists in Braze. This means that the Braze Cohorts destination should be used in parallel with the [Braze Cloud Mode (Actions) destination](/docs/connections/destinations/catalog/braze-cloud-mode-actions/) or the [Braze Web Mode (Actions) destination](/docs/connections/destinations/catalog/braze-web-device-mode-actions/), both of which can create users in Braze.
{% include components/actions-fields.html settings="true"%}
+
+### Supplementing audience payloads
+
+Event payloads sent using Computed Traits and Audiences will only contain the computed trait or audience key in question, in addition to the user identities `userId`, `anonymousId` and `email`. If you need supplemental fields from user profiles to map to Braze, consider using an Insert Function with the Engage Profile API. Using the Profile API, you can pull a user's traits from your Engage space within your insert function code before the event hits the destination. You can then use these traits to enrich the event payload sent to the destination.
+
+When dealing with event payloads transmitted through Computed Traits and Audiences, keep in mind that these payloads typically include only the specific computed trait or audience key in question in addition to user identities such as `userId` and `anonymousId`, as well as `email` if available. View [event destinations](/docs/engage/using-engage-data/#event-destinations) for more information.
+
+If you need to include additional fields from user profiles into your mappings, you can achieve this by using an [insert function](/docs/connections/functions/insert-functions/) with the [Engage Profile API](/docs/unify/profile-api/). With the Profile API, you can retrieve the traits associated with a user from your Engage space within your insert function code, all before the event reaches the Braze Cohorts destination.
+
+### Braze Device ID
+
+If you would like to use the `Device ID` mapping for the Cohort Destination you will need to ensure you have captured the Braze device_id, which is not the same as the Segment device_id. Braze has some methods (linked below) that customers can use to capture the Braze device_id for use in the above workaround:
+- [Swift method](https://braze-inc.github.io/braze-swift-sdk/documentation/brazekit/braze/deviceid/)
+- [Android method](https://braze-inc.github.io/braze-android-sdk/kdoc/braze-android-sdk/com.braze/-i-braze/device-id.html)
+- [Web method](https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html#getdeviceid)
diff --git a/src/connections/destinations/catalog/actions-braze-web/index.md b/src/connections/destinations/catalog/actions-braze-web/index.md
index 1febe6356d..a1e3f46a3f 100644
--- a/src/connections/destinations/catalog/actions-braze-web/index.md
+++ b/src/connections/destinations/catalog/actions-braze-web/index.md
@@ -8,9 +8,6 @@ hidden: true
[Braze](https://www.braze.com/){:target="_blank"}, formerly Appboy, is an engagement platform that empowers growth by helping marketing teams to build customer loyalty through mobile, omni-channel customer experiences.
-
-
-
> success ""
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Braze Segment destination. There's also a page about the [non-Actions Braze destination](/docs/connections/destinations/catalog/braze/). Both of these destinations receives data _from_ Segment. There's also the [Braze source](/docs/connections/sources/catalog/cloud-apps/braze/), which sends data _to_ Segment.
@@ -23,8 +20,10 @@ Braze Web Mode (Actions) provides the following benefits over Braze Classic:
## Getting Started
1. From the Segment web app, click **Catalog**.
-2. Search for "Braze" in the Catalog, select **Braze Web Mode (Actions)**, and choose which of your sources to connect the destination to.
-3. Configure the Connection Settings. **API Key** and **SDK Endpoint** are required settings.
+2. Search for "Braze" in the Catalog, select **Braze**, and choose which of your sources to connect the destination to.
+ - Note that if you do not select a Javascript source, you will not see the option to select the Device mode version of the destination.
+3. Select "Actions" and "Device mode" under the Destination framework and Connection mode options.
+4. Configure the Connection Settings. **API Key** and **SDK Endpoint** are required settings.
{% include components/actions-fields.html name="braze-web" connection="true" %}
@@ -165,8 +164,6 @@ For more details on this snippet, see Braze's documentation [here](https://www.b
## Migration from Braze Classic
-{% include content/ajs-upgrade.md %}
-
Keep the following in mind if you plan to move to Braze (Actions) from the classic Braze destination.
{% include components/actions-map-table.html name="braze-web" %}
diff --git a/src/connections/destinations/catalog/actions-canny/index.md b/src/connections/destinations/catalog/actions-canny/index.md
new file mode 100644
index 0000000000..40a617a386
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-canny/index.md
@@ -0,0 +1,33 @@
+---
+title: Canny (Actions) Destination
+id: 6489bbade6fe3eb57c13bd6a
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Canny](https://canny.io?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a single place for all customer feedback. It saves you time managing all the feedback while keeping your customers in the loop. Let your customers post and vote on feedback from within your website or mobile app. You'll get an organized list of feedback that you can use to inform your roadmap.
+
+Canny maintains this destination. For any issues with the destination, [contact the Canny Support team](mailto:segment-help@canny.io).
+
+> success ""
+> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Canny Segment destination. There's also a page about the [non-Actions Canny destination](/docs/connections/destinations/catalog/canny/). Both of these destinations receive data from Segment.
+
+## Benefits of Canny (Actions) vs Canny Classic
+
+Canny (Actions) provides the following benefit over the classic Canny destination:
+- **Group Events**. Canny (Actions) supports group events and updates or adds properties to companies.
+
+## Getting started
+
+1. Go to your [Canny Admin Segment Settings](https://canny.io/redirect?to=%2Fadmin%2Fsettings%2Fsegment){:target="_blank"}.
+2. Install the integration to get your API key.
+3. From the Segment web app, navigate to **Connections > Catalog**, then select the **Destinations** tab in the catalog.
+4. Search for **Canny (Actions)** and select it.
+5. Click **Configure Canny (Actions)**.
+6. Select an existing Source to connect to Canny (Actions).
+7. Enter your configuration settings.
+8. Enter the Canny API key in the Canny (Actions) destination settings.
+9. Enable the destination and save changes.
+
+{% include components/actions-fields.html %}
+
diff --git a/src/connections/destinations/catalog/actions-chartmogul/index.md b/src/connections/destinations/catalog/actions-chartmogul/index.md
new file mode 100644
index 0000000000..4359123138
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-chartmogul/index.md
@@ -0,0 +1,36 @@
+---
+title: ChartMogul (Actions) Destination
+id: 65f9888628c310646331738a
+beta: true
+---
+
+
+{% include content/plan-grid.md name="actions" %}
+
+[ChartMogul](https://chartmogul.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a subscription analytics platform and CRM used by thousands of businesses to measure, understand, and grow their recurring revenue businesses.
+
+This destination is maintained by ChartMogul. For any issues with the destination, [contact their Support team](https://help.chartmogul.com/hc/en-us/requests/new){:target="_blank"}.
+
+## Getting started
+
+1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for "ChartMogul".
+2. Select ChartMogul and click **Add Destination**.
+3. Select an existing Source to connect to ChartMogul (Actions).
+4. [Create a source](https://app.chartmogul.com/#/data-platform/sources/add-source){:target="_blank"} in ChartMogul.
+5. Make sure the **Account / Contact / Enrichment data** tab is selected and click **Twilio Segment**.
+6. Enter the **Name** for your source.
+7. Under **Create a company in ChartMogul when** select:
+ - **the email or UserID is created** — if you recognize any individual who interacts with your organization as a lead and want to create a [customer record](https://help.chartmogul.com/hc/en-us/articles/214085765){:target="_blank"} for them
+ - **user is added to a company** — if you recognize an individual who interacts with your organization as a lead only if they're part of an organization
+8. Copy the **Webhook URL**.
+9. Click **SAVE AND CONTINUE CONFIGURATION IN SEGMENT**.
+10. Paste the **Webhook URL** in the ChartMogul destination settings in Segment.
+
+{% include components/actions-fields.html %}
+
+## Supported event calls
+ChartMogul (Actions) accepts two types of event calls:
+- [Track](https://segment.com/docs/connections/spec/track/){:target="_blank"} — used for contact details and custom attributes
+- [Group](https://segment.com/docs/connections/spec/group/){:target="_blank"} — used for customer details and custom attributes
+
+ChartMogul uses attributes from these calls to create new or update existing [custom attributes](https://help.chartmogul.com/hc/en-us/articles/206120219){:target="_blank"} for contacts or customers, or to update customers' select [standard attributes](https://help.chartmogul.com/hc/en-us/articles/5321255006364#standard-attributes){:target="_blank"}.
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-clevertap/index.md b/src/connections/destinations/catalog/actions-clevertap/index.md
index e8eb9843e0..04f3deb680 100644
--- a/src/connections/destinations/catalog/actions-clevertap/index.md
+++ b/src/connections/destinations/catalog/actions-clevertap/index.md
@@ -1,5 +1,5 @@
---
-title: CleverTap (Actions)
+title: CleverTap (Actions) Destination
hide-boilerplate: true
hide-dossier: true
id: 61d7456b078e79929de4ee8c
@@ -8,11 +8,6 @@ id: 61d7456b078e79929de4ee8c
{% include content/plan-grid.md name="actions" %}
-
-
-{% include content/ajs-upgrade.md %}
-
-
[CleverTap](https://clevertap.com/){:target="_blank"} is a retention cloud that empowers digital consumer brands to increase customer retention and lifetime value. CleverTap drives contextual individualization with the help of a unified and deep data layer, AI/ML-powered insights, and automation enabling brands to offer hyper-personalized and delightful experiences to their customers.
## Advantages of CleverTap (Actions) Destination
diff --git a/src/connections/destinations/catalog/actions-commandbar/index.md b/src/connections/destinations/catalog/actions-commandbar/index.md
index 1e9413aaf1..98b5dd285c 100644
--- a/src/connections/destinations/catalog/actions-commandbar/index.md
+++ b/src/connections/destinations/catalog/actions-commandbar/index.md
@@ -9,9 +9,6 @@ id: 638f843c4520d424f63c9e51
To configure CommandBar as an Event Source to get data into your warehouse or other downstream tools, see the [CommandBar Source](/docs/connections/sources/catalog/cloud-apps/commandbar/) documentation.
-{% include content/ajs-upgrade.md %}
-
-
## Getting started
1. From the Segment web app, navigate to **Connections > Catalog**, then select the **Destinations** tab at the top of the catalog.
diff --git a/src/connections/destinations/catalog/actions-cordial/index.md b/src/connections/destinations/catalog/actions-cordial/index.md
index 4172c3201d..c12e2407f5 100644
--- a/src/connections/destinations/catalog/actions-cordial/index.md
+++ b/src/connections/destinations/catalog/actions-cordial/index.md
@@ -7,7 +7,7 @@ hide-dossier: true
{% include content/plan-grid.md name="actions" %}
-[Cordial](https://cordial.com/) is an all-in-one marketing platform that enables brands to collect, normalize, and activate real-time data from anywhere in your technology stack to create and deliver tailored messages that flex and adapt to changing customer signals.
+[Cordial](https://cordial.com/){:target="_blank”} is an all-in-one marketing platform that enables brands to collect, normalize, and activate real-time data from anywhere in your technology stack to create and deliver tailored messages that flex and adapt to changing customer signals.
> info "Good to know"
> This page is about the [Actions-framework](/docs/connections/destinations/actions/) Cordial Segment destination. There's also a page about the [non-Actions Cordial destination](/docs/connections/destinations/catalog/cordialio/). Both of these destinations receive data from Segment.
diff --git a/src/connections/destinations/catalog/actions-display-video-360/index.md b/src/connections/destinations/catalog/actions-display-video-360/index.md
new file mode 100644
index 0000000000..1051eb0650
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-display-video-360/index.md
@@ -0,0 +1,239 @@
+---
+title: Display and Video 360 (Actions) Destination
+strat: google
+hide-settings: true
+id: 65302a3acb309a8a3d5593f2
+beta: true
+engage: true
+---
+
+> info ""
+> Display and Video 360 (Actions) operates using third-party cookies, and its match rates are influenced by the extent to which these cookies are supported by browsers.
+
+Google's [Display & Video (DV360)](https://marketingplatform.google.com/about/display-video-360/){:target="_blank"} service is an end-to-end campaign management tool that enables enterprise customers to plan, measure, and run display and video advertisements.
+
+> info ""
+> You can connect to a Google Ad Manager account. For more information, see [Create an audience and finish DV360 configuration](#create-an-audience-and-finish-dv360-configuration) below. Set **User-Role Granted** to `Publisher` if you plan to connect to Google Ad Manager.
+
+Segment's integration with DV360 enables Segment customers to sync audiences created in Engage with DV360 for centralized audience management and improved retargeting.
+
+> warning ""
+> You must meet certain implementation criteria to use the DV360 integration:
+> - For web traffic, you must have a client-side `analytics.js` source.
+> - For mobile app traffic, you must have a mobile source.
+
+> info ""
+> Since the release of `analytics-ios` version 4, Segment no longer collects IDFA automatically. To collect and pass IDFA to your DV360 integration, follow the steps for Ad Tracking and IDFA in the [Analytics-iOS mobile source](/docs/connections/sources/catalog/libraries/mobile/ios#ad-tracking-and-idfa) documentation.
+
+> info "Consent mode"
+> Google enforced consent on March 6, 2024 for European Economic Area (EEA) users. Learn more about [consent mode](/docs/connections/destinations/catalog/actions-display-video-360/#consent-mode) and how to set it up.
+
+## Details
+
+> info ""
+> For users detected to originate from US states with privacy restrictions, using a Google User ID to populate user lists is deprecated, and will be eventually sunset. It's recommended that bidders populate user lists with their hosted match data for these users.
+
+Keep the following settings and requirements in mind as you set up your DV360 (Actions) Destination.
+
+- **Audience appears as**: An audience list with the name of your Engage Audience on the **DV360 All Audiences** screen
+- **Destination rate limit**: None
+- **Lookback window allowed**: 30 days
+- **Historical backfill supported**: No
+- **Identifiers required (one of the following)**:
+ - `idfa` (iOS)
+ - `advertisingId` (Android)
+ - `anonymousId` (Web)
+- **Connection type**:
+ - Client-side (DoubleClick Floodlight)
+ - Server-side (DV360)
+- **Aliasing supported**: No
+
+- **Requirements**:
+ - Business tier Segment customers with Engage
+ - One of the following sources, depending on type:
+ - For web: analytics.js
+ - For mobile app: a mobile source that passes an advertising identifier
+ - A Google Marketing Platform account
+
+## Components
+
+The Segment DV360 integration uses two components, the [DoubleClick Floodlight tag](/docs/connections/destinations/catalog/doubleclick-floodlight/) and Display & Video 360 (Actions) integration.
+
+### DoubleClick Floodlight tag
+
+Segment users must add this tag to their web properties. The tag performs several functions, but when enabled for the DV360 integration, it allows Segment to send information about users directly to Google client-side.
+
+> info ""
+> This component is required only if you want to sync audiences based on web traffic.
+
+### DV360 destination
+
+The DV360 Destination syncs audience data between Segment and Google Display & Video 360. For more information about enabling the DV360 Destination, [view the setup instructions below](#set-up) below.
+
+## Set up the DV360 Destination
+
+Configuring this integration requires action by both you in your Segment workspace, and Google in your Google Marketing Platform account. As a result, the time required to finish configuration and setup can vary.
+
+### Configure client integration for web traffic
+
+> info ""
+> This step is necessary only if you want to use Google User IDs to build audiences based on website traffic. If you plan to use mobile identifiers only, continue to [Enable and configure the DV360 Destination](enable-and-configure-the-dv360-destination).
+
+Segment requires the [DoubleClick Floodlight](/docs/connections/destinations/catalog/doubleclick-floodlight/) tag on your website to enable the creation of audiences based on website traffic. This allows Segment to send Google the appropriate identifier (typically `anonymousId`) for users that are in an audience. Google stores these identifiers on its servers and matches them against `google_id`.
+
+To configure DoubleClick Floodlight:
+
+> warning ""
+> **Prerequisite**: Create a [JavaScript Website](/docs/connections/sources/catalog/libraries/website/javascript/) source in your Segment workspace if one does not exist. Ensure that this source is configured to track visitors to your website. For more information about configuring Javascript sources, see the [Analytics.js Quickstart guide](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/).
+
+1. In your workspace, visit the **Catalog** and search for the **DoubleClick Floodlight** Destination.
+2. Connect your JavaScript website source to the DoubleClick Floodlight destination, and configure the following settings:
+ 1. **Get DoubleClickID**: `On`
+ 2. **Google Network Id**: `segment`
+ 3. Your [Segment write key](/docs/connections/find-writekey/). You can retrieve your write key from the Settings tab in the source.
+ 4. **DoubleClick Advertiser ID**
+ - If you use DoubleClick Floodlight for DV360 only, enter `DV360`.
+ - If you use DoubleClick Floodlight for other use cases in addition to DV360, enter the Advertiser ID from your Doubleclick Floodlight account.
+3. Switch the toggle to enable the destination.
+
+### Enable and configure the DV360 Destination
+
+1. From your Segment workspace, navigate to **Engage > Engage Settings > Destinations > Add Destination**, then search for **Display and Video 360 (Actions)**.
+2. Authenticate using OAuth. Segment asks for permissions to see, edit, create and delete your Audience Partner account data.
+3. Switch the toggle to enable the destination.
+4. Navigate to the **Mappings** tab, click **Add Mapping** and select **Add to Audience**.
+5. Click **Save** and make sure to enable the mapping.
+6. On the **Mappings** tab, click **Add Mapping** and select **Remove from Audience**.
+7. Click **Save** and make sure you enable the mapping.
+
+> info ""
+> The destination does not have configurable settings until you create an audience, described [here](#create-an-audience-and-finish-dv360-configuration).
+
+### Create an audience and finish DV360 configuration
+
+[Create an audience](/docs/personas/audiences) in a new or existing Engage space. After you create the audience, you can select the Display & Video 360 (Actions) Destination you created before.
+
+> info ""
+> These settings are tied to a single audience. Each additional audience you send to DV360 requires you to input these values.
+
+When you select the destination, you're prompted to enter the destination settings:
+
+| Setting | Description |
+| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Account Type | The type of DV360 account used to sync. Either `Advertiser`, `Partner`, or `Publisher`. **Note:** Select `Publisher` only if you plan to connect to Google Ad Manager. |
+| Advertiser ID | The ID of your DV360 Advertiser account. Can be found in your Google Account under **Advertiser Settings > Basic Details > Advertiser ID**. |
+
+You'll also need to toggle on the Send Track setting.
+
+
+After you complete the set up process, allow up to 24 hours for Google to create the new audience list. Once the list is created, Segment can begin to sync users to that list. Google may require additional time to process the initial audience additions. The entire first sync to DV360 may require 24-48 hours to complete. As a result, the first few audience syncs after you create the audience may fail.
+
+{% include content/sync-frequency-note.md %}
+
+## Migrate from Personas Google Display & Video 360 Destination
+
+Segment will copy all of your existing Personas Display & Video 360 Destination configurations to Display and Video 360 (Actions). Once the migration is completed , you will be notified by email.
+
+
+As of April 2, 2024, Segment no longer requires you to re-authenticate for existing Personas Display & Video 360 destinations. Segment, as an External Data Partner, now uses a set of Segment DMP credentials to authenticate on your behalf. To add Segment as an External Data Partner, open Advertiser Settings, navigate to Linked Accounts, and then enable “Segment DMP”.
+
+Segment is disabling all existing Personas Display and Video 360 destinations. You can still access your existing configuration, but please refrain from enabling the destination, as it is set to be deprecated. You will no longer be able to create new instances of Personas Display and Video 360.
+
+
+
+
+## Consent mode
+[Consent mode](https://support.google.com/analytics/answer/9976101?hl=en){:target="_blank"} is a feature provided by Google in the context of its products, particularly the Gtag library and Google Analytics. As of March 6, 2024, Google announced that consent mode must function for European Economic Area (EEA) users, otherwise data from EEA users won't process.
+
+Consent mode in the Gtag library and Google Analytics is designed to help website owners comply with privacy regulations, such as the General Data Protection Regulation (GDPR) in the European Union. It allows website owners to adjust how these tools use and collect data based on user consent.
+
+With consent mode, you can configure your website to dynamically adjust the tracking behavior of the Gtag library and Google Analytics based on the user's consent status. If a user provides consent to data processing, both the Gtag library and Google Analytics can collect and use that data for analysis. If a user doesn't provide consent, both tools limit data collection to essential functions, helping businesses respect user privacy preferences.
+
+Segment automatically sends consent as `TRUE` for this destination. Segment uses the [bulk-uploader workflow](https://developers.google.com/authorized-buyers/rtb/bulk-uploader#workflow){:target="_blank"} which requires consented data. Ensure all audiences and journeys are connected to consented audiences.
+
+{% include components/actions-fields.html %}
+
+## FAQ
+### What is Segment's relationship with Google DV360 and is the data that Segment sends considered to be First or Third party?
+
+Google considers Segment to be a DMP or Data Onboarder. Audience information pushed from Segment to your DV360 account is considered to be **First-Party** data.
+
+
+### When will my data appear in DV360?
+
+When you complete the connection between Segment and DV360, it can take from 24 to 48 hours for Google to create the user list. This must complete before Segment can begin to sync users into that list.
+
+
+### What identifiers are needed to enable this integration?
+
+Google's [documentation](https://developers.google.com/authorized-buyers/rtb/downloads/cookie-bulk-upload-proto){:target="_blank"} provides information about the accepted identifiers for this integration.
+
+
+- To use DV360 with web traffic, you must collect `anonymous_id` through the client-side `analytics.js` source.
+- To use DV360 with mobile traffic, you must collect `IDFA`s through Segment's mobile sources.
+
+
+### Why is my audience in DV360 smaller than the audience that I see in Engage? What affects match rates?
+
+Match rates may differ between Engage and DV360 for the following reasons:
+
+#### Go-forward data
+
+When you first preview and create an audience in Engage, the audience may contain many audience members. This is more likely if you select the **Historical Backfill** option. This does not reflect the audience that syncs to DV360 for the following reasons:
+
+
+1. During an audience sync, Segment sends a list of `anon_id` values to Google. Google attempts to match those values in their match table, to find an associated `google_user_id`.
+2. To complete this lookup, Google must have both the `anon_id` and have it store along side a matched `google_user_id`. This occurs when a user visits your website with both the Doubleclick Floodlight tag installed, and the DV360 integration completed.
+
+As a result, you must have Doubleclick Floodlight and the DV360 integration in place before Google can match users and make them available for retargeting.
+
+To help reduce the difference between Engage and DV360 audience sizes, Segment recommends that you deselect the `Historical Backfill` option when you create the audience that syncs to DV360.
+
+#### Impact to third-party cookies: browser policies
+
+The DV360 integration for web traffic relies on Doubleclick Floodlight, which itself relies on a `google_user_id` cookie. While this cookie is “yours”, browsers treat this as a third-party cookie because it is served from Google's servers, and not the same domain as your website. As browsers become more privacy-oriented, they block third-party cookies by default.
+
+Users who visit your website in Firefox and Safari, and who do not specifically allow third-party cookies, are not identifiable by Doubleclick Floodlight (`google_user_id`). This prevents Google from identifying a match between an `anon_id` sent from Segment, and results in lower match rates.
+
+#### Impact to third-party cookies: adblockers
+
+All browser-based adblocking software intentionally blocks most third-party cookies, including the Doubleclick Floodlight cookie necessary for identification. As a result, Google cannot match users who employ adblocking software in their browsers.
+
+#### IDFA impact: recent Apple announcements
+
+Apple has announced an updated privacy policy that, while not rolled out yet, impacts the way businesses collect IDFA data. When enacted, this privacy policy will significantly reduce the percentage of users for which IDFA data is collected. This change will result in lower match rates, as both Segment and Google will see a decline in the number of IDFA values sent by Segment, and matched by Google.
+
+#### Invalid Google IDs
+
+Sometimes, Google denies IDFA or `google_user_id` values when they consider them to be invalid or inactive.
+
+#### Modifying list configuration in DV360
+
+Any changes to a DV360 list's configuration (for example, modifying the membership expiration from 540 days to a value that matches the time window on the audience) is **very risky** and **will likely** cause mismatches between Engage audiences and the lists in Google. Segment ensures that the integration works successfully only if there are no changes made to the configurations in DV360. DV360 lists are created with parameters that are known to be compatible with Engage. Configurations that differ from Segment's can cause mismatches by removing more users than intended, or by not accepting valid uploads.
+
+
+### Why is the audience size larger in DV360 than in Engage?
+
+Engage syncs every IDFA or `anonymous_id` value for each user in an audience. When DV360 receives this data, it does not de-duplicate in the event that multiple identifiers map to the same unique user. This may result in a larger audience list in Google compared to Engage.
+
+
+### Why don't I see matches in DV360?
+
+The most common cause of matches not appearing in DV360 is an error with Doubleclick Floodlight. From the website where tracking is enabled, open the Network inspector, and confirm that outgoing requests to `idsync.segment.com` appear.
+
+
+### How does third-party cookie eradication impact the DV360 Destination?
+
+Google Chrome has committed to replacing third-party cookies with an alternative, but has not announced a timeframe for that alternative. Segment will not update this integration until these updates from Google are announced.
+
+
+### Can I use Engage audiences to target YouTube ads with this integration?
+
+No. YouTube (through DV360) does not support the type of lists that Segment provides.
+
+### Why do I see destination settings after I add my audience, but not when I first enable the destination?
+
+The DV360 Destination works on a per-audience basis. This enables you to:
+
+- Send data from different audiences to different DV360 accounts.
+- Send data to Google Ad Manager with the same destination.
diff --git a/src/connections/destinations/catalog/actions-emarsys/index.md b/src/connections/destinations/catalog/actions-emarsys/index.md
index 334b8a11b6..043f4a351e 100644
--- a/src/connections/destinations/catalog/actions-emarsys/index.md
+++ b/src/connections/destinations/catalog/actions-emarsys/index.md
@@ -2,12 +2,11 @@
title: Emarsys (Actions) Destination
hide-boilerplate: true
hide-dossier: false
-private: true
-hidden: true
+beta: true
id: 63f65c1c42e3bded41f0499c
versions:
- name: Emarsys (Classic)
- link: /docs/connections/destinations/emarsys
+ link: /docs/connections/destinations/catalog/emarsys/
---
{% include content/plan-grid.md name="actions" %}
diff --git a/src/connections/destinations/catalog/actions-equals/index.md b/src/connections/destinations/catalog/actions-equals/index.md
new file mode 100644
index 0000000000..4416280fde
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-equals/index.md
@@ -0,0 +1,33 @@
+---
+title: Equals Destination
+beta: true
+id: 659eb6903c4d201ebd9e2f5c
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Equals](https://equals.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is the only spreadsheet with built-in connections to any database, versioning, and collaboration. Connect your Segment data to Equals and build dashboards or your revenue reports, CAC/LTV analyses, top of funnel conversions, and more based on live data.
+
+This destination is maintained by Equals. For any issues with the destination, [contact their Support team](mailto:help@equals.com).
+
+Equals enables anyone, regardless of technical ability, to set up live dashboards and reports that push to Slack, email or Google Slides directly from live Segment event data.
+
+## Getting started
+
+Follow the instructions below, or on [Equals' Segment Connection Guide](https://help.equals.com/en/articles/8688872-segment-connection-guide){:target="_blank”} to get started.
+Note that Segment is an Enterprise Connection; you will be prompted to schedule a call with an Equals team member after step 2 in the instructions below.
+
+1. Use your Email Address to sign in to [Equals](https://go.equals.com){:target="_blank”}.
+2. Navigate to the [Data Sources page](https://go.equals.com/datasources/new){:target="_blank”}, then select 'Segment'.
+3. Click the 'Connect to Segment' button.
+4. On the popup screen, copy the URL. It will be used in a later step.
+5. Click the Save button on the popup, then click the Save button on the Equals page.
+6. From your Segment workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Equals".
+7. Select Equals and click **Add Destination**.
+8. Select an existing Source to connect to Equals.
+9. Name your Destination.
+10. On the Destination's Settings page, paste in the Equals URL from step 4 then turn on the 'Enable Destination' using the toggle.
+11. Click the Save Changes button.
+12. Optionally, to configure the data to be sent to Segment, navigate to the Mappings tab and edit the 'Send' Mapping.
+
+{% include components/actions-fields.html %}
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-facebook-conversions-api/images/app_data.png b/src/connections/destinations/catalog/actions-facebook-conversions-api/images/app_data.png
new file mode 100644
index 0000000000..50eb6880ae
Binary files /dev/null and b/src/connections/destinations/catalog/actions-facebook-conversions-api/images/app_data.png differ
diff --git a/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md b/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md
index 8d313a9e74..73f6c999ee 100644
--- a/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md
+++ b/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md
@@ -116,6 +116,26 @@ If you choose this option, each source sends different events, and deduplication
Use this approach if you don't want to track users from the browser with Facebook Pixel. By default, Facebook Pixel collects cookie data, as well as browser data such as the IP Address and the User Agent, some of which you might not want to collect. By sending from a Segment server source to Facebook's Conversions API, you can control which identifiers you pass to Facebook.
+### Send app events
+
+App events may be sent through the Conversions API by first setting up a dataset in your Facebook Events Manager. Learn more about passing app events through the Conversions API [here](https://developers.facebook.com/docs/marketing-api/conversions-api/app-events){:target="_blank"}. Learn how to create a dataset [here](https://www.facebook.com/business/help/750785952855662?id=490360542427371){:target="_blank"}.
+
+#### Configuring app events
+Sending app events requires the `action_source` parameter to be set to `app`.
+
+App events usage is opt-in, and you're required to set the `use_app_data` field to `Yes` before sending app data.
+
+Additionally, configure the "App Events Fields" object with the required fields:
+* `advertiser_tracking_enabled`
+* `application_tracking_enabled`
+* `version`
+* `osVersion`
+
+> info ""
+> The value for the **version** field should be `a2` for Android or `i2` for iOS, as stated in [Facebook's documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/app-events){:target="_blank"}.
+
+
+
#### Match rate considerations
If you use Facebook Conversions API as a stand-alone without certain data fields collected from the browser, the match rate might not be as high as if you included them. You can increase the match rate for events from a server source by including User Data, such as Zip Code, Country and State.
@@ -149,6 +169,26 @@ Segment creates a SHA-256 hash of the following fields before sending to Faceboo
If you use Facebook Pixel, the Pixel library also hashes the External ID. This means External IDs will match across Facebook Pixel and Facebook Conversions API if they use the External ID for [deduplication](https://developers.facebook.com/docs/marketing-api/conversions-api/deduplicate-pixel-and-server-events/#fbp-or-external-id){:target="_blank"}.
+### Double hashing PII data
+
+If you hash data before sending it to Segment, and then Segment applies its hashing, this could result in double hashing. Double hashing might make the data unusable for matching purposes on platforms like Facebook, which rely on specific hashing algorithms (like SHA-256) applied to the original PII to match users. If your data involves a lot of PII and PHI, Segment recommendeds that you send this data to Segment in its original, non-hashed format. You can then rely on Segment's privacy tools and destination-specific configurations to ensure that data is hashed appropriately when sent to destinations that require hashed PII. This approach helps maintain the integrity and usability of the data while ensuring privacy and compliance.
+
+### User data formatting
+
+Segment applies formatting to User Data Parameters as follows:
+
+| User Data Field | Formatting applied to field value before hashing |
+|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| External ID | All whitespace is removed from string, set to lowercase. |
+| Email | All whitespace is removed from string, set to lowercase. |
+| First Name, Last Name | All whitespace is removed from string, set to lowercase. |
+| Gender | All whitespace is removed from string, set to lowercase. "male" is set to "m", "female" is set to "f". |
+| Date of Birth | No formatting is applied. |
+| Phone | All whitespace is removed from string. |
+| Zip Code | All whitespace is removed from string. |
+| State | All whitespace is removed from string and the result is compared against a map object of states and their two-character ANSI abbreviation code. Example: "Texas", "TX", or "tx" in this field will be formatted as "tx". |
+| Country | All whitespace is removed from string and the result is compared against a map object of countries and their two-letter ISO 3166-1 alpha-2 country code. Example: "Germany", "germany", or "de" will be formatted as "de". |
+
### User Data Parameters
Segment automatically maps User Data fields to their corresponding parameters [as expected by the Conversions API](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters/){:target="_blank"} before sending to Facebook:
@@ -169,7 +209,7 @@ Segment automatically maps User Data fields to their corresponding parameters [a
### Server Event Parameter Requirements
-Facebook requires the `action_source` server event parameter for all events sent to the Facebook Conversions API. This parameter specifies where the conversions occur. If `action_source` is set to **website**, then the `client_user_agent` and the `event_source_url` parameters are also required. Events sent to the Conversions API that don't meet the requirements may not be available for optimization, targeting, or measurement.
+Facebook requires the `action_source` server event parameter for all events sent to the Facebook Conversions API. This parameter specifies where the conversions occur. If `action_source` is set to **website**, then the `client_user_agent` and the `event_source_url` parameters are also required. Events sent to the Conversions API that don't meet the requirements may not be available for optimization, targeting, or measurement. Facebook requires additional fields as well such as, Event Name, Event Type, and User Data. See the full list of required fields [here](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event/).
### Verify Events in Facebook
@@ -179,3 +219,11 @@ After you start sending events, you should start seeing them in twenty minutes.
2. Click on the corresponding pixel.
3. In the Overview tab, look for events where the “Connection Method” is Server.
+### Send multiple External IDs
+
+[Facebook](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/external-id/){:target="_blank"} allows you to send one External ID per payload as a string, or multiple per payload in an array of External ID strings. Send an array of External IDs through Segment by mapping an array to the `externalId` field when setting up your Actions mappings.
+
+### Not seeing events in Facebook
+
+Facebook releases updates to its platform regularly. Those updates can include new requirements for use of the Conversions API. Check Facebook's [Graph API Changelog](https://developers.facebook.com/docs/graph-api/changelog){:target="_blank”} to keep up to date with the current requirements.
+
diff --git a/src/connections/destinations/catalog/actions-friendbuy-cloud/index.md b/src/connections/destinations/catalog/actions-friendbuy-cloud/index.md
index 7d4c588bd9..98adee9a8d 100644
--- a/src/connections/destinations/catalog/actions-friendbuy-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-friendbuy-cloud/index.md
@@ -17,10 +17,10 @@ If you're using Segment with a Friendbuy referral program you probably want to u
The Friendbuy cloud mode destination sends information about your customers and their actions to Friendbuy. It supports the following [Friendbuy MAPI events](https://developers.friendbuy.com/#tracking-events){:target='_blank'}.
-- **Track Customer**: Converts Segment [Identify](/docs/connections/spec/identify/) calls to Friendbuy [*track customer* MAPI calls](https://developers.friendbuy.com/#tracking-customer-details). Use this to add your customer ID and other customer data to the information that Friendbuy has about the customer.
-- **Track Purchase**: Converts Segment [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) calls to Friendbuy [*track purchase* MAPI calls](https://developers.friendbuy.com/#tracking-a-purchase). Use this to send purchase data to Friendbuy and reward advocates based on their friends' purchases.
-- **Track Sign-Up**: Converts Segment [Signed Up](/docs/connections/spec/b2b-saas/#signed-up) calls to Friendbuy [*track sign_up* MAPI calls](https://developers.friendbuy.com/#tracking-a-signup). Use this to reward customers for account creation and other sign-up actions.
-- **Track Custom Event**: Converts an arbitrary Segment [`analytics.track`](/docs/connections/sources/catalog/libraries/website/javascript/#track) call with an event name and properties of your choosing to a Friendbuy [track custom event MAPI call](https://developers.friendbuy.com/#tracking-a-custom-event). Use this to reward your customers for actions other than purchases or sign-ups.
+- **Track Customer**: Converts Segment [Identify](/docs/connections/spec/identify/) calls to Friendbuy [*track customer* MAPI calls](https://developers.friendbuy.com/#tracking-customer-details){:target="_blank”}. Use this to add your customer ID and other customer data to the information that Friendbuy has about the customer.
+- **Track Purchase**: Converts Segment [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) calls to Friendbuy [*track purchase* MAPI calls](https://developers.friendbuy.com/#tracking-a-purchase){:target="_blank”}. Use this to send purchase data to Friendbuy and reward advocates based on their friends' purchases.
+- **Track Sign-Up**: Converts Segment [Signed Up](/docs/connections/spec/b2b-saas/#signed-up) calls to Friendbuy [*track sign_up* MAPI calls](https://developers.friendbuy.com/#tracking-a-signup){:target="_blank”}. Use this to reward customers for account creation and other sign-up actions.
+- **Track Custom Event**: Converts an arbitrary Segment [`analytics.track`](/docs/connections/sources/catalog/libraries/website/javascript/#track) call with an event name and properties of your choosing to a Friendbuy [track custom event MAPI call](https://developers.friendbuy.com/#tracking-a-custom-event){:target="_blank”}. Use this to reward your customers for actions other than purchases or sign-ups.
## Benefits of Friendbuy Cloud Mode (Actions) vs Friendbuy Classic
diff --git a/src/connections/destinations/catalog/actions-fullstory-cloud/index.md b/src/connections/destinations/catalog/actions-fullstory-cloud/index.md
index abf4731767..1375d276aa 100644
--- a/src/connections/destinations/catalog/actions-fullstory-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-fullstory-cloud/index.md
@@ -21,8 +21,10 @@ FullStory’s cloud mode destination requires that you also use FullStory’s ta
The FullStory cloud mode destination sends information about your users and related events to FullStory. It uses [FullStory’s REST APIs](https://developer.fullstory.com){:target="_blank"}.
-- **Identify User:** Converts Segment [Identify](/docs/connections/spec/identify/) calls to [FullStory Set User Properties API calls](https://developer.fullstory.com/set-user-properties){:target="_blank"}. Use this to set custom attributes which can be used to search and segment within FullStory.
+- **Identify User**: Converts Segment [Identify](/docs/connections/spec/identify/) calls to [FullStory Set User Properties API calls](https://developer.fullstory.com/set-user-properties){:target="_blank"}. Use this to set custom attributes which can be used to search and segment within FullStory.
- **Track Custom Event**: Converts Segment [Track](/docs/connections/spec/track/) calls to [FullStory custom event API calls](https://developer.fullstory.com/server-events){:target="_blank"}. Use this to capture more context about your user’s experience on your site or to capture user’s actions in other applications to build a more complete understanding of your user’s overall experience.
+- **Identify User V2**: Converts Segment [Identify](/docs/connections/spec/identify/) calls to [FullStory Create User API calls](https://developer.fullstory.com/server/v2/users/create-user/){:target="_blank"}. Use this to upsert a user and their attributes which can be used to search and segment within FullStory.
+- **Track Custom Event V2**: Converts Segment [Track](/docs/connections/spec/track/) calls to [FullStory Create Event API calls](https://developer.fullstory.com/server/v2/events/create-events/){:target="_blank"}. Use this to capture more context about your user’s experience on your site or to capture user’s actions in other applications to build a more complete understanding of your user’s overall experience.
### Benefits of FullStory Cloud Mode (Actions)
@@ -48,8 +50,15 @@ The FullStory cloud mode destination sends information about your users and rela
### Why am I getting a ‘404 Not Found’ error?
-The user for which the API request is being made can not be found in the identified set of users within your FullStory organization. If you expect that user to already exist, you can search for that User ID in FullStory to confirm. Also, double check that you are using an API key from the same organization.
+If you are using the original 'Identify User' and 'Track Event' actions and encounter a "404 Not Found" error, the user for which the API request is being made can not be found in the identified set of users within your FullStory organization. If you expect that user to already exist, you can search for that User ID in FullStory to confirm. Also, double check that you are using an API key from the same organization.
Data sent server-side for users must match an already existing userId that was sent from a client-side connection.
+The new 'Identify User V2' and 'Track Event V2' actions will automatically create users when a user matching the
+provided UID is not found.
+
+### Why can't I propagate GDPR deletions?
+
+GDPR deletions require an `Admin` or `Architect` API key to propagate. You may also contact FullStory directly for deletions.
+
{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-fullstory/index.md b/src/connections/destinations/catalog/actions-fullstory/index.md
index 64d5ba3321..301ac7aafb 100644
--- a/src/connections/destinations/catalog/actions-fullstory/index.md
+++ b/src/connections/destinations/catalog/actions-fullstory/index.md
@@ -15,12 +15,46 @@ versions:
[FullStory](https://www.fullstory.com/){:target="_blank"} lets product and support teams easily understand everything about the customer experience. The Segment integration for FullStory helps accurately identify your customers within the FullStory dashboard.
+FullStory's device mode Segment integration auto-captures high-fidelity user sessions and allows you to enrich FullStory data by sending user properties, page properties, and custom events from your website so you can apply it to your analysis throughout FullStory. For example, you could build a funnel to analyze drop-off of users who engaged with a certain marketing campaign.
+
## Benefits of FullStory Device Mode (Actions) vs FullStory Classic
- Greater control over the page properties you send.
- Send events specific to individual pages.
- Select by name the specific user properties or custom events to send.
+### Overview
+
+The FullStory device mode destination sends information about your users, pages, and related events to FullStory. It uses the [FullStory Browser API](https://developer.fullstory.com/browser/getting-started/){:target="_blank"}. The recommended presets, ending in "V2", use the most up-to-date version of the [FullStory Browser API](https://developer.fullstory.com/browser/getting-started/){:target="_blank"}. The corresponding non-versioned presets use the [legacy FullStory Browser API](https://developer.fullstory.com/browser/v1/getting-started/){:target="_blank"}.
+
+#### Identify user V2
+If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like the following:
+
+```javascript
+analytics.identify('userId123');
+```
+
+When you use an Identify call, Segment calls FullStory's [Set Identity API](https://developer.fullstory.com/browser/identification/identify-users/){:target="_blank"}. Use this to identify a user and set custom attributes which can then be used to search and segment within FullStory.
+
+If an Identify call contains a `userId`, it will be applied to the identifying `uid` in FullStory. All `traits` will be passed along as custom user properties with the exception of `traits.name` which is mapped to `displayName`. If you set an `anonymousId` in Segment, you can search for it under `segmentAnonymousId` in FullStory.
+
+#### Track custom event V2
+If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like the following:
+
+```javascript
+analytics.track('Clicked Button');
+```
+
+When you use a Track call, Segment calls FullStory's [Track Event API](https://developer.fullstory.com/browser/capture-events/analytics-events/){:target="_blank"}. Use this to capture more context about your user’s experience on your site.
+
+#### Viewed Page V2
+If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/track/) does. An example call would look like the following:
+
+```javascript
+analytics.page('Retail Page');
+```
+
+When you use a Page call, Segment calls FullStory's [Set Page Properties API](https://developer.fullstory.com/browser/set-page-properties/){:target="_blank"}. Use this to set custom page names and properties about pages your users visit. Either `category` or `name` with be mapped to FullStory's `pageName` property.
## Getting started
@@ -33,10 +67,7 @@ versions:
{% include components/actions-fields.html %}
## Migration from the classic FullStory destination
-{% include content/ajs-upgrade.md %}
-
-
Follow the table below to map your existing FullStory destination configuration to FullStory Device Mode (Actions).
-{% include components/actions-map-table.html name="fullstory" %}
\ No newline at end of file
+{% include components/actions-map-table.html name="fullstory" %}
diff --git a/src/connections/destinations/catalog/actions-gainsight-px-cloud/index.md b/src/connections/destinations/catalog/actions-gainsight-px-cloud/index.md
new file mode 100644
index 0000000000..9fab631ec4
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-gainsight-px-cloud/index.md
@@ -0,0 +1,32 @@
+---
+title: Gainsight PX Cloud (Actions) Destination
+id: 61f83101210c42a28a88d240
+---
+
+
+{% include content/plan-grid.md name="actions" %}
+
+[Gainsight PX](https://www.gainsight.com/product-experience/analytics/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} provides a personalized product experience platform to help companies acquire, retain, and grow customers by creating real-time, personalized engagements driven by product usage data. With Gainsight PX, companies can implement an effective product-led go-to-market strategy that will increase product adoption and customer lifetime value.
+
+This destination is maintained by Gainsight PX. For any issues with the destination, [contact the Gainsight PX Support team](mailto:pxsupport@gainsight.com).
+
+> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/actions-gainsight-px-cloud) Gainsight PX Cloud Segment destination. There's also a page about the [non-Actions Gainsight PX Cloud destination](/docs/connections/destinations/catalog/gainsight-px-cloud-server). Both of these destinations receive data from Segment.
+
+## Benefits of Gainsight PX Cloud (Actions) vs Gainsight PX Cloud Classic
+
+Gainsight PX Cloud (Actions) provides the following benefits over the classic Gainsight PX Cloud destination:
+
+- **Data Center Support**. The new Actions-based integration allows for the selection of the PX datacenter. This is required for any PX customers based in any data center other than the main US datacenter (accessed via app.aptrinsic.com).
+
+## Getting started
+
+1. From the Segment web app, navigate to **Connections > Catalog** and select the **Destinations** tab.
+2. Search for *Gainsight PX Cloud (Actions)* and select it.
+3. Click **Add destination**.
+4. Select an existing Source to connect to Gainsight PX Cloud (Actions).
+5. Find your Gainsight PX key.
+ * Log in to Gainsight PX and navigate to **Settings > Products > Web App**. Enter the URL for your web application and click the **Generate** button. The Tag Key is the value that begins with "AP-" to the right of the URL value. Copy the value to your clipboard.
+6. Paste the Gainsight PX Tag Key into the Segment connection settings API Key field.
+7. Choose the appropriate data center value in the "Other Settings" Data Center dropdown. If you access the PX instance with app.aptrinsic.com, select 'United States', otherwise, choose the appropriate selection based on the suffix after "app-" in the application's URL.
+
+{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-gameball/index.md b/src/connections/destinations/catalog/actions-gameball/index.md
new file mode 100644
index 0000000000..2d0bdbcfb7
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-gameball/index.md
@@ -0,0 +1,30 @@
+---
+title: Gameball (Actions) Destination
+id: 64d3487dcc68fe039fb6237f
+beta: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Gameball](https://www.gameball.co){:target="_blank”} is an all-in-one customer loyalty marketing platform that empowers brands to create personalized retention campaigns, helping them grow and monetize their customer base using cutting-edge gamification strategies. Using Gameball, you can increase customer lifetime value and secure unmatched conversion rates - capturing untapped opportunities.
+
+This destination is maintained by Gameball. For any issues with the destination, [contact the Gameball Support team.](mailto:support@gameball.co).
+
+## Benefits of Gameball (Actions) vs Gameball Classic
+Gameball (Actions) provides the following benefits over the classic Gameball destination:
+
+**Fewer settings**: Data mapping for actions-based destinations happens in during configuration, which eliminates the need for most settings.
+**Clearer mapping of data**: Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to the destination.
+**Support for Gameball V3 API**: Gameball (Actions) is built on the latest version of [Gameball APIs](https://developer.gameball.co/api-reference/api-reference){:target="_blank”}.
+
+## Getting started
+1. Go to your [Gameball dashboard](https://app.gameball.co/){:target="_blank”}. Click **Settings** in the bottom left, then click on **Account Integration**. Copy the API Key and Secret Key.
+2. From your Segment workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for Gameball.
+3. Select Gameball (Actions) and click **Add Destination**.
+4. Select an existing Source to connect to Gameball (Actions).
+5. Enter the API Key and Secret key in the destination settings in Segment.
+
+{% include components/actions-fields.html %}
+
+## Migration from the classic Gameball destination
+Keep in mind if you plan to move to Gameball (Actions) from a classic Gameball destination that Gameball (Actions) uses Gameball's HTTP API v3.
diff --git a/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md b/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md
index 476d03f00e..8e7b228fb4 100644
--- a/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md
+++ b/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md
@@ -8,63 +8,202 @@ versions:
- name: "Google Analytics 4 Cloud"
link: '/docs/connections/destinations/catalog/actions-google-analytics-4/'
---
-
{% include content/plan-grid.md name="actions" %}
-[Google Analytics 4](https://support.google.com/analytics/answer/10089681){:target="_blank"} is Google's new Analytics property, which you can use for both websites and applications. Google Analytics 4 has machine learning at its core to help surface insights and give you a more complete understanding of your customers across devices and platforms.
+[Google Analytics 4](https://support.google.com/analytics/answer/10089681){:target="_blank"} is Google's Analytics property that you can use for both websites and applications. Google Analytics 4 has machine learning at its core to help surface insights and give you a more complete understanding of your customers across devices and platforms.
+
+When you have Segment installed, you can use your existing Analytics 2.0 tracking implementation to fulfill your data collection needs with Google Analytics 4. When you enable the Google Analytics 4 Web destination, Segment loads the [gtag.js library](https://support.google.com/analytics/answer/9310895?hl=en#zippy=%2Cin-this-article){:target="_blank"} for you. To avoid duplicate data, remove the native gtag.js script from your page.
-When you have Segment installed, you can use your existing tracking implementation to fulfill your data collection needs with Google Analytics 4. When you use the Google Analytics 4 Web destination, Segment loads the [gtag.js library](https://support.google.com/analytics/answer/9310895?hl=en#zippy=%2Cin-this-article){:target="_blank"} for you.
+> info "Consent mode"
+> Google enforced consent on March 6, 2024 for European Economic Area (EEA) users. Learn more about [consent mode](/docs/connections/destinations/catalog/actions-google-analytics-4-web/#consent-mode) and how to set it up.
## Getting started
-Before you connect Segment to Google Analytics 4, configure a Google Analytics 4 property in your Analytics account. For more information, see Google's article [Set up Analytics for a website and/or app](https://support.google.com/analytics/answer/9304153){:target='_blank'}.
+Before you connect Segment to Google Analytics 4, configure a Google Analytics 4 property in your Analytics account and enable any Custom Definitions in your GA4 Admin Panel. For more information, see Google's article [Set up Analytics for a website and/or app](https://support.google.com/analytics/answer/9304153){:target='_blank'}.
-To connect the Google Analytics 4 Web destination:
+To connect the Google Analytics 4 Web destination:
1. From the Segment web app, click **Catalog**, then click **Destinations**.
2. Search for “Google Analytics 4 Web” in the Destinations Catalog, and select the destination.
3. Click **Configure Google Analytics 4 Web**.
-4. Select the web source that will send data to Google Analytics 4 and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/){:target='_blank'}.
+4. Select the web source that will send data to Google Analytics 4 and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/). For mobile source tracking, view the [Firebase Destination](/docs/connections/destinations/catalog/firebase/).
5. On the **Settings** tab, under **Basic Settings**, enter in the [Measurement ID](https://support.google.com/analytics/answer/9539598){:target='_blank'} associated with your GA4 web stream.
-6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+6. Set up your event mappings by following the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+7. Analytics.js requires an initial Page call to send data to Google Analytics 4 Web. The [Segment snippet](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-add-the-segment-snippet) includes this initial call by default.
+8. For GA4 to accept events on page, enable Set Configuration Mapping triggered by the first Segment event called after analytics.load(). Set Configuration Mapping calls the gtag(‘config’) command to enable tracking to your GA4 Measurement ID.
-{% include components/actions-fields.html settings="true"%}
+After you've set up and enabled the Set Configuration Mapping, enable at least one event in your **Mappings** tab. From there, view your events and parameters using the Google [Realtime](https://support.google.com/analytics/answer/9271392){:target="_blank"} or[DebugView](https://support.google.com/analytics/answer/7201382){:target="_blank"} reports. These two reports show you the events users trigger on your website as they occur. The DebugView report requires additional configuration before you can use it. Additional tools for debugging are to view all your Google enabled tracking via https://tagassistant.google.com(https://tagassistant.google.com){:target=”_blank”} or in your browser’s Dev Tools, view GA4 collect requests by filtering by /collect.
+
+Google Analytics automatically populates some events and parameters. For example, there are [Automatically Collected](https://support.google.com/analytics/answer/9234069){:target=”_blank”} events collected by triggering the Set Configuration Mapping. Calling gtag(‘config’) and enabling [Enhanced Measurement events](https://support.google.com/analytics/answer/9216061){:target=”_blank”}, which are controlled by toggling “on” in your GA4 Admin panel, use event listeners to send events. All events tracked via GA4 Web populate some commonly used parameters like `page_location` without additional configuration. Review the [Google Analytics event parameters](https://support.google.com/analytics/table/13594742){:target=”_blank” documentation for more information.
+
+### Recommended events
+
+Google recommends that you use their [Recommended events](https://support.google.com/analytics/answer/9267735){:target="_blank"} and properties to power certain built-in reports in Google Analytics 4. Segment’s Google Analytics 4 Web destination provides prebuilt mappings to automatically map your Segment spec events to the corresponding Google Analytics 4 events and properties. If your Segment events don’t follow the Segment spec exactly, you can modify the mappings. For example, Segment maps an `Order Completed` event to the Google Analytics 4 `Purchase` event, but if your company uses `Products Purchase` to indicate a purchase, you can map it in the Purchase action’s Event Trigger instead.
+
+Segment recommends using the prebuilt mappings when possible. However, the Segment spec doesn’t have an equivalent event for every Google Analytics 4 Recommended event. If there are other recommended events you'd like to send, use the [Custom Event action](/docs/connections/destinations/catalog/actions-google-analytics-4-web/#custom-event). For example, to send a `spend_virtual_currency` event, create a mapping for Custom Event, set up your Event Trigger criteria, and input a literal string of `spend_virtual_currency` as the Event Name. You can use the Event Parameters object to add fields that are in the `spend_virtual_currency` event such as `value` and `virtual_currency_name`. Remember to define custom parameters as [custom dimensions and metrics](/docs/connections/destinations/catalog/actions-google-analytics-4-web/#custom-dimensions-and-metrics) within the GA4 Admin panel first.
+
+### Custom events and event naming
+
+Before you create a custom event, make sure the event you want to create isn't already collected through an [Automatically Collected event](https://support.google.com/analytics/answer/9234069?sjid=7831609405656395105-NA){:target="_blank"} or recommended as a [Recommended event](https://support.google.com/analytics/answer/9267735?sjid=7831609405656395105-NA){:target="_blank"}.
+Google Analytics 4 does not accept custom event names that include spaces. Segment replaces spaces in the Event Name in the Custom Event action with an underscore. As a result, you see custom events as snake_case in Google Analytics 4.
+
+Event names are case-sensitive in Google Analytics 4. If you would like all event names to be lowercase, use the **Lowercase Event Name** setting when you create a Custom Event mapping and select `Yes` from the dropdown. If this setting is disabled, Google treats event names with different casing as distinct events.
+
+Custom Events don't appear in some of Google's standard reports; you must set up custom reports for meaningful analysis.
+
+> info "Custom Events with Item Parameters"
+> To pass item parameters, you must use Google Recommended Event names that accept the items array, in other words, Ecommerce Events. Item parameters do not pass to GA4 with a Custom Event name or any other Event name if the items array is not specified as a parameter.
+
+### Custom dimensions and metrics
+
+With Google Analytics 4, you must create custom dimensions and metrics, also known as Custom Definitions, within the Google Analytics 4 Admin interface to link event parameters to the corresponding custom dimensions or metrics. When creating the dimension or metric, you can either select a parameter from the list of already collected fields or enter the name of the parameter you plan to collect in the future. For more information, see [Google Analytics 4 Custom dimensions and metrics](https://support.google.com/analytics/answer/10075209?hl=en){:target="_blank"}.
+
+### Understanding event parameters
+
+Similar to how properties relate to Segment events, parameters provide additional information about the ways users interact with your website. For example, when someone views a product you sell, you can include parameters that describe the product they viewed, like `product_name`, `category`, and `price`.
+
+Automatically Collected and Enhanced Measurement events include a defined set of parameters by default. Google also provides a set of required and optional parameters to include with each Recommended event, and you can add more event parameters when you need them. Segment recommends that you review GA4’s list of defined event parameters, as anything beyond that list is a custom event parameter. The [Event collection limits](https://https://support.google.com/analytics/answer/9267744){:target=_blank”} also impact how many Custom Definitions your GA4 instance allows and how many parameters you can send with each event.
+
+### Conversion events
+
+Some of Segment's prebuilt [Available Actions](/docs/connections/destinations/catalog/actions-google-analytics-4-web/#available-actions) that map to Google's recommended events are automatically marked as a conversion in your Analytics dashboard. For example, when you add an "Order Completed" event, it will show up in your Analytics dashboard as "purchase" with the **Mark as conversion** toggle toggled on by default. However, for other events, such as "Add to Cart", you must manually toggle the **Mark as conversion** setting on in your Analytics dashboard. If you don't mark the event as a conversion, it will not show up as a conversion in your built-in reports. You can read more [about conversion events](https://support.google.com/analytics/answer/9267568?sjid=1275909514202748631-NA){:target="_blank"} in Google's documentation.
+
+## Consent mode
+[Consent mode](https://support.google.com/analytics/answer/9976101?hl=en){:target="_blank"} is a feature provided by Google in the context of its products, particularly the Gtag library and Google Analytics. As of March 6, 2024, Google announced that consent mode must function for European Economic Area (EEA) users, otherwise data from EEA users won't process.
+
+Consent mode in the Gtag library and Google Analytics is designed to help website owners comply with privacy regulations, such as the General Data Protection Regulation (GDPR) in the European Union. It allows website owners to adjust how these tools use and collect data based on user consent.
+
+With consent mode, you can configure your website to dynamically adjust the tracking behavior of the Gtag library and Google Analytics based on the user's consent status. If a user provides consent to data processing, both the Gtag library and Google Analytics can collect and use that data for analysis. If a user doesn't provide consent, both tools limit data collection to essential functions, helping businesses respect user privacy preferences.
+
+Consent mode may involve updates to your sources outside of Segment, such as incorporating a consent management system for consent functionality.
+
+See [set up consent mode on websites](https://developers.google.com/tag-platform/security/guides/consent?consentmode=advanced#update_consent_state){:target="_blank"} for more information.
+
+### Set up consent mode
+
+To enable consent mode for your Google Analytics 4 Web destination:
+1. Navigate to **Connections > Destinations** and select your Google Analytics 4 Web** destination.
+2. Go to the **Settings** tab of the destination.
+3. Click the toggle on for **Enable Consent Mode**, this calls gtag(‘consent’,’default’) with the defined parameters when the gtag library loads.
+4. Set the following fields with your organization’s determination of granted or denied:
-## FAQ & Troubleshooting
+ Field | Value
+ ----- | ------
+ Default Ad Storage Consent State | Granted or Denied
+ Default Analytics Storage Consent State | Granted or Denied
+ Ad User Data Consent State | Granted or Denied
+ Ad Personalization Consent State | Granted or Denied
-### Custom Event Naming
+5. Use your consent management platform to prompt the visitor. Ask the visitor to grant or deny consent for the applicable types.
+6. Pass the updated state as properties in the `page()` event after the next page load if you decide to change the consent defaults. For example,
-Google Analytics 4 does not accept custom event names that include spaces. Segment replaces spaces in the Event Name in the Custom Event action with an underscore. As a result, you will see custom events snake cased in Google Analytics 4.
+ ```
+ analytics.page('Consent Update', {
+ 'Ads Storage Consent State': 'false',
+ 'Analytics Storage Consent State': 'false'
+ });
+ ```
+7. As soon as the page loads and the set configuration fires to the Google Analytics SDK, Segment issues a consent mode update command. Map the properties you defined to collect consent state changes to the Set Configurations Fields mapping. You can choose to do this from 1 of 2 options in steps 4 and 5.
+ 1. Navigate to **Connections > Destinations** and select your Google Analytics 4 Web destination.
+ 2. Go to the **mappings** tab of the destination.
+ 3. Select the mapping you want to edit.'
+ 4. *(Option 1)* Under the **Select mappings** section, select `Granted` for these fields:
+ * Ads Storage Consent State
+ * Analytics Storage Consent State
+ * Ad User Data Consent State
+ * Ad Personalization Consent State
+ You can manually select `Granted` or `Denied` from the dropdown menu for Advanced consent mode settings, and type in `granted` or `denied` for basic consent mode settings.
+ 5. *(Option 2)* Under the **Select mappings** section, create an event variable to directly grab the value from the payload (for example, `properties.adStorageConsentState`). Ensure it translates to `granted` or `denied`. You can use an insert or [replace function](/docs/connections/destinations/actions/#replace-function) to translate other values to `granted` or `denied`. Do this for these fields:
+ * Ads Storage Consent State
+ * Analytics Storage Consent State
+ * Ad User Data Consent State
+ * Ad Personalization Consent State
-Google Analytics 4 is also case sensitive. If you would like all event names to be lowercase, use the `Lowercase Event Name` setting in the Custom Event action. If this setting is disabled, Google will treat event names with different casing as distinct events. For more information, see [Google Analytics 4 Event name rules](https://support.google.com/analytics/answer/10085872?hl=en&ref_topic=9756175#event-name-rules&zippy=%2Cin-this-article.%2Cin-this-article){:target="_blank"}.
+When these properties are available, they send to the `update` command.
-### Custom Dimensions & Metrics
+If you have any questions setting up consent mode, reach out to [friends@segment.com](mailto:friends@segment.com).
-With Google Analytics 4, you must create custom dimensions and metrics within the Google Analytics 4 interface and link event parameters to the corresponding dimension or metric. When creating the dimension or metric, you can either select a parameter from the list of already collected fields or enter the name of the parameter you plan to collect in the future. For more information, see [Google Analytics 4 Custom dimensions and metrics](https://support.google.com/analytics/answer/10075209?hl=en){:target="_blank"}.
+{% include components/actions-fields.html settings="true"%}
+
+## FAQ and troubleshooting
-### Debug Mode
+### Debug mode
-The Google Analytics 4 [debug mode](https://support.google.com/analytics/answer/7201382?hl=en){:target="_blank"} is supported with the Google Analytics 4 Web destination. DebugView displays the events and user properties that Analytics collects from a user in real-time. This can be helpful in troubleshooting your implementation.
+The Google Analytics 4 debug mode, [DebugView](https://support.google.com/analytics/answer/7201382?hl=en){:target="_blank"} is supported with the Google Analytics 4 Web destination. DebugView displays the events and user properties that Analytics collects from a user in real-time. This can be helpful when troubleshooting your implementation.
### Send events from both the browser and the server
-With Google Analytics 4 Web, events are sent from the browser to GA4. If you use Segment’s [Google Analytics 4 Cloud destination](/docs/connections/destinations/catalog/actions-google-analytics-4/#benefits-of-google-analytics-4-cloud) to send events through the API and tie data between client-side and server-side, you need to pass the same Client ID from the browser and the server. To do this, fetch the Gtag-generated **clientId** on the web client and pass it to Segment as a property. For more information, see [Google Analytics 4 destination: User Identification](/docs/connections/destinations/catalog/actions-google-analytics-4/#user-identification) on the next steps.
+With Google Analytics 4 Web, events are sent from the browser to GA4. If you use Segment’s [Google Analytics 4 Cloud destination](/docs/connections/destinations/catalog/actions-google-analytics-4/#benefits-of-google-analytics-4-cloud) to send events through the API and tie data between client-side and server-side, you need to pass the same Client ID from the browser and the server. To do this, fetch the Gtag-generated **clientId** on the web client and pass it to Segment as a property. For more information, see [Google Analytics 4 destination: User Identification](/docs/connections/destinations/catalog/actions-google-analytics-4/#user-identification) on the next steps. Additionally, when using Gtag, Google generates a session_id and session_number when a session begins. The session_id and session_number generated on the client can be passed as Event Parameters to stitch events sent through the API with the same session that was collected client-side, see [Using Gtagjs and Google Analytics 4 Cloud Destination](/docs/connections/destinations/catalog/actions-google-analytics-4/#using-gtagjs-and-google-analytics-4-cloud-destination) for more information and an example.
+
+The client_id and the session_id are both cookies stored in the user browser. You can use [Google gtag get commands](https://developers.google.com/tag-platform/gtagjs/reference#get){:target=”_blank”} or other cookie methods to parse these values from the _ga cookie and _ga_measurementId cookie:
+- If your _ga cookie is GA1.1.1783165678.1701112990 then 1783165678.1701112990 is your client_id
+- If your _ga_M12454XDR cookie is GS1.1.1710342977.347.1.1710343074.0.0.0 then 1710342977 is your session_id
+
+You are not required to send a session number for server-side hits. Session metrics come from the client-side data after GA4 stitches server-side event data to the client-side session.
+
+> success ""
+> Segment recommends that you enable the GA4 Web destination first then incorporate GA4 Cloud destination to augment your client-side tracking, as a hybrid GA4 application is an advanced implementation. Segment also recommends that you have deep knowledge of GA4 session-stitching, troubleshooting, and known caveats of the GA4 Measurement Protocol prior to implementing the Google Analytics 4 destination.
### Additional (unmapped) events are sent to GA4
-Google Analytics 4 collects events triggered by basic interactions with your site. For more information, see [Google Analytics 4 Automatically collected events](https://support.google.com/analytics/answer/9234069?hl=en){:target="_blank"}
+Google Analytics 4 collects events triggered by basic interactions with your site. For more information about which interactions are automatically collected, see [Google Analytics 4 Automatically Collected events](https://support.google.com/analytics/answer/9234069?hl=en){:target="_blank"}.
### Data takes a long time to appear in Google's reports
-Google may take [24-48 hours](https://support.google.com/analytics/answer/9333790){:target="_blank"} to process data sent to Google Analytics. As a result, the Google Analytics user interface may not reflect the most current data. The Google Analytics [Realtime report](https://support.google.com/analytics/answer/9271392){:target="_blank"} displays activity on your site as it happens.
+Google may take [24-48 hours](https://support.google.com/analytics/answer/9333790){:target="_blank"} to process data sent to Google Analytics. As a result, the Google Analytics user interface may not reflect the most current data. The Google Analytics [Realtime report](https://support.google.com/analytics/answer/9271392){:target="_blank"} displays activity on your site as it happens; however, events seen in Realtime reports do not always equate to how the data is processed in the standard reports. This disconnect between events seen in Realtime reports and Standard reports happens when a Custom Definition is not defined in the GA4 Admin panel.
### Data is not sent to Google
-Ensure that at least one mapping has been configured and enabled in the destination mappings for an event you want to send to Google Analytics. If no mappings are enabled, the destination does not send events.
+For event data to be sent downstream to Google Analytics:
+
+1. Configure and enable the **Set Configuration Fields** mapping. This mapping is required for data to be sent downstream because it sets configuration to the GA4 Measurement ID indicated in the Settings and establishes data flow using the `config` command.
+2. Confirm you call `analytics.page()` on page load. Analytics.js requires an initial Page call to send data to Google Analytics 4 Web. _The Segment snippet includes this initial call by default._
+3. Send data with an event: typically this is a `page_view` as your first event.
+
+ > note "If you toggled Page Views in your Settings to “On”, the page_view event automatically sends when the Set Configuration Mapping is triggered"
+ > 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)
+
+If no events are flowing to your GA4 instance, use one of the Debugging Tools to check the sequence of GA4 events.
+
+### Duplicate `page_view` events in GA4
+
+If you are sending multiple `gtag(‘config’)` commands called from Set Configuration mapping on one page before a new DOM has loaded, and you have defined `send_page_view: true` with each ‘Config’ event, you may see duplicate `page_view` events sent to your GA4 measurement id. If this is the case, see Google's documentation on [Ignoring duplicate instances of on-page configuration](https://support.google.com/analytics/answer/9973999?hl=en#:~:text=as%20described%20below.-,Ignore%20duplicate%20instances%20of%20on%2Dpage%20configuration,Click%20Save.,-Give%20feedback%20about){:target="_blank"}.
+
+If your site is a Single Page Application (SPA), you may want to leave the **Ignore duplicate instances of on-page configuration** toggle disabled in the Google Tag Admin as a new DOM is not called on each new page path. If you have a SPA, disabled the **Ignore duplicate instances of on-page configuration** toggle, and have multiple Set Configuration mappings, use Segment's new **Send Page Views** field mapping to override the `send_page_view` parameter in your Settings. This selection takes precedence over what is defined in the Segment Settings. If you leave the selection for your destination undefined, it will fall back to what you selected in the Segment Settings.
+
+If you enabled Enhanced Measurement, you might see additional `page_view` events. This happens when you enable the **Page changes based on browser history events** feature in the Advanced settings section of the **pageviews** settings. To avoid double counting page views on history state changes, disable the **Page changes based on browser history events** feature. See Google's [Manual pageviews](https://developers.google.com/analytics/devguides/collection/ga4/views?client_type=gtag#manual_pageviews){:target="_blank"} documentation for more information.
+
+### Manually send `page_view` events
+
+If you prefer to keep the **Page Views** setting disabled and manually send `page_view` events, see Google's documentation, [Manually send `page_view` events](https://developers.google.com/analytics/devguides/collection/ga4/views?client_type=gtag#manually_send_page_view_events).
+
+With Google Analytics 4 Web, you must configure a [Custom Event](/docs/connections/destinations/catalog/actions-google-analytics-4-web/#custom-event) mapping to manually send `page_view` events. When mapping the events, set the Event Name to `page_view`.
+
+You can now override the send_page_view value defined in the Segment Settings for the GA4 destination. To override the `send_page_view` value, navigate to your Set Configuration Mapping, click “Show More Fields” to expose the field mapping, and select either True or False. This selection takes precedence over what is defined in the Segment Settings. If you leave this selection undefined, Segment uses the selection you made in the Segment Settings.
+
+#### Tracking UTM Parameters
+
+Segment automatically tracks UTM parameters when they are present in the URL and sends them to Google. For example, with the following URL, Segment would send `email_variation1&utm_medium=email&utm_source=email_promo&utm_campaign=summer_sale&utm_id=abcd` to Google:
+`https://www.example.com/?utm_content=email_variation1&utm_medium=email&utm_source=email_promo&utm_campaign=summer_sale&utm_id=abcd`
+
+By default, if the UTM values are found in the `page_location` parameter, GA4 automatically maps the campaign parameters to their appropriate value. There is no additional configuration required, unless you want to override what GA4 defines. This is true for both Event mappings and the Set Configuration mapping. If you modify the output of the `page_location` and the UTM parameters are not included, this might result in erroneous acquisition and attribution mapping.
+
+To observe this feature, trigger a `Page` call with UTM parameters present in the URL and navigate to the **Realtime overview** report in GA4 to see the resulting `page_view` event under the _Event count by Event name_ card. The Acquisition card in the Realtime overview report reflects First User acquisition, but may not reflect the parameters of the event if this was a second session event.
+
+### Pass Custom Event parameters to all events and Custom Item parameters to all recommended Ecommerce events
+
+To pass custom event parameters to all events on the page, navigate to your Set Configuration Mapping, click **Show All Fields**, and enter any custom Event Parameters, including page_view. Any event parameters that have the same parameter key as your other event mappings will take precedence over what is set in the Set Configuration Mapping.
+
+To send custom item parameters, add the custom item parameter name in mappings where there is a Products array. Register your custom item parameter in the GA4 Admin panel if you would like this value processed in the GA4 UI. You can ONLY add custom item parameters in the Products array. If you add custom item parameters as an Event Parameter, they will be registered as an Event Parameter.
+
+### My Events Send to the wrong Google ID
+
+In each Event Mapping, there is a “Send To” parameter. Set this to “True” if you would like to include the send_to parameter and only send the event to the measurement_id configured in your settings. If you select “False” or do not enter a selection, GA4 Events will broadcast to all measurement IDs, including Google Ads IDs, on the page. These measurement IDs may be set outside of Segment. For more info on how the send_to parameter works, see Google's documentation on [Group and Route Data](https://developers.google.com/tag-platform/gtagjs/routing){:target="_blank"}.
+
+### Can I override my send_page_view selection that I declared in the Settings?
-### Page Views
+Yes. In the Set Configuration Mapping, click Show All Fields and scroll to Send Page Views. Your selection overrides what is set within the Settings. This is helpful if you are updating the user_id or user_properties for all events on the page where you want to call the config command but do not want to send a page_view.
-The **Page Views** advanced setting prevents sending the `page_view` included in the gtag.js snippet, not Segment's `analytics.page()` event available in the Analytics.js snippet by default. If you enable this setting, once the page loads, two `page_view` events will still send to the GA4 SDK, one from the Segment snippet and one from the gtag.js snippet. If you see duplicate `page_view` events in your GA4 dashboard, you need to either:
+### Differences between the Google Analytics 4 Cloud and Google Analytics 4 Web destinations
-1. Disable the **Page Views** advanced setting (set it to *False*) so only Segment's `analytics.page()` sends to the GA4 SDK. Or,
-2. Edit or disable the preset **Set Configuration Fields** mapping so only the `page_view` included in the gtag.js snippet sends to the GA4 SDK.
+Segment's [Google Analytics 4 Cloud](/docs/connections/destinations/catalog/actions-google-analytics-4/) server-side destination uses Google's Measurement Protocol API to send event data server to server, whereas Segment's [Google Analytics 4 Web](/docs/connections/destinations/catalog/actions-google-analytics-4-web/) device-mode destination loads the gtag.js library client-side and uses Segment's event data to map to gtag.js events directly. Each destination has its own advantages and disadvantages. Your choice between the two depends on your specific use case, technical expertise, and the platforms from which you want to track data.
diff --git a/src/connections/destinations/catalog/actions-google-analytics-4/index.md b/src/connections/destinations/catalog/actions-google-analytics-4/index.md
index d7d8dbd779..661c681903 100644
--- a/src/connections/destinations/catalog/actions-google-analytics-4/index.md
+++ b/src/connections/destinations/catalog/actions-google-analytics-4/index.md
@@ -18,6 +18,9 @@ When you have Segment installed, you can use your existing tracking implementati
> warning ""
> Google Analytics 4 doesn't officially support a pure server-to-server integration. However, Segment monitors the capabilities of the Measurement Protocol API and updates the cloud integration accordingly to achieve a reasonable level of reporting for mutual customers. For full functionality, please see the [Google Analytics 4 Web destination](/docs/connections/destinations/catalog/actions-google-analytics-4-web/).
+> info "Consent mode"
+> Google enforced consent on March 6, 2024 for European Economic Area (EEA) users. Learn more about [consent mode](/docs/connections/destinations/catalog/actions-google-analytics-4/#consent-mode) and how to set it up.
+
## Benefits of Google Analytics 4 Cloud
The Google Analytics 4 Cloud destination provides the following benefits:
@@ -40,9 +43,45 @@ To add the Google Analytics 4 Cloud destination:
5. On the **Settings** tab, enter in the [Measurement ID](https://support.google.com/analytics/answer/9539598){:target='_blank'} for web streams or the [Firebase App ID](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference?client_type=firebase#payload_query_parameters){:target='_blank'} for mobile streams. Next, enter in the API Secret associated with your GA4 stream and click **Save**. To create a new API Secret, navigate in the Google Analytics UI to Admin > Data Streams > choose your stream > Measurement Protocol > Create.
6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+
{% include components/actions-fields.html %}
-## Universal Analytics & Google Analytics 4
+## Consent mode
+[Consent mode](https://support.google.com/analytics/answer/9976101?hl=en){:target="_blank"} is a feature provided by Google in the context of its products, particularly the Gtag library and Google Analytics. As of March 6, 2024, Google announced that consent mode must function for European Economic Area (EEA) users, otherwise data from EEA users won't process.
+
+Consent mode in the Gtag library and Google Analytics is designed to help website owners comply with privacy regulations, such as the General Data Protection Regulation (GDPR) in the European Union. It allows website owners to adjust how these tools use and collect data based on user consent.
+
+With consent mode, you can configure your website to dynamically adjust the tracking behavior of the Gtag library and Google Analytics based on the user's consent status. If a user provides consent to data processing, both the Gtag library and Google Analytics can collect and use that data for analysis. If a user doesn't provide consent, both tools limit data collection to essential functions, helping businesses respect user privacy preferences.
+
+Consent mode may involve updates to your sources outside of Segment, such as incorporating a consent management system for consent functionality.
+
+### Set up consent mode
+To enable consent mode for your Google Analytics 4 Cloud destination, you must update the **Ad User Data Consent State** and **Ad Personalization Consent State** for all mappings you want to send with consent. Consent mode supports all actions with Google Analytics 4 Cloud. You can choose from 2 options to enable consent mode for your Google Analytics 4 Cloud destination.
+
+* **Option 1**
+
+ To enable consent mode for Google Analytics 4 Cloud destination:
+ 1. Navigate to **Connections > Destinations** and select your Google Analytics 4 Cloud destination.
+ 2. Go to the **Mappings** tab of the destination.
+ 3. Select the mapping you want to edit.
+ 4. Under the **Select mappings** section, find **Ad User Data Consent State**.
+ 5. Select `GRANTED` in the dropdown that corresponds to **Ad User Data Consent State**.
+ 6. Select `GRANTED` in the dropdown that corresponds to **Ad Personalization Consent State**.
+
+* **Option 2**
+
+ Create an event variable to directly grab the value from the payload. To do this:
+ 1. Navigate to **Connections > Destinations** and select your Google Analytics 4 Cloud destination.
+ 2. Go to the **Mappings** tab of the destination.
+ 3. Select the mapping you want to edit.
+ 4. Under the **Select mappings** section, find **Ad User Data Consent State**.
+ 5. Select the **Event Variables** tab and create an event variable to directly grab the value from the payload. Ensure it translates to `GRANTED` or `DENIED`. You can use an insert or [replace function](/docs/connections/destinations/actions/#replace-function) to translate other values to `GRANTED`or `DENIED`.
+ 6. Repeat step 5 for **Ad Personalization Consent State**.
+
+
+If you have any questions setting up consent mode, reach out to [friends@segment.com](mailto:friends@segment.com).
+
+## Universal Analytics and Google Analytics 4
### Differences between Universal Analytics and Google Analytics 4
@@ -55,16 +94,16 @@ Google Analytics 4 has different out-of-the-box reports. Google Analytics 4’s
### Migrating from Universal Analytics to Google Analytics 4
> warning ""
-> Google announced that all standard Universal Analytics properties will stop processing new hits on July 1, 2023. 360 Universal Analytics properties will stop processing new hits on October 1, 2023.
+> Google announced that all standard Universal Analytics properties will stop processing new data on July 1, 2023. 360 Universal Analytics properties with a current order will receive a one-time processing extension ending on July 1, 2024. Learn more about when [Google Analytics 4 will replace Universal Analytics](https://support.google.com/analytics/answer/11583528?sjid=13479291677968058253-NA){:target='_blank'}.
Segment’s Google Analytics 4 Cloud integration is a server-side integration with the GA4 Measurement Protocol API. This is similar to Segment’s Google Universal Analytics cloud-mode integration in that all data is sent directly to Google’s servers. Please note that this means client-side functionality, such as [Enhanced Measurement](https://support.google.com/analytics/answer/9216061){:target='_blank'}, may not be available through Segment. In addition, as Google continues to develop the GA4 Measurement Protocol API ahead of general availability of the API, there may be limitations that impact what can be seen in the Google Analytics 4 reports.
-#### Recommended Events
-Google Analytics 4 requires the use of [recommended events and properties](https://support.google.com/analytics/answer/9267735){:target='_blank'} to power certain built-in reports. Segment’s Google Analytics 4 Cloud destination provides prebuilt mappings to automatically map your [Segment spec](/docs/connections/spec/ecommerce/v2) events to the corresponding Google Analytics 4 events and properties. If your Segment events don't follow the Segment spec exactly, you can modify the mappings. For example, Segment maps "Order Completed" events to the Google Analytics 4 “Purchase” event by default. If your company uses “Products Purchase” to indicate a purchase, this can be mapped in the Purchase action’s Event Trigger instead.
+#### Recommended events
+Google Analytics 4 requires the use of [recommended events and properties](https://support.google.com/analytics/answer/9267735){:target='_blank'} to power certain built-in reports. Segment’s Google Analytics 4 Cloud destination provides prebuilt mappings to automatically map your [Segment spec](/docs/connections/spec/ecommerce/v2)events to the corresponding Google Analytics 4 events and properties. If your Segment events don't follow the Segment spec exactly, you can modify the mappings. For example, Segment maps "Order Completed" events to the Google Analytics 4 “Purchase” event by default. If your company uses “Products Purchase” to indicate a purchase, this can be mapped in the Purchase action’s Event Trigger instead.
Segment recommends using the prebuilt mappings when possible, however the Segment spec doesn't have an equivalent event for every Google Analytics 4 recommended event. If there are other recommended events you would like to send, please use the [Custom Event action](/docs/connections/destinations/catalog/actions-google-analytics-4/#custom-event). For example, to send a `spend_virtual_currency` event, create a mapping for Custom Event, set up your Event Trigger criteria, and input a literal string of "spend_virtual_currency" as the Event Name. You can use the Event Parameters object to add fields that are in the `spend_virtual_currency` event such as `value` and `virtual_currency_name`.
-#### Custom Events
+#### Custom events
In addition to recommended events, you can also send custom events using the [Custom Event action](/docs/connections/destinations/catalog/actions-google-analytics-4/#custom-event). Custom events are events that you name. Custom events don't appear in most standard reports; you need to set up custom reports for meaningful analysis. To create custom events in the Google Analytics 4 web interface, see Google’s [Modify and create events through the user interface](https://support.google.com/analytics/answer/10085872){:target='_blank'}.
> info "Event naming limitations"
@@ -72,14 +111,14 @@ In addition to recommended events, you can also send custom events using the [Cu
In all cases, event names in GA4 are case sensitive and require values in all properties. The Custom Event action includes a **Lowercase Event Name** option, to ensure consistency of all events sent to Google. For more information, see Google's articles [Google Analytics 4 event name rules](https://support.google.com/analytics/answer/10085872?hl=en&ref_topic=9756175#event-name-rules){:target='_blank'} and [Event name limitations](https://developers.google.com/analytics/devguides/collection/protocol/ga4/sending-events?client_type=firebase){:target="_blank"}.
-#### Custom Dimensions and Metrics
+#### Custom dimensions and metrics
With Google Analytics 4, you must create custom dimensions and metrics within the Google Analytics 4 interface and link parameters to the corresponding dimension or metric. When you create the dimension or metric, you can either select a parameter from the list of already collected fields or enter the name of the parameter you plan to collect in the future. Custom dimensions can be either event-scoped or user-scoped, and custom metrics must be event-scoped.
To send parameters to Google Analytics 4, use the Event Parameters or User Properties object available on every action. Only pass flat key-value pairs in the Event Parameters and User Properties objects. Keep in mind that Google silently drops any events that include nested parameters.
To achieve parity with Universal Analytics, you should create the same custom dimensions that you defined in Universal Analytics. Additionally, in Google Analytics 4, you should recreate many of the values that you tracked as event dimensions in Universal Analytics, particularly event category and event label. For more information, see [Google Analytics 4 Custom dimensions and metrics](https://support.google.com/analytics/answer/10075209){:target='_blank'}.
-#### Tracking Active Users and Sessions
+#### Tracking active users and sessions
##### Server-side Implementation using Google Analytics 4 Cloud Destination
@@ -94,9 +133,9 @@ Besides Engagement Time in Milliseconds, you can also generate your own `session
If you choose to integrate with Google Analytics 4 client-side (either with Segment's Google Analytics 4 Web destination or outside of Segment) _and_ also use Segment's Google Analytics 4 Cloud destination to send events through the API, you will have all the reserved parameters and sessions tracking information available in Google Analytics 4 reports.
-When using Gtag, [Google generates a `session_id` and `session_number` when a session begins](https://support.google.com/analytics/answer/9191807?hl=en){:target='_blank'}. The `session_id` and `session_number` generated on the client can be passed as Event Parameters to stitch events sent through the API with the same session that was collected client-side. For events to stitch properly, server-side events must arrive within a 48 hour window of when the client-side events arrive.
+When using Gtag, [Google generates a `session_id` and `session_number` when a session begins](https://support.google.com/analytics/answer/9191807?hl=en){:target='_blank'}. The `session_id` and `session_number` generated on the client can be passed as Event Parameters to stitch events sent through the API with the same session that was collected client-side. Additionally, `client_id` must be the same for both client-side and server-side events in order to deduplicate user counts in GA4 (unless User-ID is used as the basis for user identification). For events to stitch properly, server-side events must arrive within a 48 hour window of when the client-side events arrive.
-You can check your `session_id` and `session_number` with the [Google Site Tag function](https://developers.google.com/tag-platform/gtagjs/reference){:target='_blank'} or by running this script in your JavaScript console and replacing `G-xxxxxxxxxx` with your Google Analytics 4 Measurement ID:
+You can check your `client_id`, `session_id` and `session_number` with the [Google Site Tag function](https://developers.google.com/tag-platform/gtagjs/reference){:target='_blank'} or by running this script in your JavaScript console and replacing `G-xxxxxxxxxx` with your Google Analytics 4 Measurement ID:
```java
const sessionIdPromise = new Promise(resolve => {
@@ -106,16 +145,21 @@ const sessionNumPromise = new Promise(resolve => {
gtag('get', 'G-xxxxxxxxxx', 'session_number', resolve)
});
-Promise.all([sessionIdPromise, sessionNumPromise]).then(function(session_data) {
+const clientIdPromise = new Promise(resolve => {
+ gtag('get', 'G-xxxxxxxxxx', 'client_id', resolve)
+});
+
+Promise.all([sessionIdPromise, sessionNumPromise, clientIdPromise]).then(function(session_data) {
console.log("session ID: "+session_data[0]);
console.log("session Number: "+session_data[1]);
+ console.log("client ID: "+session_data[2]);
});
```
-#### User Identification
-Segment requires a Client ID or Firebase App Instance ID to send data to Google Analytics 4. The Client ID is the web equivalent of a device identifier and uniquely identifies a given user instance of a web client. By default, Segment sets Client ID to the Segment `userId`, falling back on `anonymousId`. This mapping can be changed within each action if you prefer to map a different field to Client ID.
+#### User identification
+Segment requires a Client ID or Firebase App Instance ID to send data to Google Analytics 4. The Client ID is the web equivalent of a device identifier and uniquely identifies a given user instance of a web client. By default, Segment sets Client ID to the Segment `userId`, falling back on `anonymousId`. This mapping can be changed within each action if you prefer to map a different field to Client ID.
-The Firebase App Instance ID is the mobile equivalent of a device identifier and uniquely identifiers a given Firebase app instance. No default is set for Firebase App Instance ID, as [this value needs to be retrieved through the Firebase SDK](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference?client_type=firebase#payload_post_body){:target='_blank'}.
+The Firebase App Instance ID is the mobile equivalent of a device identifier and uniquely identifiers a given Firebase app instance. No default is set for Firebase App Instance ID, as [this value needs to be retrieved through the Firebase SDK](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference?client_type=firebase#payload_post_body){:target='_blank'}.
Segment also allows you to send a User-ID with your events. The User-ID feature lets you associate your own identifiers with individual users so you can connect their behavior across different sessions and on various devices and platforms. For more information on User-ID, see Google’s [Measure activity across platforms](https://support.google.com/analytics/answer/9213390){:target='_blank'} and [Reporting: deduplicate user counts](https://support.google.com/analytics/answer/9355949){:target='_blank'}.
@@ -123,37 +167,67 @@ There are certain scenarios where sending a User-ID can be helpful. For example,
- **Use the Gtag-generated Client ID.** Gtag will set a Client ID automatically. The Client ID is stored in a cookie and can be fetched on the web client. To tie data between client-side and server-side, pass the Gtag-generated Client ID to Segment as a property and use that value as the Client ID in the Google Analytics 4 Cloud destination mappings.
- **Use the Segment `userId` for User-ID.** The Segment `userId` should be your company’s canonical user identifier. By setting Google's User-ID to the same value as `userId` on client-side and server-side, you can benefit from cross-platform analytics. In addition, if you use [Firebase to send mobile data to Google Analytics 4](/docs/connections/destinations/catalog/actions-google-analytics-4/#mobile-data), using the same User-ID across web and mobile will ensure users are stitched together across devices.
-#### Validating and Comparing Data
+#### Validating and comparing data
Google recommends a period of dual-collection with both Universal Analytics and Google Analytics 4. This dual-collection approach lets you build a historical record in Google Analytics 4 while continuing to depend on Universal Analytics until you're ready to fully switch over.
During this period, you may find it hard to perfectly compare between the two properties because reports and configuration settings vary between Universal Analytics and Google Analytics 4 properties. Google provides guidance on the [conditions that must be met](https://support.google.com/analytics/answer/9964640?hl=en&ref_topic=11192706#comparing){:target="_blank"} in order to compare data in the Realtime reports, as well as [which metrics are comparable versus not](https://support.google.com/analytics/answer/11986666?hl=en&ref_topic=10737980){:target="_blank"}.
For a complete map of Universal Analytics functionality to corresponding Google Analytics 4 functionality, please see Google’s [Migration Reference](https://support.google.com/analytics/answer/10607999?hl=en&ref_topic=10737980){:target="_blank"}.
-## FAQ & Troubleshooting
+## FAQ and Troubleshooting
### Data not sending to Google
Ensure that at least one mapping has been configured and enabled in the destination mappings for an event that you would like to reach Google. Without any mappings enabled to trigger on an event that has been ingested by the connected source, the destination will not send events downstream.
-### Attribution Reporting
+### Attribution reporting
Google doesn't currently support passing certain reserved fields to the Google Analytics 4 Measurement Protocol API. This includes attribution data, like UTM parameters. If you rely on attribution reporting, you can either send this data as [custom dimensions](/docs/connections/destinations/catalog/actions-google-analytics-4/#custom-dimensions-and-metrics) or implement a parallel client-side integration to collect this data with gtag.js (web) or Firebase (mobile).
-### Debug Mode
+### Debug mode
The Google Analytics 4 [debug mode](https://support.google.com/analytics/answer/7201382?hl=en){:target="_blank"} only works with a client-side implementation through gtag.js, Google Tag Manager, or Firebase. Because Segment's Google Analytics 4 Cloud integration is server-side and uses the Measurement Protocol API, debug mode is not supported.
-### Mobile Data
+However, you can use Google's `/debug` endpoint to test your events against Google's Measurement Protocol Validation Server. For more information, see Google's [Validate events](https://developers.google.com/analytics/devguides/collection/protocol/ga4/validating-events?client_type=gtag#:~:text=Protocol%20Validation%20Server-,/debug/mp/collect,-All%20other%20request){:target="_blank”} documentation.
+
+To validate your events:
+
+1. Run a test through Segment's [Event Tester](/docs/connections/test-connections/) with the event you're concerned about.
+2. Copy the `Request from Segment` value you see. This is the payload that Segment attempts to send to Google.
+3. Use an API testing tool, like Postman, to send that payload to Google's `/debug` endpoint.
+4. Google's `/debug` endpoint returns a [validation code](https://developers.google.com/analytics/devguides/collection/protocol/ga4/validating-events?client_type=gtag#validation_code){:target="_blank”} and a description of the error.
+
+### Mobile data
To achieve complete reporting, Google recommends use of their Firebase SDKs to send mobile data to Google Analytics 4. To assist in your implementation, Segment has a [Firebase destination](/docs/connections/destinations/catalog/firebase) available for mobile analytics. For more information on linking Google Analytics 4 properties to Firebase, see [Google Analytics 4 Firebase integration](https://support.google.com/analytics/answer/9289234?hl=en){:target="_blank"}.
The Segment Google Analytics 4 Cloud destination supports sending mobile app events server-side to supplement your Firebase implementation. To send mobile events server-side, configure the Firebase App ID in the Destination settings. In each mapping, change the Data Stream Type to `Mobile App` and set a Firebase App Instance ID so that data routes to a mobile stream.
-### Reserved Names
+### Reserved names
+
+Google reserves certain event names, parameters, and user properties. Google silently drops any events that include [these reserved names](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference?client_type=gtag#reserved_names){:target="_blank"}. Google doesn't accept events in the following conditions:
+- event or user property names have spaces in them
+- fields with `null` values
+- fields or events with reserved names
+- fields with a number as the key
+- fields or events with a dash (-) character in the name
+
+### Verifying Event Meet GA4's Measurement Protocol API
+**Why are the events returning an error _Param [PARAM] has unsupported value._?**
+Google has some requirements/[limitations](https://developers.google.com/analytics/devguides/collection/protocol/ga4/sending-events?client_type=gtag#limitations){:target="_blank"} imposed by their [Measurement Protocol API](https://developers.google.com/analytics/devguides/collection/protocol/ga4/sending-events?client_type=gtag){:target="_blank"}. If an event contains `null`/`object`/`array` parameters, GA4 silently drops the event, so Segment does not attempt to send the event but instead returns an error of `Invalid Type` that can be found in the destination's Event Delivery tab. To verify whether an event will return this error, you can send an event to [GA4's debug endpoint](https://developers.google.com/analytics/devguides/collection/protocol/ga4/validating-events?client_type=gtag){:target="_blank"} with an API tool like [Postman](https://www.postman.com/){:target="_blank"}.
+
+### Data takes a long time to appear in Google's reports
+
+Google may take [24-48 hours](https://support.google.com/analytics/answer/9333790){:target='_blank'} to process data sent to Google Analytics. As a result, the Google Analytics user interface may not reflect the most current data. The Google Analytics [Realtime report](https://support.google.com/analytics/answer/9271392){:target="_blank"} displays activity on your site as it happens.
+
+### Events with timestamps older than 72 hours are not showing on Google's end
+
+Because [Google's Measurement Protocol API](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference?client_type=gtag#payload_post_body){:target='_blank'} only accepts events that are backdated by up to 72 hours, GA4 can't accept events older than 72 hours.
+
+### Google Optimize Support
-Google reserves certain event names, parameters, and user properties. Google silently drops any events that include [these reserved names](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference?client_type=gtag#reserved_names){:target="_blank"}. Google also will not except events where event or user property names have spaces in them. If you notice that your data isn't appearing in Google, please check that you're not using a reserved name.
+The Google Analytics 4 Cloud destination does not support Google Optimize. This destination operates in cloud-mode (sending events from Segment servers to Google Analytics using the Measurement Protocol API), which prevents the required [Optimize SDK](https://support.google.com/optimize/answer/11287798?visit_id=637903946258690719-978290187&rd=1){:target="_blank"} snippet from loading on the page.
-### Data taking a long time to appear in Google's reports
+### Client/server-side event deduplication
+Google doesn't offer guidance around how to deduplicate the same event coming in server and client side. As a result, Segment recommends that you not send the same event into Google Analytics 4 from two different locations such that you would expect Google to deduplicate one of the events out of their pipeline. You can [deduplicate user counts](https://support.google.com/analytics/answer/9355949?hl=en){:target="_blank"} using the `User ID` field, but you cannot deduplicate whole events in the Google platform as far as Segment is aware.
-Google may take [24-48 hours](https://support.google.com/analytics/answer/9333790) to process data sent to Google Analytics. As a result, the Google Analytics user interface may not reflect the most current data. The Google Analytics [Realtime report](https://support.google.com/analytics/answer/9271392){:target="_blank"} displays activity on your site as it happens.
diff --git a/src/connections/destinations/catalog/actions-google-campaign-manager/index.md b/src/connections/destinations/catalog/actions-google-campaign-manager/index.md
new file mode 100644
index 0000000000..9e6abaecdf
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-google-campaign-manager/index.md
@@ -0,0 +1,70 @@
+---
+title: Google Tag for Campaign Manager
+strat: google
+hide-boilerplate: true
+hide-dossier: false
+id: 64f2434e5066280a0e7f1ab3
+hidden: true
+private: true
+beta: true
+versions:
+ - name: "Google Tag for Campaign Manager"
+ link: '/docs/connections/destinations/catalog/actions-google-analytics-4/'
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Google Tag for Campaign Manager](https://support.google.com/analytics/answer/12325075){:target="_blank"} (formerly known as DoubleClick Floodlight) is Google's tool to measure ad impressions and report on conversions. With this integration, Segment customers can make use of their existing tracking implementation to send data to Campaign Manager 360 without having to manage additional tags or code on their site.
+
+When you have Segment installed and enable this destination, Segment takes care of loading the Google Tag (gtag.js library) for you, ensuring data is forwarded to your Floodlight configuration in Campaign Manager.
+
+
+## Getting Started
+Before you connect Segment to Google Tag for Campaign Manager, ensure you have set up your Floodlight configurations in Campaign Manager.
+1. Navigate to the Segment web app, select Connections, then click on Destinations.
+2. Search for "Google Tag for Campaign Manager" in the Destinations Catalog and click on the destination.
+3. On the destination's overview page, click **Add destination**.
+4. Select the appropriate source that will forward data to Campaign Manager and click **Next**.
+5. On the Setup page, give your destination a name and click **Create destination**.
+6. On the Settings tab:
+ * Enter the Advertiser ID found under Floodlight > Configuration in Campaign Manager.
+ * Set **Allow Ad Personalization Signals**, if needed.
+ * Decide if you want to enable Conversion Linker which helps with first-party cookie tracking.
+ * Enable the destination by toggling **Enable Destination** on.
+
+Once you've enabled your destination, Segment will begin forwarding the appropriate events and conversions to your Floodlight configurations.
+
+
+## Sales Activity
+
+Capture monetary conversion data like revenue, order quantity, and transaction ID.
+
+### Configuration Fields:
+
+- **activityGroupTagString**: Identifier for the Floodlight activity group.
+- **activityTagString**: Identifier for the Floodlight activity.
+- **enableDynamicTags**: Toggle for dynamic tags.
+- **countingMethod**: Conversion counting method (`transactions`, or `items_sold`).
+- **transactionId**: Unique transaction ID.
+- **revenue**: Total revenue of a transaction.
+- **quantity**: For `transactions` counting method, this is typically is set to 1, for `items_sold`, the quantity of items sold.
+- **uVariables**: Additional custom Floodlight variables.
+- **dcCustomParams**: Custom data for event snippets.
+
+
+
+## Counter Activity
+
+Track non-monetary conversion data such as unique users, conversions, and session length.
+
+### Configuration Fields:
+
+- **activityGroupTagString**: Identifier for the Floodlight activity group.
+- **activityTagString**: Identifier for the Floodlight activity.
+- **enableDynamicTags**: Toggle for dynamic tags.
+- **countingMethod**: Conversion counting method (`standard`, `unique`, or `per_session`).
+- **sessionId**: Unique session ID (relevant for `per_session` counting).
+- **uVariables**: Custom Floodlight variables.
+- **dcCustomParams**: Custom data for event snippets.
+
+---
diff --git a/src/connections/destinations/catalog/actions-google-enhanced-conversions/images/google-enhanced-conversions-migration.png b/src/connections/destinations/catalog/actions-google-enhanced-conversions/images/google-enhanced-conversions-migration.png
new file mode 100644
index 0000000000..586c538db2
Binary files /dev/null and b/src/connections/destinations/catalog/actions-google-enhanced-conversions/images/google-enhanced-conversions-migration.png differ
diff --git a/src/connections/destinations/catalog/actions-google-enhanced-conversions/images/mapping-fields.png b/src/connections/destinations/catalog/actions-google-enhanced-conversions/images/mapping-fields.png
new file mode 100644
index 0000000000..efb87cbaac
Binary files /dev/null and b/src/connections/destinations/catalog/actions-google-enhanced-conversions/images/mapping-fields.png differ
diff --git a/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md b/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md
index ef618cc4a2..5d1056a01d 100644
--- a/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md
+++ b/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md
@@ -6,7 +6,13 @@ hide-dossier: false
id: 60ae8b97dcb6cc52d5d0d5ab
---
-The Google Ads Conversions destination enables you to upload offline conversions and conversion adjustments to Google Ads in a privacy safe way. With this server-side destination, you can upload conversions to the [Google Ads API](https://developers.google.com/google-ads/api/docs/conversions/overview){:target="_blank"} and tie them to a user's online click or phone call. In addition, you can improve the accuracy of your conversion measurement by sending conversion enhancements, restatements, and retractions.
+The Google Ads Conversions destination enables you to upload offline conversions and conversion adjustments to Google Ads in a privacy safe way. With this server-side destination, you can upload conversions to the [Google Ads API](https://developers.google.com/google-ads/api/docs/conversions/overview){:target="_blank"} and tie them to a user's online click or phone call. In addition, you can improve the accuracy of your conversion measurement by sending conversion enhancements, restatements, and retractions.
+
+> warning "Upload Enhanced Conversion (Legacy) Actions will be deprecated after June 30th, 2024"
+> Segment will begin migrating all enabled Upload Enhanced Conversion (Legacy) mappings to the updated Upload Conversion Adjustment mappings on June 7th, 2024. **After Segment migrates your mappings, you must take action to prevent data loss**. For more information, see the [Automatic migration from Upload Enhanced Conversion (Legacy) Action](#automatic-migration-from-upload-enhanced-conversion-legacy-action) documentation.
+
+> info "Consent mode"
+> Google enforced consent on March 6, 2024 for European Economic Area (EEA) users. Learn more about [consent mode](/docs/connections/destinations/catalog/actions-google-enhanced-conversions/#consent-mode) and how to set it up.
## Getting started
1. From the Segment web app, click **Catalog**, then click **Destinations**.
@@ -17,27 +23,104 @@ The Google Ads Conversions destination enables you to upload offline conversions
6. On the **Settings** tab, authenticate with Google using OAuth. Click **Connect to Google Ads Conversions**. Follow the prompts to authenticate using OAuth, with a Google account that is a member of your Google Ads account.
7. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
-> info ""
-> When you use the "Upload Enhanced Conversion (Legacy)" action, Segment sends data to the legacy Enhanced Conversions API. To authenticate into the legacy API and send enhancement data, Segment needs your Conversion ID and Conversion Label.
->
-> The Conversion ID is a global setting because it's an account-level ID that's the same for all conversion actions in your Google Ads account.
->
-> The Conversion Label is unique to each conversion action and is therefore configured per mapping. Find the Conversion ID and Conversion Label in your Google Ads account using the instructions in the article [Google Ads conversions](https://support.google.com/tagmanager/answer/6105160?hl=en){:target="_blank"}.
+{% include components/actions-fields.html settings="true"%}
-> info ""
-> When you use the "Upload Click Conversion", "Upload Call Conversion", and "Upload Conversion Adjustment" actions, Segment sends data to the new Google Ads API.
->
-> To authenticate into the Google Ads API, Segment needs your Customer ID and Conversion Action ID. The Customer ID is a global setting because it's an account-level ID that's the same for all conversion actions in your Google Ads account. The Conversion Action ID is unique to each conversion action and is configured per mapping. The Conversion Action ID can only be found in the browser URL of your given conversion action under the `ctId` parameter. For example, if the URL is `https://ads.google.com/aw/conversions/detail?ocid=00000000&ctId=576882000`, your Conversion Action ID is `576882000`.
+## Migrate from your legacy Upload Enhanced Conversion Action
+To migrate from the legacy Upload Enhanced Conversion Action to the updated Upload Conversion Adjustment Action:
-> info ""
-> Conversion ID, Conversion Label, Customer ID, and Conversion Action ID should always be different values.
+1. Navigate to the Google Ads Conversions destination in your workspace and select the **Settings** tab.
+2. On the Settings tab, enter your Conversion ID and Customer ID into the named fields.
+2. Update the following fields for the Upload Conversion Adjustment Action mapping:
+ - Conversion Action ID
+ - Adjustment Type
+3. Replicate as many fields from your original mapping as possible, using the following table for reference.
-{% include components/actions-fields.html settings="true"%}
+Review the [Upload Conversion Adjustment Action](/docs/connections/destinations/catalog/actions-google-enhanced-conversions/#upload-conversion-adjustment) section for more details about each field.
+
+| Upload Enhanced Conversion (Legacy)| Upload Conversion Adjustment | Default Mapping |
+|------------------------|----------------------------|--------------------------------------|
+| conversion_label | N/A | `$.properties.conversion_label` |
+| email | email_address | `$.properties.email` or `$.traits.email` or `$.context.traits.email` |
+| transaction_id | order_id | `$.properties.orderId` |
+| user_agent | user_agent | `$.context.userAgent` |
+| conversion_time | conversion_timestamp | `$.timestamp` |
+| value | N/A |` $.properties.total` |
+| currency_code | N/A | `$.properties.currency` |
+| is_app_incrementality | N/A |` false` |
+| pcc_game | N/A | `false` |
+| phone_number | phone_number | `$.properties.phone` or `$.traits.phone` |
+| first_name | first_name | `$.properties.firstName` or `$.traits.firstName` |
+| last_name | last_name | `$.properties.lastName` or `$.traits.lastName` |
+| street_address | street_address | `$.properties.address.street` or `$.traits.address.street` |
+| city | city | `$.properties.address.city` or `$.traits.address.city` |
+| region | state | `$.properties.address.state` or `$.traits.address.state` |
+| post_code | postal_code | `$.properties.address.postalCode` or `$.traits.address.postalCode` |
+| country | country | `$.properties.address.country` or `$.traits.address.country` |
+| N/A | gclid | Default Not Available |
+| N/A | adjustment_timestamp | Default Not Available |
+| N/A | restatement_value | Default Not Available |
+| N/A | restatement_currency_code | Default Not Available |
+
+
+### Automatic migration from Upload Enhanced Conversion (Legacy) Action
+The Upload Enhanced Conversion action relies on the Google Enhanced Conversion Legacy API, which will be deprecated on June 30th, 2024.
+
+On June 7, 2024, Segment will begin migrating all enabled legacy Upload Enhanced Conversion mappings to the new Upload Conversion Adjustment mapping, preserving as many mapping fields as possible. Migrated mappings will have the same names as your legacy mappings, with `[Migrated]` appended. For example, if your mapping was named "Enhanced Conversions", Segment would name your migrated mapping "Enhanced Conversions [Migrated]".
+
+
+
+After this migration occurs, you must take the following steps:
+1. Open the your Google Ads Conversions destination and select the **Settings** tab.
+2. Enter your Conversion ID and Customer ID into their respective fields. Find information about what these values are in the [destination settings](#destination-settings).
+3. Select the **Mappings** tab.
+4. Update the Conversion Action and Adjustment Type fields in the Upload Conversion Adjustment mapping to match the fields outlined in the above table. 
+5. Enable the migrated mapping(s).
+6. Disable the legacy Upload Enhanced Conversion mappings.
+
+To migrate your mapping yourself, use the steps in the [Migrate from your legacy Upload Enhanced Conversion Action](#migrate-from-your-legacy-upload-enhanced-conversion-action) documentation.
+
+Segment will deprecate all legacy Upload Enhanced Conversion legacy actions after June 30th, 2024.
+
+## Consent mode
+[Consent mode](https://support.google.com/analytics/answer/9976101?hl=en){:target="_blank"} is a feature provided by Google in the context of its products, particularly the Gtag library and Google Analytics. As of March 6, 2024, Google announced that consent mode must function for European Economic Area (EEA) users, otherwise data from EEA users won't process.
-## FAQ & Troubleshooting
+Consent mode in the Gtag library and Google Analytics is designed to help website owners comply with privacy regulations, such as the General Data Protection Regulation (GDPR) in the European Union. It allows website owners to adjust how these tools use and collect data based on user consent.
-### Enhanced Conversions
+With consent mode, you can configure your website to dynamically adjust the tracking behavior of the Gtag library and Google Analytics based on the user's consent status. If a user provides consent to data processing, both the Gtag library and Google Analytics can collect and use that data for analysis. If a user doesn't provide consent, both tools limit data collection to essential functions, helping businesses respect user privacy preferences.
+
+Consent mode may involve updates to your sources outside of Segment, such as incorporating a consent management system for consent functionality.
+
+### Set up consent mode
+
+To enable consent mode for your Google Ads Conversions destination, you must update the **Ad User Data Consent State** and **Ad Personalization Consent State** for all of your Upload Call Conversion and Upload Click Conversion actions. You can do this in 1 of 2 ways:
+
+* **Option 1:**
+ 1. Navigate to **Connections > Destinations** and select your Google Ads Conversion destination.
+ 2. Go to the **Mappings** tab of the destination.
+ 3. Select the mapping you want to edit.
+ 4. In the **Select mappings** section, select `GRANTED` from the dropdown menu for **Ad User Data Consent State** and **Ad Personalization Consent State**.
+
+* **Option 2:**
+ 1. Navigate to **Connections > Destinations** and select your Google Ads Conversion destination.
+ 2. Go to the **Mappings** tab of the destination.
+ 3. Select the mapping you want to edit.
+ 4. In the **Select mappings** section, for **Ad User Data Consent State** and **Ad Personalization Consent State**, select the **Event Variables** tab and create an event variable to directly grab the value from the payload. Ensure it translates to `GRANTED`, `DENIED`, or `UNSPECIFIED`. You can use an insert or [replace function](/docs/connections/destinations/actions/#replace-function) to translate other values to `GRANTED`, `DENIED`, or `UNSPECIFIED`.
+
+If you send `DENIED` for any of the two consent states, it results in an error and the data won't send to Google. For more information, see [FAQ about the EU user consent policy for Customer Match upload partners](https://support.google.com/google-ads/answer/14310715?hl=en){:target="_blank"}.
+
+If you have any questions setting up consent mode, reach out to [friends@segment.com](mailto:friends@segment.com).
+
+
+## FAQ and troubleshooting
+
+### Conversion ID, Customer ID, and Conversion Action ID should always be different values
+
+Conversion ID and Customer ID are global settings because it’s an account-level ID that’s the same for all conversion actions in your Google Ads account.
+
+The Conversion Action ID is unique to each conversion action and is configured per mapping. The Conversion Action ID can only be found in the browser URL of your given conversion action under the `ctId` parameter. For example, if the URL is `https://ads.google.com/aw/conversions/detail?ocid=00000000&ctId=576882000`, your Conversion Action ID is `576882000`.
+
+### Enhanced conversions
[Enhanced conversions](https://support.google.com/google-ads/answer/11062876){:target="_blank"} is a feature that can improve the accuracy of your conversion measurement and unlock more powerful bidding. It supplements your existing conversion tags by sending hashed, first-party conversion data from your website to Google in a privacy safe way. You can use the "Upload Conversion Adjustment" action to send enhancements to the Google Ads API. In order to send enhanced conversions, you must record first conversions using the standard Google Ads Conversion tag (Gtag). Segment offers a [Google Ads (Gtag) destination](/docs/connections/destinations/catalog/google-ads-gtag/) so you can use your existing Segment implementation to activate Gtag. Enhancements can be sent to web conversion actions that have **Turn on enhanced conversions** by API enabled.
@@ -46,16 +129,22 @@ Conversions tracked by other means, such as importing goals from Google Analytic
> info ""
> To send enhancements for conversions that are initially tracked with Gtag, an Order ID (Transaction ID) must be implemented in the Gtag **and** the same Order IDs must be sent with the corresponding enhancement data. This is required for Google to successfully process your enhancement data.
-### Enhanced Conversions for Leads
+### Enhanced conversions for leads
-[Enhanced conversions for leads](https://developers.google.com/google-ads/api/docs/conversions/upload-identifiers){:target="_blank"} allows you to use hashed, first-party user-provided data from your website lead forms for offline lead measurement. When you upload your leads, the provided hashed information is used to attribute back to the Google Ad campaign. In order to send enhanced conversions for leads, you can use the "Upload Click Conversion" action. Instead of sending GCLID, send an email address or phone number of the user for Segment to hash and send to Google Ads.
+[Enhanced conversions for leads](https://developers.google.com/google-ads/api/docs/conversions/upload-identifiers){:target="_blank"} allows you to use hashed, first-party user-provided data from your website lead forms for offline lead measurement. When you upload your leads, the provided hashed information is used to attribute back to the Google Ad campaign. In order to send enhanced conversions for leads, you can use the "Upload Click Conversion" action. According to Google, if you do not have GCLID at your source payload, you have to pass user identifiers, at least email or phone number in your mappings, for Google to make the match. A conversion must be addressed to an existing profile. If there's not a match, Google responds with a failure.
-### Refreshing Access Tokens
+### Refreshing access tokens
When you use OAuth to authenticate into the Google Ads Conversions destination, Segment stores an access token and refresh token. Access tokens for Google Ads Conversions expire after one hour. Once expired, Segment receives an error and then uses the refresh token to fetch a new access token. This results in two API requests to Google Ads Conversions, one failure and one success.
Because of the duplicate API requests, you may see a warning in Google for unprocessed conversions due to incorrect or missing OAuth credentials. This warning is expected and does not indicate data loss. Google has confirmed that conversions are being processed, and OAuth retry behavior will not cause any issues for your web conversions. Whenever possible, Segment caches access tokens to reduce the total number of requests made to Google Ads Conversions.
-### Sending App Conversions for Incrementality Studies (Legacy Enhanced Conversions API only)
+### Resolving an invalid_conversion_action_type error
+
+This error indicates that the conversion action specified in the upload request has not been set up for conversion uploads, as outlined in [Google's Ads documentation](https://developers.google.com/google-ads/api/reference/rpc/v15/ConversionUploadErrorEnum.ConversionUploadError#invalid_conversion_action_type){:target="_blank”}.
+
+To resolve this, ensure that the ConversionActionType value in Google Ads is correctly configured.
+
+### `The required field was not present., at conversions[0].gclid` Error
-The legacy Enhanced Conversions API does not offer standard reporting for app conversions. As such, Google requires that you set up a new web conversion action specifically for the purposes of app incrementality studies. To send app conversions in your incrementality study, use the "Upload Enhanced Conversion (Legacy)" action. Be sure to input the Conversion Label associated with your incrementality study **and** set the App Conversion for Incrementality Study field to `true`. You should create separate web conversion actions in Google Ads for each app event you want to send data for.
+Events going to Google for this integration require a `GCLID` field, an `email`, or a `phone_number`. If one of those identifiers isn't being sent properly, then you may see the `The required field was not present., at conversions[0].gclid` error. To fix this, double check that at least one of those fields is being passed to Google on each payload.
diff --git a/src/connections/destinations/catalog/actions-google-sheets/index.md b/src/connections/destinations/catalog/actions-google-sheets/index.md
index 096639ddee..e6d9191e4f 100644
--- a/src/connections/destinations/catalog/actions-google-sheets/index.md
+++ b/src/connections/destinations/catalog/actions-google-sheets/index.md
@@ -38,3 +38,7 @@ The Record Identifier mapping is used to make a distinction between adding a new
### How do I define the columns in my spreadsheet?
The Fields mapping controls which fields in your model will be written as columns. Input the desired column name(s) on the left, and select the data variable that will populate the value for that column on the right. Please note, at least one field must be configured to send data to Google Sheets otherwise no columns will be created or synced.
+
+### How are columns formatted when synced to my spreadsheet?
+
+When syncing data to Google Sheets, the columns will be arranged alphabetically, based on the names defined in the Fields mapping.
diff --git a/src/connections/destinations/catalog/actions-heap/index.md b/src/connections/destinations/catalog/actions-heap/index.md
index 2dc93e8ae0..42acf0083c 100644
--- a/src/connections/destinations/catalog/actions-heap/index.md
+++ b/src/connections/destinations/catalog/actions-heap/index.md
@@ -17,9 +17,6 @@ versions:
> success ""
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Heap destination. There's also a page about the [non-Actions Heap destination](/docs/connections/destinations/catalog/heap/). Both of these destinations receive data from Segment.
-
-{% include content/ajs-upgrade.md %}
-
## Benefits of Heap (Actions) vs Heap Classic
Heap (Actions) provides the following benefits over the classic Heap destination:
diff --git a/src/connections/destinations/catalog/actions-hubspot-cloud/images/scopeApproval.png b/src/connections/destinations/catalog/actions-hubspot-cloud/images/scopeApproval.png
new file mode 100644
index 0000000000..3f64d1824e
Binary files /dev/null and b/src/connections/destinations/catalog/actions-hubspot-cloud/images/scopeApproval.png differ
diff --git a/src/connections/destinations/catalog/actions-hubspot-cloud/index.md b/src/connections/destinations/catalog/actions-hubspot-cloud/index.md
index f1b329b42b..93c253f58b 100644
--- a/src/connections/destinations/catalog/actions-hubspot-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-hubspot-cloud/index.md
@@ -12,12 +12,17 @@ versions:
{% include content/plan-grid.md name="actions" %}
-HubSpot is an all-in-one marketing tool that helps attract new leads and converts them into paying customers, with features like landing page creation and email automation.
+HubSpot is an all-in-one marketing tool that helps attract new leads and converts them into paying customers, with features like landing page creation and email automation.
When you use the HubSpot Cloud Mode (Actions) destination, Segment sends your data to [HubSpot's REST API](https://developers.hubspot.com/docs/api/overview){:target="_blank"}.
> warning ""
-> The **Upsert Company** action is not compatible with the Segment Event Tester. As a result, Segment recommends using other tools to test and troubleshoot the creation and updates of companies in HubSpot.
+> The **Upsert Company** action is not compatible with the Mapping Tester on the mappings page if Associate Contact is set to **Yes**. As a result, Segment recommends using the Event Tester or other tools to test and troubleshoot creating and updating companies in HubSpot.
+>
+> Note that for the company to contact association to work, you are required to trigger an Upsert Contact action before triggering an Upsert Company action. Contacts created with batch endpoint can not be associated to a Company from the Upsert Company Action.
+
+> warning ""
+> **Behavioral Events (Legacy)** are only supported with [Hubspot Classic Destination](/docs/connections/destinations/catalog/hubspot/).
## Benefits of HubSpot Cloud Mode (Actions) vs HubSpot Classic
@@ -31,6 +36,8 @@ HubSpot Cloud Mode (Actions) provides the following benefits over the classic Hu
- **Support for custom behavioral events**. Send [custom behavioral events](https://developers.hubspot.com/docs/api/analytics/events){:target="_blank"} and event properties to HubSpot.
- **Create records in custom objects**. Use your Segment events to create records in any standard or custom object in your HubSpot account.
+> note ""
+> A HubSpot Enterprise Marketing Hub account is required to send Custom Behavioral Events.
## Getting started
@@ -38,7 +45,8 @@ HubSpot Cloud Mode (Actions) provides the following benefits over the classic Hu
2. Search for **HubSpot Cloud Mode (Actions)** in the Destinations Catalog, and select the destination.
3. Click **Configure HubSpot Cloud Mode (Actions)**.
4. Select the source that will send data to HubSpot Cloud Mode (Actions) and follow the steps to name your destination.
-5. On the **Settings** tab, authenticate with HubSpot using OAuth. Your user must be a [super admin](https://knowledge.hubspot.com/settings/hubspot-user-permissions-guide#super-admin){:target="_blank"} in the HubSpot account to authenticate the connection.
+5. On the **Settings** tab, authenticate with HubSpot using OAuth. Your user must be a [super admin](https://knowledge.hubspot.com/settings/hubspot-user-permissions-guide#super-admin){:target="_blank"} in the HubSpot account to authenticate the connection. Click **Connect app**.
+
6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
7. Enable the destination and configured mappings.
@@ -47,19 +55,52 @@ HubSpot Cloud Mode (Actions) provides the following benefits over the classic Hu
{% include components/actions-fields.html %}
-## FAQ & Troubleshooting
+
+## Support for association between two custom object records in upsert custom object records
+To associate two records, it's mandatory to have these three fields: **Search Fields to associate** , **ObjectType to associate**, and **Association Label**. If any of these three fields aren't configured, the association skips.
+
+Field | Details
+----- | --------
+Search Fields to associate | This finds a unique record of custom object based on key-value search properties so that records can be associated together.
* An association record fails if there is more than one record returned from the search association object.
* An association skips if no record is found with the data provided in key:value format.
+ObjectType to associate | To associate the newly created and updated custom object record with another object type, select the object type you want it to be associated with.
+Association Label | Select an association label between both the object types. From the HubSpot Dashboard, you can create associations between any type of object. To create an association label:
1. Log in to the [HubSpot Dashboard](https://app.hubspot.com/){:target="_blank"}.
2. Go to **Data Management > Objects > Custom Objects**.
3. Go to the **Associations** tab and click **Create association label**.
+
+## FAQ and troubleshooting
### How do I send other standard objects to HubSpot?
Segment provides prebuilt mappings for contacts and companies. If there are other standard objects you would like to create records in, please use the **Create Custom Object Record** action. For example, to create a deal in HubSpot, add a mapping for Create Custom Object Record, set up your Event Trigger criteria, and input a literal string of "deals" as the Object Type. You can use the Properties object to add fields that are in the [deals object](https://developers.hubspot.com/docs/api/crm/deals){:target="_blank"}, such as `dealname` and `dealstage`. The same can be done with other object types (for example, tickets, quotes, etc). Ending fields that are to go to HubSpot outside of the properties object isn't supported. This includes sending [associations](https://developers.hubspot.com/docs/api/crm/associations){:target="_blank"}. Please note, Segment only supports creating new records in these cases; updates to existing records are only supported for contacts and companies.
-
+### How do I send `Page` events to HubSpot?
+The [Track Page View action](/docs/connections/destinations/catalog/actions-hubspot-web/#track-page-view) is only available in [HubSpot Web (Actions) destination](/docs/connections/destinations/catalog/actions-hubspot-web/). As a workaround, with HubSpot Cloud Mode (Actions) destination, you can use the [Custom Behavioral Event](/docs/connections/destinations/catalog/actions-hubspot-cloud/#send-custom-behavioral-event) to send Page events to Hubspot. You'll need to [follow Hubspot's instructions](https://knowledge.hubspot.com/analytics-tools/create-custom-behavioral-events-with-the-code-wizard){:target="_blank"} to create a custom behavioral event for `Page Viewed` in HubSpot.
### Why aren't my custom behavioral events appearing in HubSpot?
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, the request will fail. See [HubSpot documentation](https://knowledge.hubspot.com/analytics-tools/create-custom-behavioral-events#define-the-api-call){:target="_blank"} for other limits.
-> note ""
-> A HubSpot Enterprise Marketing Hub account is required to send Custom Behavioral Events.
+### How do I resolve a `403` error for custom behavioral events?
+`403` errors indicate that Segment is unable to send your event to HubSpot because the account connected doesn't have sufficient permissions. If you're observing `403` errors for Custom Behavioral Events, ensure that your HubSpot account is a `HubSpot Enterprise Marketing Hub` account. After upgrading your account to `Enterprise Marketing Hub`, **Reauthorize** from the **Settings** page of your destination to resolve the `403` errors.
+
+### Why can't I set an entire object for the Other properties field?
+
+This destination doesn't allow selecting an entire object for the Other properties field. HubSpot rejects API calls if a property name doesn't match with HubSpot's internal name. When working with a large object of key/value pairs, map each key/value pair to prevent rejection. This ensures that every key matches the pre-created property names in HubSpot.
### Does the HubSpot Cloud Mode (Actions) destination support EU data residency?
Yes. HubSpot will automatically redirect API requests directly to an EU data center if your HubSpot instance is on an EU data center. See more in HubSpot's [Routing API Traffic](https://product.hubspot.com/blog/routing-api-traffic){:target="_blank"} article.
+### How do I attribute a custom behavioral event with a user token instead of Email?
+Event payloads should contain an email with either a valid format, empty string, or a `null` value. As a result, the user token takes precedence and is validated in a `Send custom behavioral event` mapping. Segment can't deliver the event to your destination if the email is invalid.
+
+### How can I disable or delete a destination from Segment?
+Follow the instructions in the docs to [disable](/docs/connections/destinations/actions/#disable-a-destination-action) or [delete](/docs/connections/destinations/actions/#delete-a-destination-action) a destination action from Segment.
+
+### How can I uninstall an app from my HubSpot account?
+Follow the steps mentioned [here](https://knowledge.hubspot.com/integrations/connect-apps-to-hubspot#uninstall-an-app){:target="_blank"} to uninstall or disconnect an app from your HubSpot account.
+
+### How does disconnecting and uninstalling affect a user's data and HubSpot account?
+Segment immediately stops sending data to HubSpot after you disconnect and uninstall a HubSpot account.
+
+### Understanding HubSpot's `date` and dateTime` custom property types
+If you plan on sending a _date_ value that includes time data to your mapped HubSpot custom properties, select HubSpot's `dateTime` property type in HubSpot. If you plan to send a _date_ value that does not contain time data, select the `date` property value in HubSpot. For more information about custom property types, see HubSpot's [Custom objects](https://developers.hubspot.com/docs/api/crm/crm-custom-objects#properties){:target="_blank”} documentation.
+
+If you send a _date_ value that contains time data to a custom property in HubSpot with a `date` property type, the event might fail due to an "**Invalid Date Error**."
+
+Both of HubSpot's _date_ property types each accept ISO 8601 formatted values, but only the `dateTime` property type accepts values that include time data.
diff --git a/src/connections/destinations/catalog/actions-hyperengage/index.md b/src/connections/destinations/catalog/actions-hyperengage/index.md
new file mode 100644
index 0000000000..6f48d9d027
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-hyperengage/index.md
@@ -0,0 +1,34 @@
+---
+title: Hyperengage (Actions) Destination
+hide-boilerplate: true
+hide-dossier: true
+beta: true
+private: true
+id: 651c1db19de92d8e595ff55d
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Hyperengage](https://hyperengage.io/){:target="_blank"} tracks thousands of data points to trigger smart alerts on hidden opportunities when the accounts are ready for upsell, or likely to churn. By integrating product data into your GTM strategy, Hyperengage's platform empowers CSM’s and AE’s to achieve up to 5x higher lead conversion and better retention and adoption.
+
+## Benefits of Hyperengage (Actions)
+
+Hyperengage (Actions) offers several advantages:
+
+- **Seamless Data Mapping**: Hyperengage streamlines the process of syncing your user and account data. When you link your data with Segment, Hyperengage automatically processes Segment's Identify, Track, and Group calls, eliminating the need for manual API integrations.
+- **Pre-configured Mappings**: The Hyperengage (Actions) Destination has prebuilt mappings tailored for Hyperengage with all the necessary parameters, reducing the need for manual customization.
+- **Direct Data Transfer**: Data moves straight from Segment to Hyperengage, eliminating the need for third-party intermediaries.
+- **Event Tracking and User Identification**: With Segment's Actions-based destination, you can keep track of events and identify users and organizations in Hyperengage.
+
+## Getting started
+
+1. From the Segment web app, navigate to **Connections > Catalog**, then select **Destinations**.
+2. In the Destinations Catalog, search for "Hyperengage" and select the Hyperengage (Actions) destination.
+3. Click **Add destination**.
+4. Choose an existing source to connect to Hyperengage (Actions) and click **Next**.
+5. Enter a name for your destination and click **Create destination**.
+6. Open the [Hyperengage App](https://hyperengage.io/){:target="_blank"}, proceed to **Integration Settings**, and copy the API Key and Workspace Identifier.
+7. Open the Segment app, navigate to your Hyperengage (Actions) destination, and paste the API Key and Workspace Identifier into the destination's settings page.
+
+
+{% include components/actions-fields.html %}
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-insider-audiences/index.md b/src/connections/destinations/catalog/actions-insider-audiences/index.md
new file mode 100644
index 0000000000..81c6b27f0f
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-insider-audiences/index.md
@@ -0,0 +1,50 @@
+---
+title: Insider Audiences (Actions)
+id: 643698ffee21b544f6aa756a
+hide-boilerplate: true
+hide-dossier: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Insider](https://useinsider.com/integration/segment/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} Growth Management Platform (GMP) helps digital marketers drive growth across the funnel. Insider GMP helps marketers deliver personalized journeys across the web, mobile web, mobile apps, messaging, email, and ad channels using the unified data.
+
+This destination is maintained by Insider. For any issues with the destination, contact the [Insider Support team.](mailto:insiderhelp@useinsider.com){:target="_blank"}
+
+## Getting started
+
+> info "Prerequisites"
+> Before connecting to the [Insider Audiences (Actions) destination](/docs/connections/destinations/catalog/actions-insider-audiences/), you must have an Insider Account, Account Name, and a [Unified Customer Database API Key](https://academy.useinsider.com/docs/api-authentication-tokens){:target="_blank"}.
+
+To add the Insider Audiences Destination:
+
+1. From your Segment workspace, navigate to **Connections > Catalog** and select the **Destinations** tab.
+
+2. Search for **Insider Audiences** and select the destination.
+
+3. Click **Add destination**.
+
+4. Select the space in Engage to use as the Source as this destination only supports sending Engage Audiences to Insider.
+
+5. Name your destination on the settings tab.
+
+6. Add the following settings to your Insider Destinations:
+
+ - **Account Name**: Your Insider Account (Partner) Name.
+ - **API Key**: Your Unified Customer Database API Key. See how you can generate the API key in the [Insider Academy API Authentication Tokens](https://academy.useinsider.com/docs/api-authentication-tokens#generate-api-key){:target="_blank”} documentation.
+
+7. Click **Save** Changes.
+
+8. In the Mappings tab, click **New Mapping** and select **Sync Engage Audience to Insider**.
+
+9. Go to the Settings tab and enable the destination.
+
+Your Insider destination is now ready to receive audiences, and your segment will start to populate over at Insider Audiences. To use the segment, select Segment Audience Name from your segmentation over at the Insider InOne panel. If you enable track option, Insider also receives the events defined on Segment Panel with the same name.
+
+Be aware that, populating all user information might take a while to process.
+
+{% include components/actions-fields.html %}
+
+## Migration from the classic Insider destination
+
+If you’re already using the Insider (Classic) Destination, you’re not expected to have breaking changes when upgrading to the Insider (Actions) destination. You can configure the new Actions mode destination and connect it to the same source(s) as the Classic destination and manually verify it before fully switching over.
diff --git a/src/connections/destinations/catalog/actions-insider-cloud/index.md b/src/connections/destinations/catalog/actions-insider-cloud/index.md
new file mode 100644
index 0000000000..a05cf98b3c
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-insider-cloud/index.md
@@ -0,0 +1,45 @@
+---
+title: Insider Cloud Mode (Actions)
+id: 643697f531f98a978f414453
+versions:
+ - name: Insider Destination
+ link: /docs/connections/destinations/catalog/insider/
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Insider](https://useinsider.com/integration/segment/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} Growth Management Platform (GMP) helps digital marketers drive growth across the funnel. Insider GMP helps marketers deliver personalized journeys across the web, mobile web, mobile apps, messaging, email, and ad channels using unified data.
+
+This destination is maintained by Insider. For any issues with the destination, contact the [Insider Support team.](mailto:insiderhelp@useinsider.com){:target="_blank”}
+
+## Benefits of Insider (Actions) vs Insider Classic
+
+Insider (Actions) provides the following benefits over the classic Insider destination:
+
+- **Adjustable Mappings**: By using Insider (Actions), you can map your events and attributes to Insider events and attributes, and easily adjust as needed.
+- **Data Consistency**: Pre-Built Mappings can help you to integrate Insider faster and ensure data consistency between Insider and Segment.
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+
+2. Find the Destinations Actions item in the left navigation, and click it.
+
+3. Click Configure Insider.
+
+4. Select an existing Source to connect to Insider Cloud Mode (Actions) and click **Next**.
+
+5. Give your destination a name and click **Create destination**.
+
+6. On the settings page for your destination, add the following settings:
+
+ - **Account Name**: Your Insider Account (Partner) Name.
+ - **API Key**: Your Unified Customer Database API Key, see how you can generate API key in the [Insider Academy API Authentication Tokens](https://academy.useinsider.com/docs/api-authentication-tokens#generate-api-key){:target="_blank”} documentation.
+
+7. Enable your destination and click **Save**.
+
+{% include components/actions-fields.html %}
+
+## Migration from the classic Insider destination
+
+If you’re already using Insider (Classic) Destination, you’re not expected to have breaking changes when upgrading to the Insider (Actions) destination. You can configure the new Actions mode destination and connect it to the same source(s) as the Classic destination and manually verify it before fully switching over.
diff --git a/src/connections/destinations/catalog/actions-intercom-cloud/index.md b/src/connections/destinations/catalog/actions-intercom-cloud/index.md
index 02cc17ed7b..b62ec0b0d3 100644
--- a/src/connections/destinations/catalog/actions-intercom-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-intercom-cloud/index.md
@@ -24,6 +24,9 @@ Intercom Cloud Mode (Actions) provides the following benefits over the classic I
- **Granular control over data sent.** You can customize the conditions under which the events are sent to Intercom.
- **Support for lead creation.** You can create contacts with a role of `lead`, associate them with a company, send events for them, and convert them to a `user`.
+## Limitations of Intercom Cloud Mode (Actions)
+
+The Intercom Cloud Mode (Actions) destination doesn't have access to Intercom’s chat widget. Implement the [Intercom Web Actions](/docs/connections/destinations/catalog/actions-intercom-web/) destination if you need access to Intercom's chat widget.
## Getting started
@@ -40,7 +43,7 @@ Intercom Cloud Mode (Actions) provides the following benefits over the classic I
## FAQ & Troubleshooting
### Why is a company I created missing from my Intercom dashboard?
-If a company is created without an attached user, the company does not appear on Intercom's dashboard. This is expected. Once a user is attached to the company, it should appear in the list of companies.
+If a company is created without an attached user, the company does not appear on Intercom's dashboard. This is expected. Once a user is attached to the company, it should appear in the list of companies. You can associate a company with a user by providing your Identify Contact mapping with a user's `External ID`, `Email Address`, or `Contact ID`.
### Why isn’t a user getting attached to a company?
When you use the Identify Company action, Segment creates or updates a company's information. In the same action, Segment also attaches the user in your group call to that company. If the user doesn't exist in Intercom when the action runs, Segment creates or updates the company but can't attach the user. Ensure the user is created in Intercom first.
diff --git a/src/connections/destinations/catalog/actions-intercom-web/index.md b/src/connections/destinations/catalog/actions-intercom-web/index.md
index 42d77ffb60..bcbd869c67 100644
--- a/src/connections/destinations/catalog/actions-intercom-web/index.md
+++ b/src/connections/destinations/catalog/actions-intercom-web/index.md
@@ -28,8 +28,23 @@ Intercom Web (Actions) provides the following benefits over the classic Intercom
- **Clearer mapping of data.** Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to the destination.
- **Granular control over data sent.** You can customize the conditions under which the events are sent to Intercom.
- **Selectively shows the Intercom chat widget.**
+
+### Intercom's chat widget
-## Getting Started
+The [Intercom Cloud Mode (Actions)](/docs/connections/destinations/catalog/actions-intercom-cloud/) destination doesn't have access to Intercom’s chat widget. Only the [Intercom Web (Actions)](/docs/connections/destinations/catalog/actions-intercom-web/) destination has access to this.
+
+If you're using the [Analytics.js source](/docs/connections/sources/catalog/libraries/website/javascript/), use the Intercom Web Mode (Actions) destination which sends data directly to Intercom from the client-side by loading the Intercom SDK directly onto your website.
+
+However, [Intercom Cloud Mode (Actions)](/docs/connections/destinations/catalog/actions-intercom-cloud/) sends data to Segment, after which Segment forwards the data to Intercom. This allows Segment users to send data to Intercom from sources that are incompatible with their SDK.
+
+When you configure the Segment Intercom destination in device-mode, you'll have access to Intercom's chat widget without loading Intercom separately outside of Segment.
+
+To access the Intercom Messaging Box, you'll need to configure and connect the Intercom Web (Actions) destination to your Analytics.js source.
+
+> success ""
+> Visit the [Destination Overview docs](/docs/connections/destinations/#connection-modes) to learn the difference between cloud and device modes.
+
+## Getting started
1. From the Segment web app, navigate to **Connections > Catalog**.
2. Search for **Intercom Web (Actions)** in the Destinations Catalog, and select the destination.
@@ -39,4 +54,21 @@ Intercom Web (Actions) provides the following benefits over the classic Intercom
6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
7. Enable the destination and configured mappings.
+> info "Regional Data Hosting in the EU and Australia"
+> For Regional Data Hosting in the EU and Australia, you'll need an Intercom plan that [supports regional data hosting](https://www.intercom.com/help/en/articles/5778275-additional-details-on-intercom-regional-data-hosting){:target="_blank"}.
+
+> info ""
+> Segment doesn't support the creation of **Leads** for Intercom Web. Segment recommends using [Intercom Cloud Mode](/docs/connections/destinations/catalog/actions-intercom-cloud/) to support leads creation.
+
{% include components/actions-fields.html settings="true"%}
+
+## Troubleshooting
+
+### Requests to Intercom return a 404 response
+If you are seeing 404 responses in your browser's network tab, you've likely encountered one of two issues:
+
+- You set the wrong App ID on the Intercom Actions (Web) destination settings page.
+- You set the wrong Regional Data Hosting value on the Intercom Actions (Web) destination settings page. Intercom gates regional endpoints by plan level, so you may not have access to EU data hosting.
+
+### Intercom does not support rETL event batching
+The Intercom (Web) Actions destination does not support the bulk contacts endpoint, and therefore is unable to support batching events in rETL.
diff --git a/src/connections/destinations/catalog/actions-ironclad/index.md b/src/connections/destinations/catalog/actions-ironclad/index.md
index acd84add46..612f48d14e 100644
--- a/src/connections/destinations/catalog/actions-ironclad/index.md
+++ b/src/connections/destinations/catalog/actions-ironclad/index.md
@@ -14,9 +14,6 @@ id: 63c874d328bd6bd1aa1f90a0
Ironclad maintains this destination. Contact [support@ironcladhq.com](mailto:support@ironcladhq.com) with any questions.
-
-{% include content/ajs-upgrade.md %}
-
## Benefits of Ironclad Clickwrap (Actions)
Ironclad (Actions) provides the following benefits:
diff --git a/src/connections/destinations/catalog/actions-iterable/index.md b/src/connections/destinations/catalog/actions-iterable/index.md
new file mode 100644
index 0000000000..cafad4bb25
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-iterable/index.md
@@ -0,0 +1,83 @@
+---
+title: Iterable (Actions) Destination
+hide-boilerplate: true
+id: 645babd9362d97b777391325
+hide-dossier: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Iterable](https://www.iterable.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a cross-channel marketing platform that powers unified customer experiences and empowers you to create, optimize and measure every interaction across the entire customer journey.
+
+This destination is maintained by Iterable. For any issues with the destination, [contact the Iterable Support team](mailto:support@iterable.com).
+
+> success ""
+> This page is about the [Actions-framework](/docs/connections/destinations/actions/) Iterable Segment destination. There's also a page about the [non-Actions Iterable destination](/docs/connections/destinations/catalog/iterable/). Both of these destinations receive data from Segment.
+
+## Benefits of Iterable (Actions) vs Iterable Classic
+
+Iterable (Actions) provides the following benefit over Iterable Classic:
+
+- **Transparent data mapping**. The Classic Iterable destination receives data from Segment and converts Segment events to Iterable's format using hard coded mappings that are unable to be adjusted. The Iterable (Actions) destination allows clients to fully define their own mappings of Segment events, ensuring they receive data structured specifically for their needs.
+
+## Getting Started
+
+Follow these steps to connect the Iterable (Actions) destination to your Segment sources:
+
+1. Access the Segment web app and click on **Catalog**.
+2. In the Catalog, use the search function to find "Iterable". Select the **Iterable (Actions)** destination from the results, and choose which of your sources to connect the destination to.
+
+
+1. From the Segment web app, navigate to **Connections > Catalog > Destinations**.
+2. Click the **Destination Actions** category item in the left navigation.
+3. Search for **Iterable (Actions)** and select it.
+4. Click **Configure Iterable (Actions)**.
+5. Select an existing Source to connect to Iterable (Actions).
+6. Complete the Destination Settings as listed below.
+
+{% include components/actions-fields.html %}
+
+## Important differences from the classic Iterable destination
+
+Since the release of Iterable's Classic Segment destination, Iterable has expanded its support for multiple project types. To determine the appropriate identifier for your project type, please refer to the list of available project types and their respective identifiers found at the following link: [Project Types and Unique Identifiers](https://support.iterable.com/hc/en-us/articles/9216719179796-Project-Types-and-Unique-Identifiers){:target="_blank”}.
+
+### Creating or Updating Users
+
+The method by which you identify users depends on the project type you use:
+
+#### Email-based Projects
+In email-based projects, it is necessary to include the email to successfully create a user in Iterable. Once both the email and `userId` have been set in Iterable, the `userId` can be utilized for any future user updates.
+
+#### UserID-based Projects
+For userID-based projects, a unique `userId` is required for creating a user in Iterable. While it is optional to add an email to a userID-based user profile, all subsequent user updates must be performed using the `userId`.
+
+#### Hybrid Projects**
+In hybrid projects, you have the flexibility to choose between using a unique email or a `userId` to create a user in Iterable.
+
+In Iterable's previous classic destination, when making Identify calls, certain context fields were automatically mapped to user profiles. However, this behavior has been changed. Please note that the following context fields are no longer automatically mapped to Iterable user profiles during Identify calls:
+
+- app
+- device
+- ip
+- locale
+- page
+- timezone
+
+To include these fields in user profiles, pass them as traits with Identify calls. This change offers more control and customization options for managing user data within Iterable.
+
+Additionally, the integration has been updated to support explicit mappings for updating the `phoneNumber` user profile field, as well as support of the `mergeNestedObject` boolean field in user update calls.
+
+### Custom Events
+
+In UserID and Hybrid projects, when a passed ``userId`` doesn't match an existing user, Iterable creates a new user automatically. In email-based projects, tracking a custom event for an unidentified user will not create a user profile.
+
+To ensure proper user profile creation in email-based projects:
+
+- Call the Identify method with both a ``userId`` and an `email` to create a user profile.
+- After you create the user profile, proceed with tracking the custom event for that user.
+
+If you follow this approach, you can guarantee the creation of user profiles and accurately track custom events within Iterable for email-based projects.
+
+### Commerce Events
+
+In the classic destination of Iterable, cart updates were associated with Segment's `Product Added` and `Product Removed` events. However, in the Action destination, there have been updates to the default mappings. Now, custom events titled `Cart Updated` are routed to Iterable's Update Cart API.
diff --git a/src/connections/destinations/catalog/actions-iterate/index.md b/src/connections/destinations/catalog/actions-iterate/index.md
index cdbb4e0f5c..65b6f409b3 100644
--- a/src/connections/destinations/catalog/actions-iterate/index.md
+++ b/src/connections/destinations/catalog/actions-iterate/index.md
@@ -2,24 +2,18 @@
title: Iterate (Actions) Destination
hide-boilerplate: true
hide-dossier: true
-hidden: true
-private: true
+beta: true
id: 62fec615a42fa3dbfd208ce7
---
-
{% include content/plan-grid.md name="actions" %}
-
+
[Iterate](https://iteratehq.com){:target="_blank"} helps you harness customer insights across your whole business with the world’s leading Customer Insights Manager. Put customer insights at the center of your business with user-friendly research tools that look and feel like your brand. With mobile, website and email surveys that are highly targeted, user-friendly, and on-brand, you can learn directly from your visitors, customers, and users.
Iterate maintains this destination. See [Iterate's documentation](http://help.iteratehq.com/en/articles/6515486-segment-integration){:target="_blank"} or contact [support@iteratehq.com](mailto:support@iteratehq.com) with any questions.
-
-
-{% include content/ajs-upgrade.md %}
-
## Benefits of Iterate (Actions)
@@ -29,7 +23,7 @@ Iterate (Actions) provides the following benefits:
- **More control** - Actions-based destinations enable you to define the mapping between the data Segment receives from your sources, and the data Segment sends to Iterate.
- **Default property mappings** - Default mappings from the Segment like userId, userTraits, and more, allow data to be mapped correctly without any setup required.
-
+
## Getting started
@@ -40,16 +34,9 @@ Iterate (Actions) provides the following benefits:
5. Select an existing Source to connect to Iterate (Actions).
6. Set your Embed API Key. See [Getting your Embed API Key](#getting-your-embed-api-key) for details.
-
{% include components/actions-fields.html %}
-
-
## Get your Embed API Key
To get your Embed API Key:
diff --git a/src/connections/destinations/catalog/actions-jimo/index.md b/src/connections/destinations/catalog/actions-jimo/index.md
new file mode 100644
index 0000000000..0fc4c1e8bb
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-jimo/index.md
@@ -0,0 +1,20 @@
+---
+title: Jimo (Actions) Destination
+id: 652d4cf5e00c0147e6eaf5e7
+beta: true
+---
+{% include content/plan-grid.md name="actions" %}
+
+[Jimo](https://usejimo.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} helps you to publish personalized product experiences to elevate adoption and user engagement without code as a layer on top of your app.
+
+This destination is maintained by Jimo. For any issues with the destination, [contact their Support team](mailto:support@usejimo.com).
+
+## Getting started
+
+1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Jimo (Actions)".
+2. Select Jimo (Actions) and click **Add Destination**.
+3. Select an existing Source to connect to Jimo (Actions).
+4. Open your [Jimo dashboard](https://i.usejimo.com/settings/general){:target="_blank"}, find and copy your **project id**.
+5. Return to Segment and open the destination settings for the Jimo (Actions) destination that you just created. Enter your Jimo **project id**.
+
+{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-kafka/index.md b/src/connections/destinations/catalog/actions-kafka/index.md
new file mode 100644
index 0000000000..c114335dca
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-kafka/index.md
@@ -0,0 +1,101 @@
+---
+title: Kafka Destination
+beta: true
+id: 65dde5755698cb0dab09b489
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Kafka](https://kafka.apache.org/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} provides a highly scalable and fault-tolerant messaging system that enables real-time data processing and stream processing at scale. When integrated with Segment, Kafka serves as a powerful backbone for managing and processing event data collected by Segment, allowing businesses to efficiently ingest, route, and analyze data across various applications and systems in real time.
+
+## Getting started
+
+### Create the Kafka Destination
+
+1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Kafka".
+2. Select the "Kafka" tile and click **Add Destination**.
+3. Select an existing Source to connect to Kafka.
+4. Enter a name for your Kafka destination.
+
+### Configure the Kafka Destination
+
+The way you've configured your Kafka Cluster informs the authentication and encryption settings you'll need to apply to the Segment Kafka Destination. You may need the assistance of someone technical to provide values for the following Settings:
+
+
+ -
+ On the Settings tab, enter values into the **Client ID**, **Brokers** and **Authentication Mechanism** setting fields.
+
+ -
+ Populate fields based on the value you selected from the Authentication Mechanism field:
+
+ -
+ Plain or SCRAM-SHA-256 / 512 authentication: provide values for Username and Password fields.
+
+ -
+ AWS authentication: provide values for AWS Access Key ID and AWS Secret Key fields, and optionally for the AWS Authorization Identity field.
+
+ -
+ Client Certificate authentication: provide values for the SSL Client Key and SSL Client Certificate fields.
+
+
+
+ -
+ Populate the **SSL Certificate Authority** field, if necessary.
+
+ -
+ Save your changes and proceed to [Configure the Send Action](#configure-the-send-action).
+
+
+
+### Configure the "Send" Action
+
+
+ -
+ Select the Mappings tab and add a new **Send** mapping.
+
+ -
+ Select a Topic to send data to. This field should auto-populate based on the credentials you provided in the Settings tab.
+
+ -
+ Map your payload using the **Payload** field.
_(Optional)_: Specify partitioning preferences, Headers and Message Key values.
+
+ -
+ Save and enable the Action, then navigate back to the Kafka destination's Settings tab to enable and save the Destination.
+
+
+
+{% include components/actions-fields.html %}
+
+## FAQ
+
+### Which Kafka Platforms are supported?
+
+The Kafka Destination can send data to Topics on self-hosted Kafka Clusters, or to Clusters hosted on Managed Service platforms like **Confluent Cloud** and **Aiven**.
+
+### Which data formats are supported?
+
+Segment sends data to Kafka in JSON format only. Segment does not yet support other formats, like Avro or Protobuf.
+
+### Which authentication mechanisms are supported?
+
+The Authentication Mechanism is controlled with the **Authentication Mechanism** Setting field.
+
+Segment supports the following SASL-based authentication methods:
+- Plain
+- SCRAM-SHA-256
+- SCRAM-SHA-512
+- AWS
+
+Segment also supports **Client Certificate** authentication.
+
+### How is partitioning controlled?
+
+The **Send** Action provides multiple ways to specify which Partition an event should be sent to.
+
+- **Partition**: Use this field to specify the name of the Partition Segment should send events to.
+- **Default Partition**: Use this field to specify a default Partition. Segment uses this when you don't provide a value in the **Partition** field.
+- **Message Key**: Segment uses a hash of this field's value to determine which Partition should receive an event. If you don't provide a Message Key, Segment uses a round robin algorithm to select the partition to send the event to.
+
+### What is the "SSL - Reject Unauthorized Certificate Authority" field for?
+
+This field specifies if Segment should reject server connections when a certificate is not signed by a trusted Certificate Authority (CA). This can be useful for testing purposes or when using a self-signed certificate.
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-kameleoon/index.md b/src/connections/destinations/catalog/actions-kameleoon/index.md
new file mode 100644
index 0000000000..3b07f639d2
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-kameleoon/index.md
@@ -0,0 +1,49 @@
+---
+title: Kameleoon (Actions) Destination
+beta: true
+id: 652ea51a327a62b351aa12c0
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Kameleoon](https://www.kameleoon.com/en?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a versatile optimization, experimentation, and personalization platform. It is used to enhance website and mobile app experiences while enabling experimentation.
+
+This destination is maintained by Kameleoon. For any issues with the destination, [contact the Kameleoon Support team](mailto:support@kameleoon.com).
+
+## Benefits of Kameleoon (Actions) vs Kameleoon Classic
+
+Kameleoon (Actions) provides the following benefits over the classic Kameleoon destination:
+
+- **Event Flexibility**. Tailor your events precisely by leveraging Segment's event filters, allowing for more granular control over the data you receive in Kameleoon.
+- **Attribute Mapping**. Seamlessly map attributes before forwarding events, ensuring a smooth integration process and accurate representation of your data in Kameleoon.
+- **Monitoring Capabilities**. Take advantage of Segment's monitoring tools to keep a vigilant eye on your operations, providing valuable insights and ensuring a seamless data flow into Kameleoon.
+
+## Getting started
+
+1. Navigate to **Connections > Catalog** in the Segment web app.
+2. Search for *Kameleoon (Actions)* and select the destination.
+3. Click **Add destination**.
+4. Select the Source you want to connect to Kameleoon (Actions) and click **Confirm Source**.
+5. On the **Basic Settings** side panel, complete the required fields:
+ - **Name**: Enter a name to help you identify this destination in Segment
+ - **API Key**: Paste your Kameleoon API key. To generate an API Key, see [Kameleoon's documentation on generating an API key](https://help.kameleoon.com/setting-up-segment-destination-actions/#Kameleoon_setup){:target="_blank”}.
+ - **Sitecode**: Paste your Kameleoon project sitecode. You can find it in the [project dashboard](https://help.kameleoon.com/question/how-do-i-find-my-site-id/){:target="_blank”}.
+6. Enable the destination by clicking the **Enable Destination** toggle switch.
+7. Click **Save Changes**.
+
+
+{% include components/actions-fields.html %}
+
+
+The integration requires that you use the same system of identifiers for both tools. While Segment uses the userId, Kameleoon uses the kameleoonVisitorCode. In order to identify which visitor triggered the forwarded Segment events, you must include the kameleoonVisitorCode inside your Segment events. To know more, see [Kameleoon's documentation on matching a Segment user with a Kameleoon visitor](https://help.kameleoon.com/setting-up-segment-destination-actions/#Matching_an_Segmentio_user_with_a_Kameleoon_visitor){:target="_blank”}.
+
+
+## Migration from the classic Kameleoon destination
+
+To migrate from the classic Kameleoon destination:
+1. Include the `kameleoonVisitorCode` in your Segment events for accurate visitor tracking. To know more, see [Kameleoon's documentation on matching a Segment user with a Kameleoon visitor](https://help.kameleoon.com/setting-up-segment-destination-actions/#Matching_an_Segmentio_user_with_a_Kameleoon_visitor){:target="_blank”}.
+2. Define mapping and filters on the destination configuration page.
+3. Test events to ensure accurate goal creation and conversion tracking.
+4. Activate the Kameleoon (Actions) destination when everything is ready and tested.
+5. Deactivate the classic Kameleoon destination.
+
diff --git a/src/connections/destinations/catalog/actions-klaviyo/index.md b/src/connections/destinations/catalog/actions-klaviyo/index.md
new file mode 100644
index 0000000000..41864c005a
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-klaviyo/index.md
@@ -0,0 +1,100 @@
+---
+title: Klaviyo (Actions) Destination
+id: 650bdf1a62fb34ef0a8058e1
+beta: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Klaviyo](https://www.klaviyo.com){:target="_blank"} is a powerful email platform focused on ecommerce that helps companies make more money. It supports segmentation based on category and event triggers like product bought, page viewed, email engagement, or amount spent.
+
+It measures opens, clicks, revenue generated, breakdown of generated revenue based on custom attributes (like campaign type or amount gained per recipient), and provides trend reports, cohort analysis, and subscriber growth.
+
+Klaviyo lets you send personalized newsletters, automates triggered emails, product recommendations, welcome campaigns, order announcements, push notifications, and syncs your data to Facebook custom audiences.
+
+## Benefits of Klaviyo (Actions)
+
+Klaviyo (Actions) provides the following benefits:
+
+- **Simple setup** - Klaviyo (Actions) has a streamlined default setup process making it easier to get started in a way that "just works".
+- **More control** - Actions-based destinations enable you to define the mapping between the data Segment receives from your sources, and the data Segment sends to Klaviyo.
+- **Default property mappings** - Default mappings from the Segment like event, timestamp, and more, allow data to be mapped correctly without any setup required.
+
+> info ""
+> Segment automatically migrated all classic Klaviyo destinations configured in Cloud mode to the Klaviyo (Actions) destination in June 2024.
+>
+> If you are a Klaviyo classic user, view information about steps you might need to take in the [Migrate to the Klaviyo (Actions) destination](/docs/connections/destinations/catalog/klaviyo#migrate-to-the-klaviyo-actions-destination) documentation.
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**.
+2. Search for **Klaviyo (Actions)** in the Catalog, select it, and choose which of your sources to connect the destination to.
+3. Navigate to [Account > Settings > API Keys](https://www.klaviyo.com/account#api-keys-tab){:target="_blank"} in Klaviyo's UI and copy your API Key into the Segment Settings UI.
+
+> info "Generate a Private API Key with full access to Klaviyo's Accounts, Campaigns, Events, List, Profiles, Segments, and Subscriptions APIs"
+> Create a key by going to Klaviyo's UI and clicking [Account > Settings > API Keys > Create API Key](https://www.klaviyo.com/account#api-keys-tab){:target="_blank"} to generate a Private API Key. After you've created a key, copy it into the Segment Settings UI.
+
+{% include components/actions-fields.html %}
+
+## Using Klaviyo with RETL
+
+Klaviyo (Actions) Destination can accept [RETL](/docs/connections/reverse-etl/) data. You can send the models you created in your data warehouse source. Follow [the steps](/docs/connections/reverse-etl/#step-1-add-a-source) to create your data warehouse source and set up models.
+
+| Action | Added | Updated | Deleted |
+| ------------------- | ------------------------------------------------------- | --------------------------------------------------------- | -------------------------------------------------------------- |
+| Order Completed | | | |
+| Track Event | | | |
+| Upsert Profile | | | |
+| Remove Profile | | | |
+| Subscribe Profile | | | **\*** |
+| Unsubscribe Profile | | | |
+
+> info ""
+> **\*** Though technically possible, it may not be the most intuitive approach to using RETL.
+>
+> **e.g.,** Triggering a **Subscribe Profile** action when a user is **deleted** from a Model that queries unsubscribed users.
+
+In order to add users to a list, use the **Upsert Profile** Action and fill out the **List** field with the Klaviyo list to add the profile to.
+
+Follow these steps to create a list in Klaviyo:
+
+1. Navigate to **Audience > Lists & Segments**.
+2. Click **Create List/Segment**.
+3. Choose **List**.
+4. Give your list a name and add any applicable tags.
+5. Click **Create List**.
+
+## Using Klaviyo with Engage
+
+Klaviyo (Actions) Destination can accept your [Engage](/docs/engage/) data. If you wish to add a profile to a list associated with the Engage audienceId, you **don't** need to create a list in Klaviyo. During the first sync with the **Add Profile To List (Engage)** Mapping, Segment creates a list with the same ID as your audience.
+
+To add and remove profiles in Klaviyo with Engage Audience data:
+
+1. Create and configure your Engage Audience.
+2. Navigate to **Engage > Engage Settings > Destinations** and click **Add Destination**.
+3. Select **Klaviyo (Actions)**.
+4. Select your Audience Space as the source, and name your destination.
+5. On the **Mappings** tab, click **Add Mapping** and select **Add Profile To List (Engage)**.
+6. Click **Save** and make sure to enable the mapping.
+7. On the **Mappings** tab, click **Add Mapping** and select **Remove Profile from List (Engage)**.
+8. Click **Save** and make sure you enable the mapping.
+9. Enable the destination.
+10. On the **Engage > Audiences > (your audience)** page, click **Add Destination** and select the destination created.
+11. In the settings that appear in the side panel, toggle the **Send Track** option on, and don't change the **Audience Entered/Audience Exited** event names.
+12. Click **Save Settings**.
+
+## FAQ
+
+### Dealing with 429 Responses from Klaviyo's API
+
+If you're encountering rate limiting issues, consider enabling batching for the Action receiving these errors. Ensure that within the mapping configuration, "Batch data to Klaviyo" is set to "Yes". This adjustment can help alleviate the rate limiting problem.
+
+### Can I send Engage Audiences to a pre-created Klaviyo List?
+
+No. Engage audiences are designed to initiate the creation of new lists in Klaviyo when you use the "Add Profile to List - Engage" mapping. You cannot link Engage lists to existing Klaviyo lists and cannot edit the List ID for Engage audiences.
+
+### How can I unsuppress a profile when adding it to a list?
+
+When adding a user to a list, our action make use of the [Bulk Profile Import](https://developers.klaviyo.com/en/reference/spawn_bulk_profile_import_job){target="_blank"} endpoint (when batching is enabled), and the [Add Profile To List](https://developers.klaviyo.com/en/reference/create_list_relationships){target="_blank"} endpoint for non-batched requests. Both of which will not update a users suppression status if they were previously suppressed.
+
+To ensure a suppressed profile gets unsuppressed, you can use the "Subscribe Profile" action. When a profile is subscribed in Klaviyo, it automatically unsuppresses any previously suppressed user. You can combine this action with other actions to achieve your goal. If this solution does not fully address your use case, please contact us at friends@segment.com so we can consider your specific requirements.
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-koala/index.md b/src/connections/destinations/catalog/actions-koala/index.md
new file mode 100644
index 0000000000..b91b239676
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-koala/index.md
@@ -0,0 +1,22 @@
+---
+title: Koala Destination
+id: 6230c835c0d6535357ee950d
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+Koala enables you to identify website visitors with ease so you can turn traffic into actionable leads. See which companies are researching your docs, checking out your pricing page, and showing intent to buy.
+
+Segment is the easiest way to install Koala. If you've already got Segment running on your website, Koala recommends this approach. With Segment, you can instrument Koala without code.
+
+Koala maintains this destination. For any issues with the destination, [contact the Koala Support team](mailto:support@getkoala.com).
+
+## Getting Started
+
+1. From the Segment web app, navigate to **Connections > Catalog > Destinations**.
+2. Search for *Koala* and select **Add Destination**.
+4. Select the web source that will send data to Koala and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/).
+5. On the **Settings** tab, input your **Public API Key** which can be found in your Koala workspace settings under **Settings > Install**.
+6. Once connected, you can configure how you want to send data to Koala. By default, Segment forwards track events and identify events to Koala. Koala recommends sticking with the defaults.
+
+{% include components/actions-fields.html settings="true"%}
diff --git a/src/connections/destinations/catalog/actions-launchdarkly-audiences/index.md b/src/connections/destinations/catalog/actions-launchdarkly-audiences/index.md
new file mode 100644
index 0000000000..ba6d721e76
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-launchdarkly-audiences/index.md
@@ -0,0 +1,29 @@
+---
+title: LaunchDarkly Audiences Destination
+id: 64e72a310da9ebedf99c8937
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[LaunchDarkly](https://launchdarkly.com){:target="_blank"} is a feature management platform that empowers development teams to safely deliver, control, and measure their software through feature flags.
+
+With LaunchDarkly, you can release features that target specific groups, such as beta users, and premium accounts, using segments. This destination allows you to sync Engage Audiences to LaunchDarkly segments, letting you concentrate more on deploying features and less on managing end users between platforms.
+
+LaunchDarkly maintains this destination. For any issues with the destination, [contact the LaunchDarkly Support team](mailto:support@launchdarkly.com).
+
+## Getting started
+
+1. In LaunchDarkly, navigate to [Account settings](https://app.launchdarkly.com/settings/projects){:target="_blank"} and copy the client-side ID for the project and environment where you would like to create an Engage Audience synced segment.
+2. In LaunchDarkly, create a service token with either a Writer role or a custom role. If your service token has a custom role, it must have the actions `createSegment` and `updateIncluded` to sync a segment from an Engage Audience. To learn how to create a service token, read [Creating API access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens#creating-api-access-tokens){:target="_blank"}.
+3. From the Segment web app, navigate to **Engage > Audiences**. Ensure you are in the Engage space you plan to use with the LaunchDarkly Audiences destination. Either choose an existing Engage audience or create a new one. This is the audience you plan to sync with LaunchDarkly.
+4. Navigate to **Engage > Engage Settings** and click **Destinations**. Ensure you are still in the correct Engage space.
+5. Search for `LaunchDarkly Audiences` and select the destination. Click **Add destination**.
+6. On the **Select Source** screen, your Engage space should already be selected as the source. Click **Confirm Source**.
+7. On the Destination **Settings** tab, name your destination and provide your LaunchDarkly client-side ID and service token.
+8. Toggle **Enable Destination** on and click **Save Changes**.
+9. Navigate to the **Mappings** tab, click **New Mapping**, and select the **Sync Engage Audience to LaunchDarkly** pre-built mapping.
+10. Under **Select mappings**, modify the default mappings as needed. In most cases, you shouldn't need to make any changes.
+11. Click **Save**.
+12. Ensure the **Status** toggle on the **Mappings** tab is enabled.
+
+{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-launchdarkly/index.md b/src/connections/destinations/catalog/actions-launchdarkly/index.md
index bbacc1335f..cfaaa98b35 100644
--- a/src/connections/destinations/catalog/actions-launchdarkly/index.md
+++ b/src/connections/destinations/catalog/actions-launchdarkly/index.md
@@ -6,16 +6,14 @@ id: 624dddd054ced46facfdb9c0
{% include content/plan-grid.md name="actions" %}
-[LaunchDarkly](https://launchdarkly.com) is a feature management platform that empowers development teams to safely deliver, control, and measure their software through feature flags.
+[LaunchDarkly](https://launchdarkly.com){:target="_blank”} is a feature management platform that empowers development teams to safely deliver, control, and measure their software through feature flags.
With LaunchDarkly, you can run experiments on any feature flag. This destination allows you to connect existing Segment events to LaunchDarkly custom metrics for use in LaunchDarkly experiments.
> success ""
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) LaunchDarkly Segment destination. There's also a page about the [non-Actions LaunchDarkly destination](/docs/connections/destinations/catalog/launchdarkly-events/). Both of these destinations receives data from Segment.
-
-{% include content/ajs-upgrade.md %}
@@ -31,7 +29,7 @@ LaunchDarkly (Actions) provides the following benefits over the classic LaunchDa
## Getting started
To get started with LaunchDarkly (Actions):
-1. In LaunchDarkly, navigate to [Account settings](https://app.launchdarkly.com/settings/projects) and copy the client-side ID for the project and environment that you would like to connect to Segment.
+1. In LaunchDarkly, navigate to [Account settings](https://app.launchdarkly.com/settings/projects){:target="_blank”} and copy the client-side ID for the project and environment that you would like to connect to Segment.
2. From the Segment web app, click **Catalog**, then click **Destinations**.
3. Search for **LaunchDarkly (Actions)** and select it.
4. Click **Configure LaunchDarkly**.
diff --git a/src/connections/destinations/catalog/actions-launchpad/index.md b/src/connections/destinations/catalog/actions-launchpad/index.md
index 4192a2d095..cf0a06327a 100644
--- a/src/connections/destinations/catalog/actions-launchpad/index.md
+++ b/src/connections/destinations/catalog/actions-launchpad/index.md
@@ -14,9 +14,6 @@ id: 63e42aa0ed203bc54eaabbee
Launchpad maintains this destination. For any issues with the destination, [contact the Launchpad Support team](mailto:support@launchpad.pm).
-{% include content/ajs-upgrade.md %}
-
-
## Getting started
1. From the Segment web app, navigate to **Connections > Catalog** and click **Destinations**.
diff --git a/src/connections/destinations/catalog/actions-linkedin-audiences/index.md b/src/connections/destinations/catalog/actions-linkedin-audiences/index.md
index 1228e43967..9aeaf52035 100644
--- a/src/connections/destinations/catalog/actions-linkedin-audiences/index.md
+++ b/src/connections/destinations/catalog/actions-linkedin-audiences/index.md
@@ -4,6 +4,7 @@ hide-personas-partial: true
hide-boilerplate: true
hide-dossier: false
id: 62f435d1d311567bd5bf0e8d
+engage: true
---
diff --git a/src/connections/destinations/catalog/actions-linkedin-conversions/index.md b/src/connections/destinations/catalog/actions-linkedin-conversions/index.md
new file mode 100644
index 0000000000..9c15b0e465
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-linkedin-conversions/index.md
@@ -0,0 +1,49 @@
+---
+title: LinkedIn Conversions API Destination
+id: 652e765dbea0a2319209d193
+beta: true
+---
+
+The LinkedIn Conversions API (CAPI) is a conversion tracking tool that creates a direct connection between marketing data from an advertiser’s server and LinkedIn. This integration enables advertisers to measure the performance of their LinkedIn marketing campaigns no matter where the conversion happens and use this data to power campaign optimization. The Conversions API can help strengthen performance and decrease cost per action with more complete attribution, improved reliability, and optimized delivery.
+
+This destination is maintained by Segment. For any issues with the destination, [contact the Segment Support team](mailto:friends@segment.com).
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Search for “LinkedIn Conversions API” in the Destinations Catalog, and select the destination.
+3. On the LinkedIn Conversions API overview page, click **Add destination**.
+4. Select the source that you want to connect to the LinkedIn Conversions API and click **Next**.
+5. Enter a name for your destination and click **Create destination**.
+6. On the Settings tab, click Connect to `[destination-name]` and follow the prompts to authenticate with LinkedIn using OAuth.
+7. Enable the destination and click **Save Changes**.
+
+### Set up a mapping to Stream Conversion Events
+
+Follow the steps in the Destination Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). You must create 1 mapping for every conversion rule. After you create a conversion rule, you cannot update the connected LinkedIn Ad account.
+
+1. On the Mappings tab, click on **+ New Mapping** and Select **Stream Conversion Event**.
+2. Select the events you'd like to map and send to your LinkedIn Conversions API destination.
+3. Create a conversion rule or enter the link to an existing rule. _If you chose to create a new conversion rule, Segment creates the conversion rule as soon as you click **Save**._
+4. Configure the mappings to map event fields and user attributes from your source to the Conversion API.
+5. Click **Save**.
+
+After you've created a Stream Conversion Event mapping, Segment displays the connected rule for each mapping on the Mappings tab. To update the conversion rule you created, select the menu icon for the mapping you'd like to update and click **Edit Mapping**. Scroll to section 3, Create a Conversion Rule, and select **Edit your configuration**. After making changes to your conversion rule, click **Save** to save your changes. You can make changes to all fields except for the Ad account field. After you save your changes, Segment updates the conversion rule in LinkedIn.
+
+{% include components/actions-fields.html %}
+
+## FAQ and troubleshooting
+
+### Why are my inputs failing?
+
+Your inputs must meet the following criteria:
+- Contains a valid URN with the following format:
`urn:lla:llaPartnerConversion:id`
+- The authenticated user must have write access to the ad account used to create conversion rules
+- Contains a userInfo combination that requires firstName and lastName **OR** a userId mapped to at least one of the following idTypes:
+ - `SHA256_EMAIL`
+ - `LINKEDIN_FIRST_PARTY_ADS_TRACKING_UUID`
+ - `ACXIOM_ID`
+ - `ORACLE_MOAT_ID`
+- `conversionHappenedAt` must be a valid timestamp (milliseconds since epoch) and must have happened in the past 90 days
+
+Any deviations from this specification might lead to failed inputs.
diff --git a/src/connections/destinations/catalog/actions-listrak/index.md b/src/connections/destinations/catalog/actions-listrak/index.md
new file mode 100644
index 0000000000..40ef2f72b0
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-listrak/index.md
@@ -0,0 +1,57 @@
+---
+title: Listrak (Actions) Destination
+id: 64b6a221baf168a989be641a
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Listrak](https://www.listrak.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is the retail industry’s leading customer engagement platform. Listrak delivers results for more than 1,000 retailers by providing best-in-class email, text message marketing, identity resolution marketing and push notifications through seamless cross-channel orchestration. Listrak’s data-first approach delivers 1:1 personalization at scale so you can send messages at precisely the right time across the right combination of channels and devices to maximize customer engagement, revenue, and lifetime value.
+
+Listrak maintains this destination. For any issues with the destination, [contact the Listrak Support team](mailto:support@listrak.com).
+
+## Getting started
+
+To add the Listrak Actions destination:
+
+1. Set up the [Listrak Source](/docs/connections/sources/catalog/cloud-apps/listrak/) first before connecting to the Listrak Actions Destination. Note the API client ID and client secret after creating the integration in Listrak.
+2. From your Segment workspace, go to **Connections > Catalog** and select the **Destinations** tab.
+3. Search for **Listrak (Actions)** in the Catalog and select the destination.
+4. Click **Add destination**.
+5. On the **Select data source** step, select your desired source. The source should not be a Listrak source. If you want to sync an Engage Audience, select the Engage space as the source. Click **Confirm Source**.
+6. On the **Settings** tab, name your destination. For example, `Listrak`.
+7. In the same section of the **Settings** tab, enter your Listrak API client ID and client secret.
+8. Click **Save Changes**.
+9. Follow the steps in the Destinations Actions documentation to [customize mappings](/docs/connections/destinations/actions/#customize-mappings) or follow the steps below to Sync an Engage Audience.
+10. Enable the destination and click **Save Changes**.
+
+### Sync an Engage Audience
+
+To sync an Engage audience with your Listrak (Actions) destination:
+
+1. Each Engage audience to be synced to Listrak must only include email addresses subscribed to the list. To do this, add a condition to the Engage audience that ensures the custom trait for the list exists (eg. have a Custom Trait listrak_list_12345 exists, where 12345 is the list ID).
+2. In Listrak, go to **Contacts > Profile Fields** and click **Create Field Group**.
+3. Enter a name for the Profile Field Group (eg. `Engage Audiences`) and Click **Save**.
+4. Enter a name for the audience for the **Field Name**.
+5. Select **Check Box** for the **Data Type**.
+6. Click the **Update** button.
+7. Go to **Help & Support > API ID Information** and note the list ID and profile field ID.
+8. In Segment, open the previously created Listrak destination.
+9. In the **Mappings** tab, click **New Mapping** and select **Update Email Contact Profile Fields**.
+10. Under **Select events to map and send**, select **Track** for the **Event Type**.
+11. Click **Add Condition** and add this condition: **Event Name** is `Audience Entered`.
+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).
+13. Under **Select mappings**, enter the list ID and map the email address if `context.traits.email` is not desired.
+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**.
+15. Repeat steps 9 through 14 using `Audience Exited` instead of `Audience Entered` in step 11 and `off` instead of `on` in step 14.
+16. **Enable** both mappings.
+17. Go to the **Settings** tab for the destination and **Enable** the destination. Click **Save Changes**.
+18. Select the Engage space and navigate to **Engage > Audiences**. Select the source audience to send to the Listrak destination.
+19. Click **Add Destination** and select the Listrak Audience destination.
+20. In the connection settings that appear on the right-hand side, ensure that the toggle to **Send Track** events is _enabled_, and the toggle to **Send Identify** events is _disabled_.
+21. Click **Save**.
+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”}.
+23. Repeat steps 1 through 21, if you want to sync another audience.
+
+{% include components/actions-fields.html %}
+
+---
diff --git a/src/connections/destinations/catalog/actions-livelike-cloud/index.md b/src/connections/destinations/catalog/actions-livelike-cloud/index.md
index ca952a26be..187f376cce 100644
--- a/src/connections/destinations/catalog/actions-livelike-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-livelike-cloud/index.md
@@ -3,13 +3,13 @@ title: LiveLike Cloud Mode (Actions) Destination
id: 63e42b47479274407b671071
hide-boilerplate: true
hide-dossier: false
-private: true
-hidden: true
----
+private: false
+hidden: false
+---
{% include content/plan-grid.md name="actions" %}
-[LiveLike](https://livelike.com/) is a technology company dedicated to empowering digital experiences that enable deeper fan engagement, increased retention rates, and new monetization opportunities.
+[LiveLike](https://livelike.com/){:target="_blank”} is a technology company dedicated to empowering digital experiences that enable deeper fan engagement, increased retention rates, and new monetization opportunities.
> info ""
> The events transferred from Segment to your LiveLike application will appear under the [Actions](https://docs.livelike.com/docs/reward-actions){:target="_blank"} section.
diff --git a/src/connections/destinations/catalog/actions-liveramp-audiences/index.md b/src/connections/destinations/catalog/actions-liveramp-audiences/index.md
new file mode 100644
index 0000000000..a205f74327
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-liveramp-audiences/index.md
@@ -0,0 +1,74 @@
+---
+title: LiveRamp Audiences Destination
+hide-boilerplate: true
+hide-dossier: false
+id: 644ad6c6c4a87a3290450602
+beta: true
+---
+
+[LiveRamp](https://liveramp.com/){:target="_blank"} gives companies and their partners the power to connect, control, and activate data to transform customer experiences and generate more valuable business outcomes. Segment's integration with LiveRamp lets you push user audiences created in [Twilio Engage](https://www.twilio.com/en-us/engage){:target="_blank"} into your LiveRamp account to execute various marketing use cases.
+
+The LiveRamp Audiences destination allows users to connect their Engage Audiences to LiveRamp through their SFTP or a customer-managed S3 cloud storage bucket. Users will be able to configure their delivery preferences within Segment.
+
+The LiveRamp Audiences destination can be connected to **Twilio Engage sources only**.
+
+## Getting started
+
+### Set up your file drop
+
+#### SFTP
+
+1. Contact your LiveRamp representative to gain a set of [SFTP](https://docs.liveramp.com/connect/en/upload-a-file-via-liveramp-s-sftp.html){:target="_blank"} credentials.
+2. Connect to the SFTP server using the client of your choice, and create a new folder under `/uploads` with the name of your audience.
+
+#### S3
+
+1. Create a new S3 bucket.
+2. Create a new IAM Role with `PutObject` access to the S3 bucket.
+3. Create a new IAM User and assign them the role.
+4. Generate a new Access Key pair for the user and note them down; you'll use it for the settings.
+
+### Connect LiveRamp Audiences
+
+1. Create and configure your Engage Audience.
+2. Navigate to **Engage > Engage Settings > Destinations** and click **Add Destination**.
+3. Select **LiveRamp Audiences**, select your Audience Space as the source, and name your destination.
+4. On the **Mappings** tab, click **Add Mapping** and choose whether your will be using S3 or SFTP to upload the files. Within the mapping, configure which fields from your payload will be included in the files.
+5. Enable the destination and configured mappings.
+6. On the **Engage > Audiences > (your audience)** page, click **Add Destination** and select the destination just created.
+7. In the settings that appear in the side panel, toggle the Send Track option on and do not change the Audience Entered/Audience Exited event names. Click Save Settings
+8. File a [support case](https://docs.liveramp.com/connect/en/considerations-when-uploading-the-first-file-to-an-audience.html#creating-a-support-case){:target="_blank"} with the LiveRamp team to configure and enable ingestion.
+
+{% include components/actions-fields.html settings="false"%}
+
+## Limitations
+
+* Audience must have at least 25 unique members, otherwise the destination will fail and the data will not be synced. This means the Actions Mapping Event Tester does not work (only one test event can be configured).
+* Audience sync happens once per day. On a 24-hour cadence, but can take up to 30 hours.
+* Audience Sync is a full sync, including only users or accounts in the audience at the time of sync.
+* Files are created per audience.
+* After initial ingestion is complete, changing the mappings will cause the LiveRamp ingestion to start failing until ingestion setup is run again.
+* Time to first sync can be up to 3 days, please be patient.
+
+## Trait Enrichment
+
+Use Trait Enrichment to access Segment profile traits when you sync Audiences to Destinations. With Trait Enrichment, you can use custom, SQL, computed, and predictive traits to enrich the data you map to your destinations.
+
+> info "Trait Enrichment in beta"
+> Trait Enrichment is in beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. [Contact Segment](https://segment.com/help/contact/){:target="_blank"} with any feedback or questions.
+
+Trait Enrichment setup
+
+1. Confirm that **Send Track** is toggled on and select Customized Setup. Select **Add Trait**, select the traits you want to sync, and click **Save**.
+
+
+
+2. Update the **Identifier Data** Field in your destination **Audience Entered** Mapping (either SFTP or S3).
+- To update a trait field mapping, click on the **Select event variable** section and in the dropdown search for `properties`, followed by your trait. For example, `properties.firstName`. If no matches are found, use `properties.TRAIT` as an event variable.
+
+
+
+For best results with Trait Enrichment, Segment recommends the following:
+
+- Use Trait Enrichment with new audiences.
+- Use smaller audiences for real-time use cases, as data delivery is slower for large audiences.
diff --git a/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-EngageSettings.png b/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-EngageSettings.png
new file mode 100644
index 0000000000..e37b44e00a
Binary files /dev/null and b/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-EngageSettings.png differ
diff --git a/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-Mappings.png b/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-Mappings.png
new file mode 100644
index 0000000000..ff43b2605e
Binary files /dev/null and b/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-Mappings.png differ
diff --git a/src/connections/destinations/catalog/actions-logrocket/index.md b/src/connections/destinations/catalog/actions-logrocket/index.md
index a110f71939..38bdb07775 100644
--- a/src/connections/destinations/catalog/actions-logrocket/index.md
+++ b/src/connections/destinations/catalog/actions-logrocket/index.md
@@ -11,14 +11,12 @@ id: 635ada35ce269dbe305203ff
[LogRocket](https://www.logrocket.com/){:target="_blank"} combines session replay, error tracking, and product analytics – empowering software teams to create the ideal web and mobile
product experience. With the Segment integration, your Segment user telemetry and events will be sent to LogRocket for enhanced analytics and filtering.
-{% include content/ajs-upgrade.md %}
-
## Getting started
1. From the Segment web app, click **Catalog**, then click **Destinations**.
2. Find the **LogRocket** destination item in the left navigation, and click it.
3. Click **Configure LogRocket**.
4. Select an existing Source to connect to LogRocket.
-5. On the **Settings** tab, set your LogRocket [appID](https://app.logrocket.com/).
+5. On the **Settings** tab, set your LogRocket [appID](https://app.logrocket.com/){:target="_blank”}.
{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-loops/index.md b/src/connections/destinations/catalog/actions-loops/index.md
new file mode 100644
index 0000000000..95752b48e9
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-loops/index.md
@@ -0,0 +1,69 @@
+---
+title: Loops (Actions) Destination
+hide-boilerplate: true
+hide-dossier: true
+id: 63360a5fe290ca3fdfad4a68
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Loops](https://loops.so?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target:="_blank"} is a modern email platform for SaaS, a better way to send marketing and transactional email.
+
+You can use this Segment destination to create and update your Loops contacts and trigger email sending with events.
+
+Loops maintains this destination. For any issues with the destination, [contact their Support team](mailto:help@loops.so).
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Search for “Loops (Actions)” in the Destinations Catalog, and select the destination.
+3. Click **Configure Loops**.
+4. Select an existing Source to connect to Loops and click **Next**.
+5. On the Setup page, enter a name for your destination and click **Create destination**.
+6. Open Loops and generate an API key from [Settings > API](https://app.loops.so/settings?page=api){:target="_blank"}. Click "Generate key" then click the "Copy to clipboard" icon.
+7. Open the Segment app, go to the Settings page inside your Loops destination, and paste your API key. Then, click "Save Changes".
+
+## Create or update contacts
+
+You can create and update Loops contacts by using Segment's [Identify method](/docs/connections/spec/identify/), like this:
+
+```javascript
+analytics.identify("test-user-a5h7xb", {
+ email: "adam@loops.so",
+ firstName: "Adam",
+ favoriteColor: "blue",
+ favoriteNumber: 42
+});
+```
+
+If the email address or user ID do not exist in your contacts, a new contact will be created. If the email address or user ID already exists, the existing contact will be updated with the data sent in the Identify call.
+
+Go to the Mappings tab inside your Loops destination and click **New Mapping**. Select **Create or update a contact**.
+
+It is important that you set up the data mapping properly in step 3 of the "Create or update a contact" form. This is where you can select which data is sent on to Loops and into which fields. Loops provides an example default mapping in the form, but you should make sure that you set up the mapping to capture the correct data in the correct fields (you may have some [custom fields in Loops](https://loops.so/docs/add-users/properties){:target="_blank"} that the default mapping doesn't cover, for example).
+
+You can pass any custom fields that you're using in Loops inside "Custom Contact Attributes".
+
+Once you have completed the mapping you can send a test event. After you submit a test event, you can verify everything is set up correctly by looking for the contact on the [Audience](https://app.loops.so/audience){:target="_blank"} page in your Loops account.
+
+Loops has a full tutorial for creating and updating contacts [in the Loops docs](https://loops.so/docs/add-users/segment#create-or-update-contact){:target="_blank"}.
+
+## Sending events
+
+In Loops you can send emails [triggered by events](https://loops.so/docs/loop-builder/triggering-emails){:target="_blank"}. You can trigger these events from Segment by using the [Track method](/docs/connections/spec/track/), like this:
+
+```javascript
+analytics.track("User Registered");
+```
+
+When you make a Track call, Segment will pass this event data on to Loops, which can then send emails based on [email-sending triggers](https://loops.so/docs/loop-builder/loop-triggers){:target="_blank"} you've set up in your account.
+
+To set up event sending with Segment, go to the Mappings tab inside your Loops destination and click **New Mapping**. Select **Send Event**.
+
+In the next page, enter the name of the event you're tracking into the "Event Name" field (for example, "User Registered" from the example above). If you have not already created the contact in Loops, you need to include an email address in your mapping, as Loops requires a contact for each event.
+
+Now you are able to send a test event. You can verify that the event was triggered properly in your Loops account from the [Events](https://app.loops.so/settings?page=events){:target="_blank"} page.
+
+Read the tutorial for sending events [in the Loops docs](https://loops.so/docs/add-users/segment#send-event){:target="_blank"}.
+
+{% include components/actions-fields.html %}
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-magellan-ai/index.md b/src/connections/destinations/catalog/actions-magellan-ai/index.md
new file mode 100644
index 0000000000..f5fcfe7219
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-magellan-ai/index.md
@@ -0,0 +1,43 @@
+---
+title: Magellan AI (Actions) Destination
+id: 661eca176680eee35d82c955
+beta: true
+hidden: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Magellan AI](https://www.magellan.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is the all-in-one platform for audio advertising intelligence, media planning, and measurement.
+
+This destination is maintained by Magellan AI. For any issues with the destination, [contact their Measurement team](mailto:measurement@magellan.ai).
+
+## Getting started
+
+1. From your Segment workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Magellan AI".
+2. Select "Magellan AI" and click **Add Destination**.
+3. Select an existing Source to connect to Magellan AI (Actions), give your destination a name and click **Create destination**.
+4. Enter the campaign's **pixel token** in the destination settings in Segment. You can obtain this token either from the [Magellan AI pixel management dashboard](https://app.magellan.ai/navigator/measurement/pixels){:target="_blank"} or provided by your Magellan AI Measurement Success Manager.
+5. Configure which actions you want to send to Magellan AI.
+
+(Optional) If you need Magellan AI to process GDPR deletion requests:
+1. Contact your Magellan AI Measurement Success Manager to enable API access for your account.
+2. Go to the [Magellan AI API access token page](https://app.magellan.ai/api_access_tokens){:target="_blank"} and generate a new API token.
+3. Find and copy the new **API token**.
+4. Enter the **API token** in the destination settings for your Magellan AI (Actions) destination.
+
+{% include components/actions-fields.html %}
+
+## Limitations
+
+* Magellan AI only supports Segment's Replay feature for mobile events.
+
+### Lead
+
+Magellan AI's `Lead` action is semantically closest to Segment's [B2B SaaS `Signed Up` event](/docs/connections/spec/b2b-saas/#signed-up) and uses it as the default Trigger. However, Magellan AI's API spec considers `Lead` an e-commerce event, requiring a value and a currency. You may:
+* Configure your sources sending `Signed Up` events to include the additional e-commerce-style fields
+* Consider mapping an alternative event to the `Lead` action, like `Promotion Clicked` or `Product Added to Wishlist`, depending on your use case
+* Map `Signed Up` events to the `Lead` action, providing dummy values in the mapping like `0` for the value and `USD` for the currency
+
+### Install, Third-Party Event
+
+Magellan AI's API spec requires a user agent, but Segment's [Analytics-Swift](/docs/connections/sources/catalog/libraries/mobile/apple/) library does not provide user agent information in the event context. In order to use this action with Segment's Swift library, you can provide either a static user agent string or a placeholder value in the mapping.
diff --git a/src/connections/destinations/catalog/actions-marketo-static-lists/index.md b/src/connections/destinations/catalog/actions-marketo-static-lists/index.md
new file mode 100644
index 0000000000..688ae28f3e
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-marketo-static-lists/index.md
@@ -0,0 +1,99 @@
+---
+title: Marketo Static Lists (Actions) Destination
+hide-boilerplate: true
+strat: adobe
+id: 65302a514ce4a2f0f14cd426
+---
+> info "Marketo Static Lists vs Marketo Static Lists (Actions) Destinations"
+>
+> Marketo Static Lists (Actions) is a rebuild of the classic destination that provides the following benefits:
+>
+> - **Streamlined setup process** - Marketo Static Lists (Actions) has a streamlined default setup process, making it faster to get started in a way that "just works".
+> - **More control** - Actions-based destinations allow you to define the mapping between the data Segment receives from your sources, and the data Segment sends to Marketo.
+> - **Default property mappings** - Default mappings from the Segment like event, timestamp, and more allows data to be mapped correctly without any setup required.
+
+## Overview
+
+The Marketo Static Lists (Actions) destination lets you sync users into Marketo as a **List**, allowing you to run email campaigns in Marketo without having to manually find and upload a refreshed csv of users. This documentation explains how to set up Marketo in Segment, and what to expect in your Marketo UI.
+
+## Details
+
+- **Supports Engage**: Yes
+- **Supports RETL**: Yes
+- **Engage Destination type**: List
+- **Must create audience_name field before Engage can update those values?**: No. You don't need to create the _list_ in Marketo, however you do need to create the folder Segment will create the list in.
+- **Audience appears as**: A list in the folder you created, in the Marketo Lead Database under Group Lists.
+- **Destination rate limit**: 100 calls per 20 seconds, which is shared among all third-party API services
+- **Lookback window allowed**: Yes
+- **Client or Server-Side Connection**: Server-side
+
+{% include content/sync-frequency-note.md %}
+
+## Configuring Marketo Static Lists
+
+> success "Good to know:"
+> To set up Marketo, you need Marketo administrator access. If you don't have that access, work with the administrator for your organization.
+
+### Step 1: Create an API-Only Marketo user
+
+In this step, you'll create an API-Only Marketo user with both Access API and Lead Database access.
+
+1. You can use an existing role with these permissions, or create a new role that has both Access API and Access Lead Database permissions. (Do this in Marketo by going to **Admin**→ **Users & Roles** → **Roles**).
+2. Go to **Admin** → **Users & Roles** → **Users** → **Invite New User** and create a new **API Only user** with the role that has both Access API and Lead Database permissions. **Be sure to check the API Only box.**
+
+### Step 2: Create a Marketo Launchpoint Service
+
+1. Go to **Admin** → **Integration** → **LaunchPoint** → **New**
+2. Create a new service. In the Service field, select `Custom`, and in the **API Only User** field, select the user you created in step 1.
+3. Write down the **Client Id** and **Client Secret** for this service, as you will need it when configuring the destination settings.
+
+### Step 3: Create a Marketo Lead Database folder and get your Marketo Endpoint
+
+1. Go to your Marketo Lead Database, and create a new folder under Group Lists. After connecting, each Engage audience shows up as a list in this folder.
+
+2. Before you continue to the next step, in Marketo, go to **Admin → Web Services**, and copy or write down the REST API Endpoint. **Be sure to copy the REST endpoint and not the SOAP endpoint.** You'll need that in the next step.
+
+> warning "Warning:"
+> Do not create a list in the folder for the audience. Segment creates the list for you!
+
+### Using Marketo Static Lists (Actions) destination with Engage
+
+1. From your Segment workspace, go to **Engage → Engage Settings → Destinations → Add Destination**, and then Search for Marketo Static Lists (Actions).
+2. In the destination settings, enter the **Client Id**, **Client Secret**, **Endpoint**, and **Folder Name** from the LaunchPoint service and folder you created in Steps 2 and 3. For **Endpoint**, note the Endpoint from Step 3 above.
+3. Select the toggle to enable the Marketo Static Lists (Actions) destination.
+4. Navigate to the **Mappings** tab, click **Add Mapping**, and select **Add to List**.
+6. Click **Save**, and make sure to enable the mapping.
+7. On the **Mappings** tab, click **Add Mapping**, and select **Remove from List**.
+8. Click **Save**, and make sure you enable the mapping.
+9. Navigate to the Engage Audiences tab, and create a new audience.
+10. Give your audience a name, some event and trait criteria, then click **Preview**.
+11. Select **Marketo Static Lists** as a destination for the Audience.
+12. In the settings that appear in the side panel, toggle the **Send Track** option on, and don't change the **Audience Entered/Audience Exited** event names.
+13. Click **Save Settings**.
+
+### Using Marketo Static Lists (Actions) destination with RETL
+
+1. Navigate to your data warehouse, and add Marketo Static Lists (Actions) as a destination.
+2. From your model, click **Add Mapping**, and select your Marketo Marketo Static Lists (Actions) destination, and the **Add to List** Action.
+3. If you already have a list created in Marketo, fill in the List ID field. If you want Segment to create a list in Marketo, fill in the List name field.
+4. Finish setting up the rest of the action.
+5. Click **Save Mapping**.
+
+When you save the mapping, a list is created in Marketo. You can update the list the mapping syncs to at any time.
+
+> info ""
+> Only users with an email address appear in the list in Marketo. Users with multiple email addresses as external ids appear in the list once for each email address.
+
+You can view the audience in Marketo by going to **Lead Database→ Group Lists→Name of folder you created in Step 3 → Audience name**
+
+{% include components/actions-fields.html %}
+
+## Troubleshooting
+
+#### Not seeing an audience in Marketo?
+Check that you followed all of the set up steps. Wait six or more hours after setup for your audience to start appearing in Marketo. Check that you didn't create a list in the folder for the audience - Segment creates the list for you, and an existing one can conflict. Check that the audience members you expect have an email address on their profile.
+
+#### Audience size is smaller than expected
+Only users in the audience who also have an email address are uploaded to the list. You may need to adjust your query to filter out users without an email so you can get a better estimate of how many users will appear on the list. In the example below, we added an AND condition where users have a Custom trait of `email` which `exists`.
+
+If a user has multiple email addresses, each address appears once in the Marketo list.
diff --git a/src/connections/destinations/catalog/actions-mixpanel/index.md b/src/connections/destinations/catalog/actions-mixpanel/index.md
index f5b5aa24ea..790c7073ca 100644
--- a/src/connections/destinations/catalog/actions-mixpanel/index.md
+++ b/src/connections/destinations/catalog/actions-mixpanel/index.md
@@ -36,7 +36,7 @@ Mixpanel (Actions) provides the following benefits over the classic Mixpanel des
### Connection Modes for Mixpanel (Actions) destination
-The Mixpanel (Actions) destination does not offer a device-mode connection mode. If you're using one of Segment's new libraries ([Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](https://github.com/segmentio/analytics-swift) or [Kotlin](https://github.com/segmentio/analytics-kotlin)) with the Actions-framework version of the destination, you do not need the device-mode connection.
+The Mixpanel (Actions) destination does not offer a device-mode connection mode. If you're using one of Segment's new libraries ([Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](https://github.com/segmentio/analytics-swift){:target="_blank”} or [Kotlin](https://github.com/segmentio/analytics-kotlin){:target="_blank”}) with the Actions-framework version of the destination, you do not need the device-mode connection.
{% capture track_purchase_details %}
@@ -107,14 +107,16 @@ The group id that Mixpanel will use is `12345`.
{% capture identify_user_details %}
> success ""
-> The below special traits will be mapped to Mixpanel reserved properties automatically to fit Mixpanel's use cases. `traits.created` -> `$created`, `traits.email` -> `$email`, `traits.firstName` -> `$first_name`, `traits.lastName` -> `$last_name`, `traits.name` -> `$name`, `traits.username` -> `$username` and `traits.phone` -> `$phone`.
+> Segment maps the userId set in the identify event to the distinct ID in Mixpanel. Segment also maps the following traits to Mixpanel reserved properties to fit Mixpanel's use cases: `traits.created` -> `$created`, `traits.email` -> `$email`, `traits.firstName` -> `$first_name`, `traits.lastName` -> `$last_name`, `traits.name` -> `$name`, `traits.username` -> `$username` and `traits.phone` -> `$phone`.
{% endcapture %}
{% include components/actions-fields.html content1=track_purchase_details section1="trackPurchase" content2=group_identify_user_details section2="groupIdentifyUser" content3=identify_user_details section3="identifyUser" %}
-## Migration from Mixpanel Classic
-{% include content/ajs-upgrade.md %}
+> info "Anonymous ID format"
+> [Mixpanel](https://developer.mixpanel.com/reference/create-identity#create-identity){:target="_blank"} requires that values it receives for the anonymous identifier (`anonymousId` in Segment) must be in the UUID v4 format. Analytics.js sends `anonymousId` in this format by default. If you manually send anonymous identifiers to Mixpanel, ensure they are in the correct format.
+
+## Migration from Mixpanel Classic
Assuming you're already using Segment Cloud-mode, the Mixpanel (Actions) destination is expected to have no breaking changes when upgrading. With the exception of a few new properties added to your events in the new Actions destination, there should be no difference in the data received in Mixpanel when using either of the Mixpanel destinations.
@@ -123,4 +125,22 @@ If you want to confirm, you can configure the new destination to point to a diff
> info ""
> Contact Mixpanel support if you find features missing from the Mixpanel (Actions) destination that were available in the classic Mixpanel destination.
-{% include components/actions-map-table.html name="mixpanel" %}
\ No newline at end of file
+{% include components/actions-map-table.html name="mixpanel" %}
+
+## Troubleshooting
+
+### Track events are not attributed to Mixpanel Groups
+
+If the Mixpanel (Actions) destination uses $group_id as the group key, ensure that the mappings handling your `track` events have the field for **Group ID** mapped to a valid value. By default, this field maps to the event variable `context.groupId`.
+
+To send Track events with a custom Group Key, include the key as a property of Track events. For example:
+```js
+analytics.track('Example Event', { custom_group_key : 'group1' });
+```
+### Failed events due to timestamp
+
+If your integration is correct and you are still seeing failed events, review and verify that you are sending all date properties as UTC time format, due to Mixpanel timestamp format requirements.
+
+### Why is Boardman, Oregon appearing in my users' profile location field?
+
+If you are seeing traffic from Boardman or see Segment as the browser, you might be sending server side calls to your Mixpanel (Actions) destination. To correctly populate your users' profile location field, manually pass the IP information in the context object from the server.
diff --git a/src/connections/destinations/catalog/actions-moengage/index.md b/src/connections/destinations/catalog/actions-moengage/index.md
index 5a85e87e66..19b0dd1ae8 100644
--- a/src/connections/destinations/catalog/actions-moengage/index.md
+++ b/src/connections/destinations/catalog/actions-moengage/index.md
@@ -18,10 +18,6 @@ id: 620feaa207e70f6c6a765ff7
> info ""
> This page is about the [Actions-framework](/docs/connections/destinations/actions/) MoEngage Segment destination. There's also a page about the [non-Actions MoEngage Destination](/docs/connections/destinations/catalog/moengage/). Both of these destinations receives data from Segment.
-
-
-{% include content/ajs-upgrade.md %}
-
This destination is maintained by MoEngage. For any issues with the destination, [contact the MoEngage Support team](mailto:support@moengage.com).
@@ -52,7 +48,7 @@ MoEngage (Actions) provides the following benefits over the MoEngage Classic des
Name | The name of the Moengage destination such as MoEngage prod, MoEngage test. |
App Id | Navigate to Settings > API > General on your MoEngage dashboard to access the App ID. |
App Key | Navigate to Settings > API > General on your MoEngage dashboard to access the App Key. |
- Endpoint Region | This is your MoEngage data center. [Read more](https://help.moengage.com/hc/en-us/articles/360057030512-Data-Centers-in-MoEngage). |
+ Endpoint Region | This is your MoEngage data center. [Read more](https://help.moengage.com/hc/en-us/articles/360057030512-Data-Centers-in-MoEngage){:target="_blank”}. |
7. Enable the toggle option to **Enable** the destination and click **Save changes**.
@@ -83,8 +79,8 @@ If successful, the data starts flowing into your MoEngage account in 3-5 minutes
-## Migration from the classic MoEngage destination
+
+## Migration from the classic MoEngage destination
-{% include content/ajs-upgrade.md %}
+Include any pertinent information here. -->
diff --git a/src/connections/destinations/catalog/actions-moloco-rmp/index.md b/src/connections/destinations/catalog/actions-moloco-rmp/index.md
new file mode 100644
index 0000000000..19fda5d9a0
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-moloco-rmp/index.md
@@ -0,0 +1,143 @@
+---
+title: Moloco Commerce Media Destination
+id: 65f05e455b125cddd886b793
+beta: true
+---
+
+[Moloco Commerce Media](https://www.moloco.com/products/moloco-retail-media-platform){:target="_blank”} (MCM) is a technology solution that empowers marketplaces and online retailers to build and scale a retail media business (for example, sponsored ads). Moloco’s solution helps platforms leverage and activate their first-party data to deliver highly relevant and performant ads, automate ad decision-making, and scale their ads business.
+
+The Moloco Commerce Media destination can send user events collected using the Segment SDK to Moloco’s platform for a simplified performance ads integration.
+
+This allows you to run performance advertising without having to build your own backend system to ingest and send user events data in realtime to Moloco.
+
+## Getting started
+
+### Prerequisites
+Before you configure the Moloco Commerce Media destination, add a source to Segment and use the [Source Debugger](/docs/connections/sources/debugger/) to verify Segment is receiving events.
+
+Before you configure the Moloco Commerce Media destination, reach out to your Moloco representative about the following account information:
+- Moloco Platform ID
+- Moloco Event Service API key
+
+After you obtain that account information, you can move on to the Segment app.
+
+### Set up your Moloco destination
+1. From the Segment web console, click **Catalog**.
+2. On the Catalog page, search for “Moloco”, select it, and click **Add destination**.
+3. Choose which of your sources to connect the destination to.
+4. In the Moloco MCM destination settings page, fill the Platform ID and API key fields with your Moloco Platform ID and Event Service API key.
+5. Select “APP" if your source endpoint is a mobile app, and "SITE" if it is a website.
+
+## Identify
+
+Moloco strongly recommends that you identify your logged-in users using Segment's [Identify method](/docs/connections/spec/identify/) and that you hash the user ID before sending it to Moloco.
+
+Please find an example Identify call below:
+
+```js
+analytics.identify('361b1fdfbeaa9d64a13c033eb9f970dc6740f6bc', {
+ email: 'john.doe@example.com'
+});
+```
+
+Once a user is identified, each call to Segment's [Track method](/docs/connections/spec/track/) automatically records the user ID.
+Users that are not logged in can be tracked using an [anonymousID](/docs/connections/spec/identify/#anonymous-id). Moloco Commerce Media does not use anonymousIDs for users that are not logged in. Segment recommends formatting your anonymousID in UUID format.
+
+> info" "
+> If you hash the user ID before sending it to Moloco, ensure you reuse the same hashed ID when calling other Moloco APIs.
+
+
+## Track
+
+If you’re not familiar with the Segment Spec, take a look to understand what the [Track method](/docs/connections/spec/track/) does. The mappings in the Moloco Commerce Media destination are built based on the Segment [Ecommerce Spec](/docs/connections/spec/ecommerce/v2/).
+
+Please find below an example call to track a product detail page (PDP) view event:
+
+```js
+analytics.track("Product Viewed", {
+ product_id: "1193",
+ name: "Newage Uplift Eye Care Cream",
+ price: 19.99
+ currency: "USD"
+ quantity: 1,
+ image_url: "https://www.example.com/image.png"
+});
+```
+
+## Page
+
+If you’re not familiar with the Segment Spec, take a look to understand what the [Page method](/docs/connections/spec/page/) does.
+
+Please find below an example call to page:
+
+```js
+analytics.page();
+```
+
+If you use Segment’s Web SDK, this call automatically collects the page information. Here’s an example of page information automatically collected using Segment’s Web SDK.
+
+```js
+ "page": {
+ "path": "/account",
+ "referrer": "",
+ "search": "",
+ "title": "Your Account",
+ "url": "https://www.example.com/account"
+ },
+```
+
+However for iOS and Android, it won’t collect page information.
+
+Moloco Commercial Media requires the [page_id](https://mcm-docs.moloco.com/docs/51-user-event-data-specifications#page_view-event-type){:target="_blank”} attribute for a PAGE_VIEW event. Using the Web SDK, the page_id can be associated with the path attribute. However for iOS/Android, Moloco Commercial Media recommends using the Page Identifier Token field.
+
+The Page Identifier Token field accepts key:value pairs of strings that can identify the page.
+Stringification Logic is: {key}:{value}s concatenated by ";"
+
+Moloco Commercial Media ignores the Page Identifier Token if page_id is passed, as page_id has a higher priority.
+
+Here’s an example of a Page Identifier Token that could be tracked in a mobile app.
+
+Say the input had the following schema:
+
+```js
+ ...
+ "event": "Product List Viewed",
+ "vertical": "fruit"
+ ...
+```
+
+and user chose the following mapping:
+
+```js
+ // "event" represents the name of the event
+ event: properties.event
+ // "vertical" represents which vertical the event happened on
+ vertical: properties.vertical
+
+ // The combination of those two tokens can repsent
+ // "Which action happened on which vertical"
+```
+
+The tokens are stringified into the following:
+
+```js
+ "event:Product List Viewed;vertical:fruit"
+```
+
+The tokens are stringified in the format of the above example because they are key-value pairs concatenated by a semicolon (;).
+
+> info " "
+> if you decide to use the Page Identifier Token in your mobile app, reuse the same Page Identifier Token in place of page_id when calling Moloco’s APIs.
+
+## Mappings
+
+In the Mappings tab, some fields are chosen by default if some common fields map to Moloco Event’s fields. If the mapped key does not exist in the input data, it won’t trigger an error. Instead, the mapping will not pass any value.
+
+If you are using **the default fields in a custom way**, please confirm that your mapping meets Moloco's requirements.
+
+Default Mappings are not hard rules. They can be modified to your convenience.
+
+{% include components/actions-fields.html %}
+## Monitoring
+
+Once the mappings are configured correctly, you can verify the flow of events from your source to Moloco’s destination in the [Delivery Overview](/docs/connections/delivery-overview/) tab of your Moloco destination. If you correctly configured your destination, you should see a growing **Successful delivery** count.
diff --git a/src/connections/destinations/catalog/actions-movable-ink/index.md b/src/connections/destinations/catalog/actions-movable-ink/index.md
new file mode 100644
index 0000000000..572052cdc7
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-movable-ink/index.md
@@ -0,0 +1,56 @@
+---
+title: Movable Ink (Actions) Destination
+id: 6537b55db9e94b2e110c9cf9
+beta: true
+---
+
+[Movable Ink](https://movableink.com/){:target="_blank"} lets email marketers deliver jaw-dropping customer experiences. Movable Ink's cloud-based software activates any data to generate intelligent content at the moment of open.
+
+This destination enables you to send Segment event data which can be used to automatically generate personalized content at scale across email and mobile experiences.
+
+> info ""
+> This destination is maintained by Movable Ink. For any issues with the destination, please reach out to your Movable Ink Client Experience team.
+
+## Pre-Requisites
+
+A Movable Ink Stories license is required to use this integration. Please reach out to your Movable Ink client experience team with any questions.
+
+You'll need to share sample event payloads with your Movable Ink Client Experience team before enabling the destination in Segment. Your Client Experience team will then work with a Solutions Architect to map the event within Movable Ink and share an endpoint URL, access key ID, and access secret. This event mapping in Movable Ink and API credentials are required for a successful response.
+
+### Find sample event payloads in Segment:
+
+To find sample event payloads in Segment:
+
+1. Navigate to **Connections > Sources** and click on the source you’d like to stream data from.
+2. Select the **Debugger** tab. You'll see a list of incoming sample events.
+3. Select the event you’re interested in, then select **Raw** to view a full sample payload.
+4. Copy and paste this sample payload and share with your client experience team.
+
+Your client experience manager will then provide you with a Movable Ink endpoint URL, access Key ID, and access secret.
+
+## Getting started
+
+1. From the Segment web app, navigate to **Connections > Catalog**, then select **Destinations**.
+2. Search for "Movable Ink (Actions)" and select it.
+3. Click **Add Destination**.
+4. Within the **Settings** tab of your destination, input your Movable Ink API credentials into the following fields:
+- **Username**: paste your Movable Ink Access Key ID
+- **Access Secret**: paste your Movable Ink Access Secret
+- **Movable Ink URL**: paste your Movable Ink Endpoint URL
+
+## Select events and event properties to stream to Movable Ink
+
+"Send Entire Event" is the only action available with this destination. To configure this action:
+1. Navigate to the **Mappings** section of your destination.
+2. Select **Edit Mapping** and tailor the events you wish to send by adding or removing conditions that trigger this action.
+3. Preview the data:
+- Load a test event from the source or use a sample event for data preview.
+4. Map specific fields (optional):
+- Click **Test Mapping** to send a test event and identify any potential issues.
+- Return to the Mappings overview page and enable your mapping.
+6. Navigate to your integration’s **Settings** tab and activate the integration by toggling on **Enable Destination**.
+
+> info ""
+> For any unexpected errors, contact your Movable Ink client experience team with the full sample payload.
+
+{% include components/actions-fields.html %}
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-optimizely-advanced-audience-targeting/index.md b/src/connections/destinations/catalog/actions-optimizely-advanced-audience-targeting/index.md
new file mode 100644
index 0000000000..d6514f037d
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-optimizely-advanced-audience-targeting/index.md
@@ -0,0 +1,43 @@
+---
+title: Optimizely Advanced Audience Targeting Destination
+id: 64edeb2bee24614fe52ede34
+beta: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Optimizely Advanced Audience Targeting](https://optimizely.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target=”blank”} allows you to sync your Segment Engage audiences to Optimizely for targeting with Web Experimentation audiences, Feature Experimentation audiences, and CMS Visitor Groups.
+
+This destination is maintained by Optimizely. For any issues with the destination, [contact the Optimizely Support team](mailto:support@optimizely.com).
+
+## Getting started
+
+**Within your Optimizely Data Platform Account**
+
+1. Navigate to the **App Directory**.
+2. Use autocomplete to find the **Twilio Segment** app.
+3. Click into the app and click **INSTALL**.
+4. Click **SETTINGS > GENERATE** and copy the resulting token to your clipboard.
+
+**Within your Twilio Segment Account**
+
+1. From the Segment web app, navigate to **Connections > Catalog** and select the **Destinations** tab of the catalog.
+2. Select the Destinations Actions tab and search for **Optimizely Advanced Audience Targeting**.
+3. Select the **Configure Optimizely Advanced Audience Targeting** tile.
+4. Select your **Engage Space** as a source. Note that this destination only works when an Engage Space is configured as a Source.
+5. Click **Confirm Source**.
+6. Within the **Settings** tab paste your ODP token into the **API Key** field, select your region, enable the integration and click **Save Changes**.
+7. Click into the **Mappings** section, then click **New Mapping**, then click on the **Sync Audience** tile.
+8. In section 3 **Select Mappings** ensure the user identifier you are targeting with your Advanced Audience Targeting integration is mapped to the Optimizely User ID field.
+9. Click **Save**.
+10. Enable the Action by toggling the Status to **Enabled**.
+11. Click back to the **Settings** tab and enable the destination by toggling the **Enable Destination** toggle to *On*.
+12. Click **Save changes**.
+
+{% include components/actions-fields.html %}
+
+## Notes
+
+- Ensure the Advanced Audience Targeting integration is configured in your Optimizely Products so that you can access your connected audiences from Segment Engage.
+
+- If connecting your Segment Engage audiences to **Optimizely Web Experimentation** ensure the user id mapped to the Optimizely User ID in the Destination mappings area is an identifier available on the browser (client side). This allows Optimizely web to properly check audience membership for visitors included in connected Segment Engage audiences.
diff --git a/src/connections/destinations/catalog/actions-optimizely-feature-experimentation-cloud/index.md b/src/connections/destinations/catalog/actions-optimizely-feature-experimentation-cloud/index.md
new file mode 100644
index 0000000000..01ffec24f3
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-optimizely-feature-experimentation-cloud/index.md
@@ -0,0 +1,61 @@
+---
+title: 'Optimizely Feature Experimentation (Actions) Destination'
+id: 641d5acea88fa531b9068608
+hide-personas-partial: true
+hide-boilerplate: false
+hide-dossier: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Optimizely Feature Experimentation](https://www.optimizely.com/products/experiment/feature-experimentation/){:target="_blank"} is a feature flagging and experimentation platform for websites, mobile apps, chatbots, APIs, smart devices and anything else with a network connection.
+
+With the Optimizely SDK you can deploy code behind feature flags, experiment with A/B tests and use percentage deliveries to roll out or roll back flags immediately.
+
+Segment’s Optimizely Feature Experimentation (Actions) destination supports tracking of conversion events.
+Segment supports one action (event): trackEvent. [TrackEvent](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/track-event-javascript-node){:target="_blank"} sends user conversion events for active experiments. Segment sends data using Optimizely's [Event API](https://docs.developers.optimizely.com/experimentation-data/reference/post_events){:target="_blank"}.
+
+## Prerequisites
+
+Optimizely works differently than other Segment destinations: it requires that customers implement some Optimizely functionality native to make sure your experiment logic runs correctly.
+
+Segment maps `track` events to Optimizely's `track` method. You must implement all Optimizely decision-based methods, such as `activate` and `isFeatureEnabled`. Segment sends data using Optimizely's [Event API](https://docs.developers.optimizely.com/experimentation-data/reference/post_events){:target="_blank"}.
+Segment's API does not include methods that correspond to decision-based methods.
+
+This requires that customers include a native Optimizely implementation before their Segment implementation on pages or in mobile apps where Optimizely experiments run.
+
+## Getting started
+
+Before connecting to the Optimizely Feature Experimentation destination, you must have a [Optimizely Feature Experimentation](https://www.optimizely.com/products/experiment/feature-experimentation/){:target="_blank"} account, Account ID and Datafile URL.
+
+To connect the Optimizely Feature Experimentation destination:
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Search for **Optimizely Feature Experimentation** in the Destinations Catalog, and select the destination.
+3. Click **Configure Optimizely Feature Experimentation (Actions)** in the top-right corner of the screen.
+4. Select the source that will send data to Optimizely Feature Experimentation and follow the steps to name your destination.
+5. On the **Settings** tab, input your `datafile` URL and your Account Id. Toggle “Enable Destination” on and click **Save Changes**.
+6. Navigate to the **Mappings** tab, click **New Mapping**, and select **Track Event**.
+7. Under Select mappings, select the event key from the dropdown or input the event manually as the "event" and select the other mappings. Click **Save** and toggle to enable the mapping.
+ * **Note:** The conversion event will only be sent if the configured event key exactly matches the name of an active experiment metric set up in the Optimizely dashboard.
+ * **Note:** The current user should activate a running experiment with the associated metric before sending track events to Segment.
+
+### Track
+
+Upon invocation of a Segment `track` event, Segment maps the event to an Optimizely `track` event:
+* If the Segment event name matches exactly the name of an active experiment `metric` set up in the Optimizely dashboard;
+* If the experiment `metric` is associated with a running experiment;
+* If the current user has been assigned a `userId` using Segment's `identify` method (for example, `analytics.identify('123')`);
+* If the current user is activated in a running experiment with the associated `metric`.
+
+Segment also handles the following mapping:
+* Segment maps `track` events to Optimizely `eventName`.
+* Segment maps `track` event, `properties`, to Optimizely `eventTags`.
+* Segment maps `track` event, `context.traits`, to Optimizely `attributes`.
+
+`revenue` values should be passed as a Segment `property`. The value should be an integer and represent the value in cents, so, for example, $1 should be represented by `100`.
+
+## GDPR Support
+Segment supports deleting/suppressing users in Optimizely Feature Experimentation (Actions) using the [Segment app](/docs/privacy/user-deletion-and-suppression/). Before deleting/suppressing a user, create a [Personal Access Token](https://developers.optimizely.com/x/authentication/personal-token/){:target="_blank”} in Optimizely and provide it as the value of the Personal Access Token setting.
+
+{% include components/actions-fields.html settings="true"%}
diff --git a/src/connections/destinations/catalog/actions-outfunnel/index.md b/src/connections/destinations/catalog/actions-outfunnel/index.md
index 91d0546e9c..0198a5f3b8 100644
--- a/src/connections/destinations/catalog/actions-outfunnel/index.md
+++ b/src/connections/destinations/catalog/actions-outfunnel/index.md
@@ -3,21 +3,19 @@ title: Outfunnel Destination
hide-boilerplate: true
hide-dossier: true
id: 63ff8bae963d5cb4fc79f097
-private: false
-hidden: false
+private: true
+hidden: true
---
{% include content/plan-grid.md name="actions" %}
-[Outfunnel](https://outfunnel.com/product-led-sales-platform/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a product-led sales platform that syncs product usage insights to CRMs like Pipedrive so your salespeople can easily find product-qualified leads and close more revenue.
+[Outfunnel](https://outfunnel.com/product-led-sales-platform/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a product-led sales platform that syncs product usage insights to CRMs like Pipedrive so your salespeople can easily find product-qualified leads and close more revenue.
This destination is maintained by Outfunnel. For any issues with the destination, [contact their Support team](mailto:support@outfunnel.com).
Outfunnel’s Segment integration is an [Actions-based Destination in cloud mode](/docs/connections/destinations/#connection-modes)
that lets you send your frontend and backend events directly to Outfunnel.
-{% include content/ajs-upgrade.md %}
-
{% include content/beta-note.md %}
## Benefits of Outfunnel
diff --git a/src/connections/destinations/catalog/actions-pendo-web/index.md b/src/connections/destinations/catalog/actions-pendo-web/index.md
new file mode 100644
index 0000000000..4ae5fd21e8
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-pendo-web/index.md
@@ -0,0 +1,41 @@
+---
+title: Pendo Web (Actions) Destination
+id: 6501a4325a8a629197cdd691
+beta: true
+hide-boilerplate: true
+hide-dossier: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+
+[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.
+
+Pendo maintains this destination. For issues with the Pendo Web (Actions) destination, please reach out to [Pendo's support team](https://support.pendo.io/hc/en-us/articles/360034163971-Get-help-with-Pendo-from-Technical-Support){:target="_blank"}.
+
+> success ""
+> **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.
+
+## Benefits of Pendo Web (Actions) vs Pendo Classic
+
+Pendo Web (Actions) provides the following benefits over the classic Pendo destination:
+
+- **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.
+- **Full region support**. Setup allows the destination to be configured for US, EU, US restricted, or Japan.
+- **Supports CNAME for Pendo**. Works with subscriptions using Pendo's custom CNAME feature.
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Find the Destinations Actions item in the left navigation, and click it.
+3. Click **Pendo Web (Actions)**.
+4. Click **Add destination ->**.
+5. Select an existing Source to connect to Pendo Web (Actions).
+6. In the destination settings, enter your Pendo API Key, which a Pendo Admin can find in the Pendo UI by going to **Settings** > [Subscription Settings](https://app.pendo.io/admin){:target="_blank"} > **Applications**, opening the relevant app, then locating the **API Key** value.
+7. Select the correct region for your Pendo subscription.
+
+{% include components/actions-fields.html %}
+
+## Migration from the classic Pendo destination
+
+Remove the classic Pendo destination and Webhook destination from your Segment workspace before adding the Pendo Web (Actions) destination.
diff --git a/src/connections/destinations/catalog/actions-pinterest-conversions-api/index.md b/src/connections/destinations/catalog/actions-pinterest-conversions-api/index.md
new file mode 100644
index 0000000000..c1f4d90a65
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-pinterest-conversions-api/index.md
@@ -0,0 +1,160 @@
+---
+title: Pinterest Conversions API
+id: 63e42e512566ad7c7ca6ba9b
+hide-personas-partial: true
+hide-boilerplate: false
+hide-dossier: true
+private: false
+hidden: false
+
+---
+The Pinterest Conversions API destination is a server-to-server integration with [The Pinterest API for Conversions](https://help.pinterest.com/en/business/article/the-pinterest-api-for-conversions){:target="_blank"} that allows advertisers to send conversions directly to Pinterest without requiring a Pinterest Tag. These conversions map to Pinterest campaigns for conversion reporting to improve conversion visibility. When you pass events to Pinterest, advertisers can use Pinterest's insights to evaluate an ad's effectiveness to improve content, targeting, and placement of future ads.
+
+Advertisers can send web, in-app, or offline conversions to Pinterest’s server to server endpoint in real-time. Events received in real time or within an hour of the event occurring are reported as web or app events. Events received outside of this window, as well as delayed batch events are considered as offline events.
+
+The API for Conversions helps Pinterest provide a more comprehensive view of your campaign performance. All advertisers who currently use the Pinterest Tag will benefit from using it in tandem with the API for Conversions.
+
+## Benefits of Pinterest Conversions API (Actions)
+
+The Pinterest Conversions API destination provides the following benefits:
+
+- **Fewer settings**. Data mapping for actions-based destinations happens during configuration, which eliminates the need for most settings.
+- **Clearer mapping of data**. Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to the Pinterest Conversions API.
+- **Prebuilt mappings**. Mappings for standard Pinterest Conversions API events, like `Add to Cart`, are prebuilt with the prescribed parameters and available for customization.
+- **Support Deduplication**. Deduplication removes duplicates events which improves the accuracy of your conversions
+- **Support for page calls**. Page calls can be sent to Pinterest as a standard Page View.
+- **Support for multi-user arrays**. User data nested within arrays, like the `User Data` array in the Order Completed event, can be sent to Pinterest.
+- **Data normalization**. Data is normalized before it's hashed to send to Pinterest Conversions.
+
+## Getting started
+
+Before connecting to the Pinterest Conversions destination, you must have a [Pinterest](https://ads.pinterest.com/login/){:target="_blank"} account and an Ad Account ID.
+
+To connect the Pinterest Conversions API Destination:
+
+1. From the Segment web app, navigate to **Connections > Catalog**.
+2. Search for **Pinterest Conversions API** in the Destinations Catalog, and select the destination.
+3. Click **Configure Pinterest Conversions API**.
+4. Select the source that will send data to Pinterest Conversions API and follow the steps to name your destination.
+5. On the **Basic Settings** page, configure the following fields:
+ - Destination Name
+ - [Ad Account ID](https://developers.pinterest.com/docs/conversions/conversions/#Find%20your%20%2Cad_account_id#Find%20your%20%2Cad_account_id#Find%20your%20%2Cad_account_id){:target="_blank”}
+ - [Conversions Token](https://developers.pinterest.com/docs/conversions/conversions/#Get%20the%20conversion%20token){:target="_blank”}
+6. Navigate to the **Mappings** tab, there are already Prebuilt mapping like `Checkout,Search,Add to Cart` defined with prescribed parameter . All required ,recommended and optional fields are listed [here](https://developers.pinterest.com/docs/conversions/best/#Authenticating%20for%20the%20Conversion%20Tracking%20endpoint#The%20%2Cuser_data%2C%20and%20%2Ccustom_data%2C%20objects#Required%2C%20recommended%2C%20and%20optional%20fields#Required%2C%20recommended%2C%20and%20optional%20fields){:target="_blank”}
+7. If you want to create **New Mapping**, and select **Report Conversions Event** ,configure and enable it.
+8. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
+9. Enable the destination using the **Enable Destination** toggle switch and click **Save Changes**.
+
+
+{% include components/actions-fields.html settings="true"%}
+
+> warning ""
+> By default, all mappings send as `web` conversions. If you want to send events as mobile or offline conversions, update the Action Source in each mapping to be `app_android`, `app_ios`, `offline`.
+
+## FAQ & Troubleshooting
+
+### Deduplication with Pinterest Tag
+
+Pinterest cannot know if a conversion reported by the Tag and another reported by the API for Conversions are the same.
+
+Because Pinterest recommends using both the API for Conversions and the Pinterest Tag, deduplication is an essential part of the implementation process. It helps to avoid double-counting of a single event when it’s sent through multiple sources, such as the Pinterest Tag and the Pinterest API for Conversions.
+
+For example, if a user triggers an add to cart event and the tag reports the data using `123` as the event ID. Later, their web server reports the conversion to the API and uses `123` as the event ID. When Pinterest receives the events, Segment looks at the event IDs to confirm they correspond to the same event.
+
+By using deduplication advertisers can report conversions using both the tag and the API without having to worry about over-counting conversions. This will result in more conversions being attributed than either alone, because if the tag doesn’t match an event, but the API does (or vice versa), the event can still be linked.
+
+Advertisers should use deduplication for any events they expect to be reported by multiple sources across the API and the Pinterest Tag.
+
+Conversion Events must meet the following requirements to be considered for deduplication:
+
+1. The event has non-empty and non-null values for `event_id` and `event_name`
+2. The `action_source` of the event is not `offline` (for example, events that occurred in the physical world, like in a local store) The `action_source` parameter is an enum that gives the source of the event – `app_android`, `app_ios`, `web`, or `offline`.
+3. The duplicate events arrived within 24 hours of the time of receipt of the first unique event.
+
+> info ""
+> Segment offers a client-side destination specifically designed for the Pinterest Tag. You can find detailed documentation and further information on how to implement this integration by following this [link](https://segment.com/catalog/integrations/pinterest-tag/){:target="_blank”}.
+
+### Events fail to send due to no App Name set
+
+App Name is a mandatory field for many of the Pinterest Conversion API destination's mappings. Segment's mobile libraries automatically collect and map the App Name to the correct field. However, Segment's web or server-based libraries do not automatically collect this field, which can cause mappings to fail. Segment recommends adding the App Name to the Segment event, or hardcoding a static string in the mapping as the App Name.
+
+## Limited Data Processing
+Starting from Jan 1, 2023, Pinterest introduced the Limited Data Processing flag as per California Consumer Privacy Act (CCPA). With this flag set Pinterest will allow advertisers to comply with CCPA.
+
+Advertisers are responsible for complying with user opt-outs, as well as identifying the user’s state of residency when implementing the Limited Data Processing flag.
+
+Keep in mind that the Limited Data Processing flag could impact campaign performance and targeting use cases. Pinterest recommends using the Limited Data Processing flag on a per-user basis for best results.
+
+LDP relies on 3 fields and is enabled only when all 3 combinations are met, if one of them is not met then LDP is disabled / ignored.
+
+| Field Name | Field Description | Required Value for LDP |
+| -------------- | ----------------------------------------------- | ---------------------- |
+| `opt_out_type` | Opt Out Type based on User’s privacy preference | "LDP" |
+| `st` | State of Residence | "CA" |
+| `country` | Country of Residence | "US" |
+
+
+
+### PII Hashing
+
+Segment creates a SHA-256 hash of the following fields before sending to Pinterest:
+- External ID
+- Mobile Ad Identifier
+- Email
+- Phone
+- Gender
+- Date of Birth
+- Last Name
+- First Name
+- City
+- State
+- Zip Code
+- Country
+
+### User Data Parameters
+
+Segment automatically maps User Data fields to their corresponding parameters [as expected by the Conversions API](https://developers.pinterest.com/docs/conversions/best/#Authenticating%20for%20the%20Conversion%20Tracking%20endpoint#The%20%2Cuser_data%2C%20and%20%2Ccustom_data%2C%20objects#Required%2C%20recommended%2C%20and%20optional%20fields#Required%2C%20recommended%2C%20and%20optional%20fields#User_data%2C%20and%20%2Ccustom_data%2C%20objects){:target="_blank"} before sending to Pinterest Conversions:
+
+| User Data Field | Conversions API User Data Parameter |
+| ----------------- | ----------------------------------- |
+| External ID | `external_id` |
+| Mobile Ad Id | `hashed_maids` |
+| Client IP Address | `client_ip_address` |
+| Client User Agent | `client_user_agent` |
+| Email | `em` |
+| Phone | `ph` |
+| Gender | `ge` |
+| Date of Birth | `db` |
+| Last Name | `ln` |
+| First Name | `fn` |
+| City | `ct` |
+| State | `st` |
+| Zip Code | `zp` |
+| Country | `country` |
+
+### Custom Data Parameters
+
+Segment automatically maps Custom Data fields (excluding `content_ids`, `contents`, `num_items`, `opt_out_type`) to their corresponding parameters [as expected by the Conversions API](https://developers.pinterest.com/docs/conversions/best/#Authenticating%20for%20the%20Conversion%20Tracking%20endpoint#The%20%2Cuser_data%2C%20and%20%2Ccustom_data%2C%20objects#Required%2C%20recommended%2C%20and%20optional%20fields#Required%2C%20recommended%2C%20and%20optional%20fields#User_data%2C%20and%20%2Ccustom_data%2C%20objects){:target="_blank"} before sending to Pinterest Conversions:
+
+| User Data Field | Conversions API Custom Data Parameter |
+| --------------- | ------------------------------------- |
+| Currency | `currency` |
+| Value | `value` |
+| Content IDs | `content_ids` |
+| Contents | `contents` |
+| Number of Items | `num_items` |
+| Order ID | `order_id` |
+| Search String | `search_string` |
+| Opt Out Type | `opt_out_type` |
+
+### Server Event Parameter Requirements
+
+Pinterest requires the `action_source` server event parameter for all events sent to the Pinterest Conversions API. This parameter specifies where the conversions occur.
+
+### Verify Events in Pinterest Conversions Dashboard
+
+After you start sending events, you should start seeing them in dashboard. You can confirm that Pinterest received them:
+
+1. Go to the Events Overview.
+2. Click on the Event History to see all the events sent to Pinterest conversions.
+
diff --git a/src/connections/destinations/catalog/actions-pipedrive/images/deal_match_fields.png b/src/connections/destinations/catalog/actions-pipedrive/images/deal_match_fields.png
new file mode 100644
index 0000000000..b586a4330c
Binary files /dev/null and b/src/connections/destinations/catalog/actions-pipedrive/images/deal_match_fields.png differ
diff --git a/src/connections/destinations/catalog/actions-pipedrive/images/email_match_field.png b/src/connections/destinations/catalog/actions-pipedrive/images/email_match_field.png
new file mode 100644
index 0000000000..5cd19d5173
Binary files /dev/null and b/src/connections/destinations/catalog/actions-pipedrive/images/email_match_field.png differ
diff --git a/src/connections/destinations/catalog/actions-pipedrive/images/match_field.png b/src/connections/destinations/catalog/actions-pipedrive/images/match_field.png
new file mode 100644
index 0000000000..dc6a9d22f3
Binary files /dev/null and b/src/connections/destinations/catalog/actions-pipedrive/images/match_field.png differ
diff --git a/src/connections/destinations/catalog/actions-pipedrive/index.md b/src/connections/destinations/catalog/actions-pipedrive/index.md
index 86e0033931..851366e810 100644
--- a/src/connections/destinations/catalog/actions-pipedrive/index.md
+++ b/src/connections/destinations/catalog/actions-pipedrive/index.md
@@ -3,15 +3,11 @@ title: Actions Pipedrive
hide-boilerplate: true
hide-dossier: true
id: 5f7dd8191ad74f868ab1fc48
-private: true
-hidden: true
---
{% include content/plan-grid.md name="actions" %}
-The Actions Pipedrive destination is an integration that allows customers to share events from Segment directly to Pipedrive. When you use Pipedrive with Segment, you don’t need to manually export and upload data to Pipedrive. Your customer data will remain up to date in real time and across all enabled integrations. Every tool you use to interact with leads and customers will land in Pipedrive, so you can always have a clear picture in front of you.
-
-{% include content/ajs-upgrade.md %}
+The Actions Pipedrive destination allows customers to share Segment event data with Pipedrive. Segment events sent to Pipedrive will either create new Entities or update existing Entities in Pipedrive.
## Benefits of Actions Pipedrive
@@ -22,21 +18,34 @@ Actions Pipedrive provides the following benefits:
## Getting started
-1. From the Segment web app, click **Catalog**, then click **Destinations**.
-2. Find the Destinations Actions item in the left navigation, and click it.
-3. Click **Configure "Actions Pipedrive"**.
-4. Select an existing Source to connect to "Actions Pipedrive".
-5. When adding Pipedrive as a destination, you will be redirected to the basic settings page, where you need to enter the destination name as well as Pipedrive's domain and API token.
-6. To complete the installation process, switch to advanced settings and enter your Pipedrive IDs.
+1. Sign in to your Segment Workspace
+2. Click to the **Catalog** tab.
+3. Click on the **Destinations** tab.
+2. Use the search field to find the 'Pipedrive' destination. Click on the **Actions Pipedrive** tile.
+3. Click **Add Destination**.
+4. Select a source to connect to and click the **Next** button.
+5. Provide a name for your Pipedrive destination and click the **Create Destination** button.
+6. On the Settings tab, provide values in the **Domain** and **API Token** settings fields, then click the **Save Changes** button.
+7. Navigate to the **Mappings** tab to configure how Segment events will be mapped to Pipedrive Entities. By default, mappings to upsert to Pipedrive's Person, Organization and Activity Entities will already be enabled. You can configure new Mappings by clicking on the **New Mapping** button.
+8. After you've configured and enabled your Mappings, click back to the **Settings** tab and enable the integration using the **Enable Destination** toggle. Segment should now start sending event data to Pipedrive.
-To set up the Segment integration with your Pipedrive account:
-1. Go to either your Marketplace menu within your settings or directly to Pipedrive's Marketplace.
-2. Search for *Segment* and click on **Install now**.
-3. A new window will pop up and prompt you to allow Segment to connect with Pipedrive.
-4. Choose the Pipedrive account you wish to connect to, then, click **Allow and Install**.
+## Inserting new Entities compared to updating existing Entities
-Once the installation is successful, you'll be redirected to Segment to authenticate your account.
+Segment uses the **Match value** field value as a key when creating or updating an Entity in Pipedrive. By default, the **Match value** will be mapped to the **id** field for the corresponding Entity. You can specify which Pipedrive field to use as a key using the **Match field** field.
-{% include components/actions-fields.html %}
+**Match field** fields are dynamic and will populate with data from your Pipedrive account.
+
+
+In the following example, Segment is configured to create or update Person Entities using the email field.
+
+
+## Associating Entities with other Entities
+Entities such as the **Deal** Entity can be configured to be associated with other Entities in Pipedrive. In the example with the **Deal** mapping below the following will happen:
+1. A **Person** Entity with an email address matching **properties.email** will be associated with the **Deal** Entity being created or updated.
+2. An **Organization** Entity with an ID matching **properties.org_id** will be assocated with the **Deal** Entity being created or updated.
+
+
+
+{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-podscribe/index.md b/src/connections/destinations/catalog/actions-podscribe/index.md
new file mode 100644
index 0000000000..48e2309f5e
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-podscribe/index.md
@@ -0,0 +1,95 @@
+---
+title: Podscribe (Actions) Destination
+id: 643fdecd5675b7a6780d0d67
+---
+
+[Podscribe](https://podscribe.com/){:target="\_blank”} measures the effectiveness of podcast advertising. Through integrations with podcast hosting providers, matches downloads with on-site actions, providing advertisers household-level attribution.
+
+{% include content/beta-note.md %}
+
+## Getting started
+
+1. From the Segment web app, navigate to **Connections > Catalog**.
+2. Search for "Podscribe", select it, and choose which of your sources to connect the destination to.
+
+Once you start sending data to the Podscribe's Destination it will take up to 20 minutes to appear in the Podscribe postbacks page.
+
+{% include components/actions-fields.html %}
+
+## Page
+
+If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like:
+
+```js
+analytics.page();
+```
+
+Page calls will be sent to Podscribe as a View event.
+
+Podscribe is an attribution platform, and as such, Podscribe needs more context about the visitor than just a User ID. Analytics.js [automatically collects context fields](/docs/connections/spec/common/#context-fields-automatically-collected). Podscribe requires certain context fields and properties for Page calls. Below is an example of a raw JSON payload that contains the minimum requirements.
+
+```js
+{
+ "type": "page",
+ "context": {
+ "ip": "111.111.111.111",
+ "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko Chrome/118.0.0.0 Safari/537.36"
+ },
+ "properties": {
+ "referrer": "",
+ "url": "https://url.com"
+ },
+ "timestamp": "2023-11-05T01:00:00.000Z",
+ "userId": "3212"
+}
+```
+
+For Page events Podscribe requires:
+- A `context` object that contains a `userAgent` and an `ip` field
+- A `properties` object that contains a `referrer` and a `url` field
+
+You'll see these in the Page event's raw JSON payload above.
+
+The `context` and `properties` objects are required, along with the fields in them. If you're using Segment server-side you must send these attributes.
+
+## Track
+
+If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
+
+```js
+analytics.track("Order Completed", {
+ order_id: "50314b8e9bcf000000000000",
+ total: 27.5,
+ coupon: "hasbros",
+ currency: "USD",
+});
+```
+
+Track calls will be mapped to Podscribe events. Podscribe supports the following from the Segment Spec:
+
+- [Signed Up](/docs/connections/spec/b2b-saas/#signed-up) as `signup`
+- [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) as `purchase`
+
+For Track events, Podscribe requires:
+- A `context` object that contains a `userAgent`
+- An `ip` Podscribe also requires a `page` object that contains a `referrer` and a `url` field
+
+Analytics.js [automatically collects context fields](/docs/connections/spec/common/#context-fields-automatically-collected). Podscribe requires certain context fields for Track calls. Below is an example of a raw JSON payload that contains the minimum requirements.
+
+```js
+{
+ "type": "track",
+ "context": {
+ "ip": "1.2.3.4",
+ "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko Chrome/118.0.0.0 Safari/537.36"
+ "page": {
+ "url": "https://url.com",
+ "referrer": ""
+ }
+ },
+ "event": "Test Event Name",
+ "userId": "test-user-xip99",
+ "timestamp": "2023-11-05T01:00:00.000Z",
+ "properties": {}
+}
+```
diff --git a/src/connections/destinations/catalog/actions-pushwoosh/index.md b/src/connections/destinations/catalog/actions-pushwoosh/index.md
new file mode 100644
index 0000000000..8ea86c48ee
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-pushwoosh/index.md
@@ -0,0 +1,31 @@
+---
+title: Pushwoosh (Actions) Destination
+id: 64e72af1eabf77368b877a51
+beta: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Pushwoosh](https://pushwoosh.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a customer engagement platform that lets you create personalized messaging campaigns combining multiple channels, like push notifications, in-app messages, emails, and SMS.
+
+Pushwoosh maintains this destination. For any issues with the destination, [contact the Pushwoosh support team](mailto:help@pushwoosh.com){:target="_blank"}.
+
+## Getting started
+
+### Pushwoosh SDK integration
+
+- If you configured Segment to receive push tokens, you don't need to integrate the Pushwoosh SDK into your app.
+- If your Segment implementation doesn't receive push tokens, integrate the Pushwoosh SDK into your app before setting up the Pushwoosh integration.
+
+### Segment configuration
+
+1. From the Segment web app, navigate to **Connections > Destinations**, and click **Add Destination**.
+2. Search for **Pushwoosh** and select it as the destination.
+3. Choose the sources you want to connect the Pushwoosh destination to.
+4. Open the destination settings.
+5. Enter your [**Pushwoosh API key**](https://docs.pushwoosh.com/platform-docs/api-reference/api-access-token/){:target="_blank"} and **application code**, which you can find below the project name in Pushwoosh. Verify that the **Enable Destination** switch is toggled on, then click **Save Changes**.
+6. Go to the **Mappings** tab and verify that the **Create or Update User Profile** and **Track Events options** are enabled.
+
+Once you've configured the integration, Pushwoosh will receive events and user attributes from Segment.
+
+{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-qualtrics/index.md b/src/connections/destinations/catalog/actions-qualtrics/index.md
index 33d0b071b8..3b14967b9a 100644
--- a/src/connections/destinations/catalog/actions-qualtrics/index.md
+++ b/src/connections/destinations/catalog/actions-qualtrics/index.md
@@ -11,11 +11,7 @@ id: 62e17e6f687e4a3d32d0f875
-[Qualtrics](https://qualtrics.com) is an Experience Management platform that allows companies to design and improve customer and employee experiences through listening, analysis and action. Power richer Qualtrics insights or perform action based on your event data using the Qualtrics destination
-
-
-
-{% include content/ajs-upgrade.md %}
+[Qualtrics](https://qualtrics.com){:target="_blank”} is an Experience Management platform that allows companies to design and improve customer and employee experiences through listening, analysis and action. Power richer Qualtrics insights or perform action based on your event data using the Qualtrics destination
@@ -28,13 +24,18 @@ Qualtrics (Actions) provides the following benefits:
+### Limitations
+The Qualtrics destination is only available to customers on a Business Tier plan with Segment.
+
+To link your Qualtrics destination in Segment to your Qualtrics workspace, [Qualtrics](https://www.qualtrics.com/support/integrations/twilio-segment/twilio-segment-task/){:target="_blank"} requires a [Segment Token](https://app.segment.com/goto-my-workspace/settings/access-management/tokens){:target="_blank"} that can only be generated by Business Tier customers who have access to the [Public API](https://segment.com/docs/api/public-api/){:target="_blank"}.
+
## Getting started
1. From the Segment web app, click **Catalog**, then click **Destinations**.
2. Find the Destinations Actions item in the left navigation, and click it.
3. Click **Configure Qualtrics**.
4. Select an existing Source to connect to Qualtrics (Actions).
-5. To authenticate, enter your API key & Datacenter ID. To locate your API key & Datacenter ID, follow in the instructions found [here](https://api.qualtrics.com/ZG9jOjg3NjYzNQ-finding-your-qualtrics-i-ds)
+5. To authenticate, enter your API key & Datacenter ID. To locate your API key & Datacenter ID, follow in the instructions found [here](https://api.qualtrics.com/ZG9jOjg3NjYzNQ-finding-your-qualtrics-i-ds){:target="_blank”}.
diff --git a/src/connections/destinations/catalog/actions-rehook/index.md b/src/connections/destinations/catalog/actions-rehook/index.md
new file mode 100644
index 0000000000..3f7a2a8c14
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-rehook/index.md
@@ -0,0 +1,101 @@
+---
+title: Rehook Destination
+id: 64c02312ff0ce798cc8d1a7e
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Rehook](https://rehook.ai/){:target="_blank"} is a powerful and dedicated user-incentivization solution that enables businesses to reward and engage users without depending on tech teams. With an elegant and easy-to-use interface, Rehook is designed to help you run user-promotion campaigns that are flexible, customizable and scalable.
+
+This destination is maintained by Rehook. For any issues with the destination, [contact the Rehook Support team](mailto:services@rehook.ai).
+
+
+## Getting started
+
+1. From the Destinations catalog page in the Segment App, click **Add Destination**.
+2. Search for **Rehook** in the Destinations Catalog, and select the **Rehook** destination.
+3. Select which Source should send data to the Rehook destination.
+4. Open the [Rehook Dashboard](https://dashboard.rehook.ai/){:target="_blank"} and navigate to **Settings > API Keys & Secret Key**. Copy your key.
+5. Open the Segment app and paste the **API Key & Secret Key** in the Rehook destination settings page.
+
+
+## Supported methods
+
+Rehook's destination is designed to support the following [Segment Spec](/docs/connections/spec) methods. Because this is an Actions Destination, you can also map other Segment methods.
+
+### Identify
+
+If you're not familiar with the Segment Spec, take a moment to understand what the [Identify method](/docs/connections/spec/identify/) does.
+An example call looks like this:
+
+#### Example 1:
+```js
+analytics.identify('userId12345', {
+ firstName: 'Bob',
+ lastName: 'Dole',
+ email: 'bob.dole@example.com',
+ company: 'Initech',
+ employees: 234
+});
+```
+
+#### Example 2:
+```js
+analytics.identify('userId12345', {
+ firstName: 'Bob',
+ lastName: 'Dole',
+ email: 'bob.dole@example.com',
+ company: 'Initech',
+ employees: 234,
+ referral_code: "ERTYUS"
+});
+```
+
+Every time you make an Identify call with an included `userId`:
+
+1. Rehook verifies that the `userId` exists.
+2. If the `userId` does not exist, Rehook adds the user as a Customer to the Rehook database and matches user properties with the Segment `traits` sent in the Identify call payload.
+3. If the `userId` exists, Rehook updates the user properties for the Customer against the Segment `traits` sent in the Identify call payload.
+4. If `referral_code` is unique, Rehook updates the user properties in its database.
+
+All of the [traits](/docs/connections/spec/identify#traits) recognized by Segment are translated and matched with the Rehook Customer user properties. These fields are automatically created or mapped for a Customer in Rehook and are available for personalization and advanced segmentation.
+
+> info "How Rehook handles incoming userId and referral_code in Identify calls:"
+> * The `userId` field is required. Rehook drops Identify calls without a userId.
+> * If a call is made with `anonymousID`, Rehook drops the Identify call.
+> * If `referral_code` matches with another `userId`, Rehook drops the Identify call.
+
+### Track
+
+If you're not familiar with the Segment Spec, take a moment to understand what the [Track method](/docs/connections/spec/track/) does.
+
+An example call looks like this:
+
+#### Example 1:
+```js
+analytics.track('Product Viewed', {
+ userId: "userId12345",
+ product_id: '507f1f779439011',
+ name: 'Monopoly: 3rd Edition',
+ price: 18.99,
+ url: 'https://www.example.com/product/path',
+ image_url: 'https://www.example.com/product/path.jpg'
+});
+```
+
+#### Example 2:
+```js
+analytics.track('signup', {
+ userId: "userId12345",
+ referral_code: 'ERTYUS'
+});
+```
+
+Segment sends Track calls to Rehook as a Custom Event. When you make a Track call, Segment sends the event to Rehook with the event name and all properties that you specified.
+
+> info "How Rehook handles incoming userId and referral_code in Track calls:"
+> * The `userId` field is required. Rehook drops Track calls without a `userId`.
+> * If a call is made with `anonymousId`, Rehook drops the Track call.
+> * The `referral_code` field is required if event name is set as a conversion event in Rehook.
+
+{% include components/actions-fields.html %}
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-revx/index.md b/src/connections/destinations/catalog/actions-revx/index.md
new file mode 100644
index 0000000000..43a60ed476
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-revx/index.md
@@ -0,0 +1,22 @@
+---
+title: RevX Cloud (Actions) Destination
+id: 6464ef424ac5c5f47f5f3968
+beta: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[RevX Cloud (Actions)](https://revx.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} helps app marketers achieve their growth objectives by simplifying programmatic advertising for them. With RevX, your reach extends to over 90% of app users globally, encompassing more than 1 million mobile apps. Leverage audience intelligence to achieve highly precise targeting, accompanied by personalized messaging. Employ advanced AI-driven audience segmentation to identify high-intent players, while optimizing creatives to amplify performance to new heights.
+
+This destination is maintained by RevX. For any issues with the destination, [contact their support team](mailto:tse@revx.io).
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Find the Destinations Actions item in the left navigation, and click it.
+3. Click **Configure RevX Cloud (Actions)**.
+4. Select an existing Source to connect to RevX Cloud (Actions).
+5. Add Revx Client ID as provided by the tse team.
+
+{% include components/actions-fields.html %}
+
diff --git a/src/connections/destinations/catalog/actions-ripe-cloud/index.md b/src/connections/destinations/catalog/actions-ripe-cloud/index.md
index dbaa6ace60..fa55442e0f 100644
--- a/src/connections/destinations/catalog/actions-ripe-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-ripe-cloud/index.md
@@ -1,37 +1,88 @@
---
-title: Ripe Cloud (Actions) Destination
+title: Ripe Cloud Mode (Actions) Destination
hide-boilerplate: true
hide-dossier: true
id: 63cade592992cf7052ce2e3e
---
-[Ripe](https://www.getripe.com/){:target="_blank"} is a product-led sales
-platform that empowers you to unlock revenue pipeline with product data. By identifying and showing which prospects to focus efforts on, you can convert leads into meetings inside your product.
+[Ripe](https://www.getripe.com/){:target="_blank"} is a sales conversion tool that enables B2B revenue teams to surface and meet their best leads at the best possible time - when they are using your product.
-This destination enables you to send product data to Ripe. Sales teams can identify who decision-makers and product champions are by understanding what properties they have and what events they have triggered. The Ripe destination is built as an alternative to directly adding Ripe’s SDK script to your app or site.
+The Ripe Segment integration is an [Actions Destination in cloud mode](/docs/connections/destinations/#connection-modes) that lets you send your product events data to Ripe.
-The Ripe Segment integration is an [Actions-based Destination in cloud mode](/docs/connections/destinations/#connection-modes) that lets you send your backend events directly to Ripe.
+Ripe maintains this destination. For any issues with the destination, [contact the Ripe team](mailto:support@getripe.com).
-{% include content/ajs-upgrade.md %}
+> success ""
+> Set up a free account with Ripe by visiting their [website](https://www.getripe.com/){:target="_blank"}.
-## Benefits of Ripe
+## Getting Started
-Ripe provides the following benefits:
+> warning "Ripe Cloud Mode (Actions) destination requires events from an Analytics.js source"
+> Ripe Cloud Mode is a way to send your backend events to Ripe and should be used in tandem with the client-side [Ripe Destination](/docs/connections/destinations/catalog/actions-ripe-web/). Without a Ripe Web Mode (Actions) destination receiving information from an Analytics.js source, you will not be able to interact with leads in the Ripe app.
-- **Be relevant**. The Ripe destination understands key events in Segment to identify relevant leads, and shows its widget selectively to them.
-- **Quick integration**. Using the Ripe destination is the fastest way to start combining key product events with sales data and start targeting ripe leads.
-- **More control**. You can customize the conditions under which the events are sent to Ripe.
+1. From the Destinations catalog page in the Segment App, click Add Destination.
+2. Search for "Ripe Cloud Mode (Actions)" in the Destinations Catalog, and select the "Ripe Cloud Mode (Actions)" destination.
+3. Choose which Source should send data to the "Ripe" destination.
+4. Go to Ripe integrations page (or onboarding page) and click on the "Segment" integration.
+5. Copy the "Segment API key".
+6. Enter the "Segment API Key" in the "Ripe Cloud Mode" destination settings in Segment.
-## Getting started
+## Supported Methods
-> info ""
-> Before you begin, create an API key in Ripe which you'll use to configure the integration.
+Ripe supports all the following methods out of the box.
-1. From the Segment web app, navigate to **Connections > Catalog**, then click the **Destinations** tab at the top of the catalog.
-2. Search for *Ripe Cloud Mode (Actions)* in the left navigation, and click it.
-3. Click **Configure Ripe Cloud Mode (Actions)**.
-4. Select an existing Source to connect to Ripe (Actions).
-5. Enter your Ripe API key in the API key field.
+### Identify
+
+Take a look at the [Identify method documentation](/docs/connections/spec/identify/) to learn about what it does. An example call would look like this:
+
+```js
+analytics.identify('userId123', {
+ email: 'steve@apple.com',
+ firstName: 'Steve',
+ lastName: 'Jobs'
+});
+```
+
+Segment sends Identify calls to Ripe as `identify` events. Ripe displays these events as `Users` by default. `Identify` event data is augmented with traits. It's important to include email as a trait, as soon as it is known. Ripe will use email to populate User views by default. Ripe fully supports [Segment's Identify Spec](https://segment.com/docs/connections/spec/identify/#traits), and recommend using the standardized names for the reserved traits covered there.
+
+
+### Track
+
+Take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like:
+
+```js
+analytics.track('Clicked Book a Demo Button')
+```
+
+Segment sends Track calls to Ripe as `track` events. Track events should be flattened whenever possible. For example, rather than `Button Click` as a track event with `Book a Demo` as a property, use `Clicked Book a Demo Button`. Product Events can be filtered and grouped by `userId` or `groupId`. When firing track calls from a backend source you should always include the `userId` to ensure it can be attributed back to the correct user.
+
+
+### Page
+
+Take a look at the [Page method documentation](https://segment.com/docs/connections/spec/page/) to learn about what it does. An example call would look like this:
+
+```js
+analytics.page()
+```
+
+Segment sends Page calls to Ripe as a `pageview` event. Ripe displays these events as Page views by default.
+
+
+### Group
+
+Take a look at the [Group method documentation](https://segment.com/docs/connections/spec/group/) to learn about what it does. An example call would look like this:
+
+```js
+analytics.group("0e8c78ea9d97a7b8185e8632", {
+ name: "Apple Inc.",
+ industry: "Technology",
+ employees: 164000,
+ plan: "enterprise",
+ "total billed": 1000000,
+ website: "apple.com"
+});
+```
+
+Segment sends Group calls to Ripe as a `group` event. Group events can be augmented with group traits. Ripe displays these events as Workspaces by default. Including a name and a website (domain) as a trait is recommended, as Ripe will use the traits to populate Workspace views by default.
{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-ripe-web/index.md b/src/connections/destinations/catalog/actions-ripe-web/index.md
index 055d34c5bf..b239f9243d 100644
--- a/src/connections/destinations/catalog/actions-ripe-web/index.md
+++ b/src/connections/destinations/catalog/actions-ripe-web/index.md
@@ -1,114 +1,84 @@
---
-title: Ripe Web (Actions) Destination
+title: Ripe Device Mode (Actions) Destination
hide-boilerplate: true
hide-dossier: true
id: 63913b2bf906ea939f153851
-redirect_from: '/connections/destinations/catalog/actions-ripe/'
---
-[Ripe](https://www.getripe.com/){:target="_blank"} is a product-led sales platform that empowers you to unlock revenue pipeline with product data. By identifying and showing which prospects to focus efforts on, you can convert leads into meetings inside your product.
+[Ripe](https://www.getripe.com/){:target="_blank"} is a sales conversion tool that enables B2B revenue teams to surface and meet their best leads at the best possible time - when they are using your product.
-This destination enables you to send product data to Ripe. Sales teams can identify decision-makers and product champions by understanding what properties they have and what events they have triggered. The Ripe destination is built as an alternative to directly adding Ripe’s SDK script to your app or site.
+The Ripe Segment integration is an [Actions-based Destination in web mode](https://segment.com/docs/connections/destinations/#connection-modes) that lets you send your product events data to Ripe.
-The Ripe Segment integration is an [Actions-based Destination in device mode](/docs/connections/destinations/#connection-modes) that loads and configures Ripe’s SDK script for you. If you’re already using Segment’s Analytics.js for identifying and tracking your users, either directly or through Segment source integrations that you’ve installed, you can configure Segment to send this data directly to Ripe.
+Ripe maintains this destination. For any issues with the destination, [contact the Ripe team](mailto:support@getripe.com).
-{% include content/ajs-upgrade.md %}
+> success ""
+> Set up a free account with Ripe by visiting their [website](https://www.getripe.com/){:target="_blank"}.
-## Benefits of Ripe
+## Getting Started
-Ripe provides the following benefits:
+1. From the Destinations catalog page in the Segment App, click Add Destination.
+2. Search for "Ripe Device Mode (Actions)" in the Destinations Catalog, and select the "Ripe Device Mode (Actions)" destination.
+3. Choose which Source should send data to the "Ripe Device Mode (Actions)" destination.
+4. Go to Ripe integrations page (or onboarding) and click on the "Segment" integration.
+5. Copy the "Segment API key".
+6. Enter the "Segment API Key" in the "Ripe" destination settings in Segment.
-- **Be relevant**. The Ripe destination understands key events in Segment to identify relevant leads, and shows its widget selectively to them.
-- **Quick integration**. Using the Ripe destination is the fastest way to start combining key product events with sales data and start targeting ripe leads.
-- **More control**. You can customize the conditions under which the events are sent to Ripe.
+## Supported Methods
-## Getting started
-
-> info ""
-> Before you begin, create an API key in Ripe that you'll use to configure the integration.
-
-
-1. From the Segment web app, navigate to **Connections > Catalog**, then click the **Destinations** tab at the top of the catalog.
-2. Search for *Ripe Device Mode (Actions)* in the left navigation, and click it.
-3. Click **Configure Ripe Device Mode (Actions)**.
-4. Select an existing Source to connect to Ripe (Actions).
-5. Enter your Ripe API key in the API key field.
-
-{% include components/actions-fields.html %}
-
-{% comment %}
-## Ripe SDK
+Ripe supports all the following methods out of the box.
### Identify
-When you have a unique identifier for a user, preferably an identifier from your database, call this method. For example, when a user logs in or updates their email. If you don't provide a `user_id` is not provided an automatically generated `anonymous_id` will be used.
-
-If you aren't familiar with the Segment Spec, take a look at
-the [Identify method documentation](/docs/connections/spec/identify/) to learn
-about what it does. An example call would look like:
+Take a look at the [Identify method documentation](/docs/connections/spec/identify/) to learn about what it does. An example call would look like this:
```js
analytics.identify('userId123', {
- email: 'john.doe@example.com'
+ email: 'steve@apple.com',
+ firstName: 'Steve',
+ lastName: 'Jobs'
});
```
-Segment sends Identify calls to Ripe as an `identify` event.
+Segment sends Identify calls to Ripe as `identify` events. Ripe displays these events as `Users` by default. `Identify` event data is augmented with traits. It's important to include email as a trait, as soon as it is known. Ripe will use email to populate User views by default. We fully support the [Segment's Identify Spec](https://segment.com/docs/connections/spec/identify/#traits), and we recommend using the standardized names for the reserved traits covered there.
-### Track
-Use `track` calls to track what actions your user perform along with properties
-related to the `track` call.
+### Track
-If you aren't familiar with the Segment Spec, take a look at
-the [Track method documentation](/docs/connections/spec/track/) to learn about
-what it does. An example call would look like:
+Take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like:
```js
-analytics.track('Login Button Clicked')
+analytics.track('Clicked Book a Demo Button')
```
-Segment sends Track calls to Ripe as a `track` event.
+Segment sends Track calls to Ripe as `track` events. Track events should be flattened whenever possible. For example, rather than `Button Click` as a track event with `Book a Demo` as a property, use `Clicked Book a Demo Button`. Product Events can be filtered and grouped by `userId` or `groupId`. Both of these will be appended automatically if they have been fired prior to the track call for web/client-side events.
----> Add comment on fast track property here?
-### Group
+### Page
-If you aren't familiar with the Segment Spec, take a look at
-the [Group method documentation](/docs/connections/spec/group/) to learn about
-what it does. An example call would look like:
+Take a look at the [Page method documentation](https://segment.com/docs/connections/spec/page/) to learn about what it does. An example call would look like this:
```js
-analytics.group("0e8c78ea9d97a7b8185e8632", {
- name: "Initech",
- industry: "Technology",
- employees: 329,
- plan: "enterprise",
- "total billed": 830
-});
+analytics.page()
```
-Group calls from Segment update `Companies` in Ripe. Each `Company` is
-associated with a distinct `group_id`.
+Segment sends Page calls to Ripe as a `pageview` event. Ripe displays these events as Page views by default.
-### Page
-Use page calls to track what pages your users sees. This is typically called on
-each page load in a traditional web page and on route changes in
-SPA-applications.
+### Group
-If you aren't familiar with the Segment Spec, take a look at
-the [Page method documentation](/docs/connections/spec/page/) to learn about
-what it does. An example call would look like:
+Take a look at the [Group method documentation](https://segment.com/docs/connections/spec/group/) to learn about what it does. An example call would look like this:
```js
-analytics.page('Home')
+analytics.group("0e8c78ea9d97a7b8185e8632", {
+ name: "Apple Inc.",
+ industry: "Technology",
+ employees: 164000,
+ plan: "enterprise",
+ "total billed": 1000000,
+ website: "apple.com"
+});
```
-Segment sends Page calls to Ripe as a `pageview` event.
+Segment sends Group calls to Ripe as a `group` event. Group events can be augmented with group traits. Ripe displays these events as Workspaces by default. Including a name and a website (domain) as a trait is recommended, as Ripe will use the traits to populate Workspace views by default.
-### Segment session
-
-Ripe will use the `userId`, `anonymous` and `groupId` set in Segment and the Ripe SDK keeps track of the current ids.
-
-{% endcomment %}
+{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-rupt/index.md b/src/connections/destinations/catalog/actions-rupt/index.md
new file mode 100644
index 0000000000..bfcde02af8
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-rupt/index.md
@@ -0,0 +1,32 @@
+---
+title: Rupt (Actions) Destination
+hide-boilerplate: true
+hide-dossier: true
+beta: true
+id: 6501a5225aa338d11164cc0f
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Rupt](https://rupt.dev?utm_source=segment.com&utm_medium=docs&utm_campaign=partners){:target="_blank"} helps customers monitor and monetize account sharing.
+
+## Benefits of Rupt (Actions)
+
+Rupt (Actions) provides the following benefits:
+
+- **Account sharing detection**. Find out exactly which accounts are being shared and how many people are sharing them.
+- **Convert & monetize account sharers**. Prebuilt UI to convert account sharers into paying customers.
+- **Track account sharing revenue**. Track revenue from account sharing conversions.
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Search for *Rupt (Actions)* and select it.
+3. Click **Configure Rupt (Actions)**.
+4. Select an existing Source to connect to Rupt (Actions).
+5. Copy your **API key Client ID** from the [Rupt dashboard](https://dashboard.rupt.dev?utm_source=segment.com&utm_medium=docs&utm_campaign=partners){:target="_blank"}.
+6. Add your API key to the Rupt (Actions) settings in Segment.
+
+{% include components/actions-fields.html %}
+
+To learn more about how Rupt works, see: [How account sharing prevention works](https://www.rupt.dev/docs/how-account-sharing-prevention-works?utm_source=segment.com&utm_medium=docs&utm_campaign=partners){:target="_blank"}.
diff --git a/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md b/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md
index 061e10c91a..3d34244d78 100644
--- a/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md
@@ -58,7 +58,11 @@ Once you save the API integration and add permissions, you will see a Summary pa
{% include components/actions-fields.html settings="true"%}
-## FAQ & Troubleshooting
+> info ""
+> Note that **send contact to data extension** handles a pre-defined structure of contacts being filled into a data extension, whereas **send event to data extension action** customizes event data extensions.
+> For example, `contactKey` is the fixed Primary Key that is available when you use **send contact to data extension** action, which you also have to create as a Primary Key in SFMC. However, the Primary Key can be set as per Segment's requirements using **send event to data extension**.
+
+## FAQ and troubleshooting
### Batching Data to SFMC
@@ -71,7 +75,7 @@ The batch feature is only compatible with the "Send Contact to Data Extension" a
### Data Extensions & API Events
-To use the SFMC Journey Builder to send marketing campaigns to your users, you need to have data about those users in SFMC. The most common way to send data to SFMC is to send Segment data to an SFMC data extension. Data extensions are tables that contain your data. When you send a contact or event to a data extension, it appear will appear as a "row" in your data extension. Any metadata about the particular contact or event are considered attributes and will appear as a "column" in your data extension.
+To use the SFMC Journey Builder to send marketing campaigns to your users, you need to have data about those users in SFMC. The most common way to send data to SFMC is to send Segment data to an SFMC data extension. Data extensions are tables that contain your data. When you send a contact or event to a data extension, it will appear as a "row" in your data extension. Any metadata about the particular contact or event are considered attributes and will appear as a "column" in your data extension.
Data extensions and attributes must be created **before** sending data. You can create a data extension in your SFMC account by navigating to **Audience Builder > Contact Builder > Data Extensions > Create**. Segment recommends creating a single data extension to store all contact data, and individual data extensions for each event type you plan to send. Once a data extension is created, you can add attributes for any traits or properties you plan to send. You must include at least one Primary Key attribute that will be used to uniquely identify each row.
@@ -85,7 +89,7 @@ API events are another way to send your Segment events to SFMC. API events can t
To send an Engage audience to SFMC:
1. Create an attribute in the SFMC data extension that stores your contact data. The attribute should be a boolean data type to store whether or not a user entered the audience. You can name this attribute anything.
2. Set up the Salesforce Marketing Cloud (Actions) destination using the instructions [above](#connect-the-salesforce-marketing-cloud-actions-destination) and connect it to your Engage source.
-3. Create a "Send Contact to Data Extension" action in order to map the SFMC attribute to the Engage audience key. The Engage audience key can be found in **Engage > Audiences > Select your audience > Settings > Audience key**. In the Contact Fields mapping, input the name of the attribute you created in SFMC on the left-hand side. On the right-hand side, search for an event variable of `traits.[your-audience-key]` and select "No matches found. Use "traits.[your-audience-key]" as an event variable".
+3. Create a "Send Contact to Data Extension" action in order to map the SFMC attribute to the Engage audience key. The Engage audience key can be found in **Engage > Audiences > Select your audience > Settings > Audience key**. In the Contact Fields mapping, input the name of the attribute you created in SFMC on the right-hand side. On the left-hand side, search for an event variable of `traits.[your-audience-key]` and select "No matches found. Use "traits.[your-audience-key]" as an event variable".
4. Navigate back to your Engage audience and connect the Salesforce Marketing Cloud (Actions) destination to the audience. Keep "Send Identify" toggled on and save.
When you add an Engage audience to SFMC, the first sync contains all the users in that audience. Users are added as rows in your data extension with the attribute you created set to `true` to indicate audience membership. If a user leaves that audience, the attribute value is automatically updated to `false`, but the user is not removed from the data extension. This allows you to see all users who have ever been in the audience, and then optionally create a [filtered data extension](https://help.salesforce.com/s/articleView?id=sf.mc_es_create_filtered_de.htm&type=5){:target="_blank"} if you want a subset of users.
@@ -93,5 +97,5 @@ When you add an Engage audience to SFMC, the first sync contains all the users i
To send an Engage computed trait to SFMC:
1. Create an attribute in the SFMC data extension that stores your contact data. Choose the data type matching the type of computed trait you plan to send; for example, text for traits which produce string values, number or decimal for traits which produce numeric values. You can name this attribute anything.
2. Set up the Salesforce Marketing Cloud (Actions) destination using the instructions [above](#connect-the-salesforce-marketing-cloud-actions-destination) and connect it to your Engage source.
-3. Create a "Send Contact to Data Extension" action in order to map the SFMC attribute to the Engage trait key. The Engage trait key can be found in **Engage > Audiences > Computed Traits > Choose your computed trait > Settings > Trait key**. In the Contact Fields mapping, input the name of the attribute you created in SFMC on the left-hand side. On the right-hand side, search for an event variable of `traits.[your-trait-key]` and select "No matches found. Use "traits.[your-trait-key]" as an event variable".
+3. Create a "Send Contact to Data Extension" action in order to map the SFMC attribute to the Engage trait key. The Engage trait key can be found in **Engage > Audiences > Computed Traits > Choose your computed trait > Settings > Trait key**. In the Contact Fields mapping, input the name of the attribute you created in SFMC on the right-hand side. On the left-hand side, search for an event variable of `traits.[your-trait-key]` and select "No matches found. Use "traits.[your-trait-key]" as an event variable".
4. Navigate back to your Engage computed trait and connect the Salesforce Marketing Cloud (Actions) destination to the computed trait. Keep "Send Identify" toggled on and save.
diff --git a/src/connections/destinations/catalog/actions-salesforce/index.md b/src/connections/destinations/catalog/actions-salesforce/index.md
index faa0750eef..80d03237bb 100644
--- a/src/connections/destinations/catalog/actions-salesforce/index.md
+++ b/src/connections/destinations/catalog/actions-salesforce/index.md
@@ -81,7 +81,6 @@ If you have more than one Salesforce instance connected to Segment, repeat these
Keep the following in mind as you begin to use Salesforce (Actions):
- Salesforce (Actions) supports batching. The workspace owner can edit the enabled-batching field manually for any of the mappings. This setting is disabled by default.
-- Salesforce (Actions) doesn’t support Delete CRUD operations on Custom Object. Custom Objects with CRUD the operation set to `delete` are not migrated.
- Sending Identify events to Salesforce (Classic) results in a create or update operation for Leads, and maps properties from `event.traits` Salesforce (Actions) does not support this behavior. By default, the automatic migration maps only a subset of the most used Lead properties as mentioned below. The workspace owner must map any additional Salesforce properties or Custom properties manually.
Review the tables below to see how settings from Salesforce (Classic) were migrated to Salesforce (Actions).
@@ -117,7 +116,7 @@ Review the tables below to see how settings from Salesforce (Classic) were migra
## FAQ
### How do I enable a sandbox instance?
-To send data to a Salesforce sandbox instance, navigate to **Settings > Advanced Settings**, toggle on the "Sandbox Instance" setting, and authenticate. If you are already authenticated, please disconnect and reconnect with your sandbox username.
+To send data to a Salesforce sandbox instance, navigate to **Settings > Advanced Settings**, toggle on the "Sandbox Instance" setting, save the setting and then authenticate. If you are already authenticated, please disconnect and reconnect with your sandbox username.
Your Salesforce sandbox username appends the sandbox name to your Salesforce production username. For example, if a username for a production org is `user@acme.com` and the sandbox is named `test`, the username to log in to the sandbox is `user@acme.com.test`.
@@ -155,7 +154,12 @@ When using the `create` operation, it's possible for duplicate records to be cre
Please note this is only a concern when using the `create` operation. You can use the `upsert` operation instead to avoid duplicates if `upsert` meets your needs.
### How does Salesforce Bulk API work?
-When **Use Salesforce Bulk API** is enabled for your mapping, events are sent to [Salesforce’s Bulk API 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm){:target="_blank"} rather than their streaming REST API. If enabled, Segment will collect events into batches of 1000 before sending to Salesforce. Bulk support can be used for the `upsert` or `update` operations only.
+When **Use Salesforce Bulk API** is enabled for your mapping, events are sent to [Salesforce’s Bulk API 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm){:target="_blank"} rather than their streaming REST API. If enabled, Segment will collect events into batches of up to 1000 before sending to Salesforce. Bulk support can be used for the `upsert` or `update` operations only.
For bulk `update`, if a record in a batch is missing a Bulk Update Record ID, Segment will still send it to Salesforce. Salesforce will reject the individual record because it will be unable to find a record to update. Other records in the batch that are valid will still be processed. Please note that Segment's Event Delivery tab will show the entire batch as successful as Segment cannot currently break down Event Delivery stats into individual failed/passed events.
+### Which fields are supposed to map to Salesforce’s required fields for "Bulk Update Record ID" and "Bulk Upsert External ID"?
+
+For "Bulk Update Record ID", see [Salesforce’s help documentation](https://help.salesforce.com/s/articleView?id=000385008&type=1){:target="_blank"}.
+For "Bulk Upsert External ID", see[Salesforce’s help documentation](https://help.salesforce.com/s/articleView?id=000383278&type=1){:target="_blank"}.
+
diff --git a/src/connections/destinations/catalog/actions-saleswings/index.md b/src/connections/destinations/catalog/actions-saleswings/index.md
index 24016bda60..df0cf88dcf 100644
--- a/src/connections/destinations/catalog/actions-saleswings/index.md
+++ b/src/connections/destinations/catalog/actions-saleswings/index.md
@@ -2,10 +2,11 @@
title: SalesWings (Actions) Destinaton
hide-boilerplate: true
hide-dossier: true
-private: true
+private: false
id: 63d17a1e6ab3e62212278cd0
----
+hidden: false
+---
{% include content/plan-grid.md name="actions" %}
[SalesWings](https://www.saleswingsapp.com/){:target="_blank"} is a lead scoring platform that offers a user-friendly, no-code solution to identify your leads' true interests. The SalesWings Destination enables using the data collected in Segment to identify, tag and prioritize your leads in SalesWings for your Marketing and Sales teams.
diff --git a/src/connections/destinations/catalog/actions-schematic/index.md b/src/connections/destinations/catalog/actions-schematic/index.md
new file mode 100644
index 0000000000..8c45c9ad8f
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-schematic/index.md
@@ -0,0 +1,28 @@
+---
+title: Schematic (Actions) Destination
+beta: true
+id: 65b8e9eca1b5903a031c6378
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Schematic](https://schematichq.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} enables you to launch, package, meter, and monitor features with ease, so you can manage it all in one place as your business grows.
+
+Segment is the easiest way to send events from your application to Schematic. If you already have Segment up and running in your application, Schematic recommends this approach so you don't have to implement any additional code.
+
+Schematic maintains this destination. For any issues with the destination, [contact the Schematic Support team](mailto:hi@schematichq.com).
+
+## Getting started
+
+1. From your Segment web app, navigate to **Connections > Catalog > Destinations**.
+2. Search for *Schematic*, select the Schematic destination, and click **Add destination**.
+3. Select the source that will send data to Schematic, give your destination a name, then click **Create destination**.
+4. On the destination's Settings tab, input your Schematic API Key. To generate an API key, navigate to your Schematic workspace settings under **Settings > API Keys**.
+
+Once you've connected Schematic to Segment, you can configure how you want to send data to Schematic in the Schematic destination's **Mappings** tab.
+
+{% include components/actions-fields.html %}
+
+## Additional Context
+
+Schematic only accepts Track event names that contain alphanumeric characters, dashes, and underscores. If Segment event names have other characters, like spaces, the Schematic destination automatically snake_cases the event name before passing to Schematic. Segment passes the raw event name as an event trait.
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-screeb-web/index.md b/src/connections/destinations/catalog/actions-screeb-web/index.md
new file mode 100644
index 0000000000..e32e60f73c
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-screeb-web/index.md
@@ -0,0 +1,24 @@
+---
+title: Screeb Web (Actions) Destination
+id: 64820d8030d09e775fbac372
+beta: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Screeb](https://screeb.app/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"}
+ provides self-serve predictive analytics for growth marketers, using machine learning to automate audience insights and recommendations.
+
+Screeb maintains this destination. For any issues with the destination, consult [Screeb's documentation](https://github.com/ScreebApp/developers/wiki){:target="_blank"} or [contact their support team](mailto:support@screeb.app).
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Find the Destinations Actions item in the left navigation, and click it.
+3. Click **Configure Screeb Web (Actions)**.
+4. Select an existing Source to connect to **Screeb Web (Actions)**.
+5. Find your Website ID on [Screeb > Settings > Install Screeb > Web App](https://admin.screeb.app/org/last/settings/install?from=segment){:target="_blank"}
+6. In the destination configuration, input the Website ID.
+7. Enable the destination.
+
+{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-segment-profiles/index.md b/src/connections/destinations/catalog/actions-segment-profiles/index.md
index 05385bf2f8..fa32f0694a 100644
--- a/src/connections/destinations/catalog/actions-segment-profiles/index.md
+++ b/src/connections/destinations/catalog/actions-segment-profiles/index.md
@@ -15,16 +15,12 @@ The Segment Profiles destination allows you to send your warehouse data back to
To use this destination, you must have an active Segment Profile space. If you have not yet created a Segment Profile space, please follow the steps in the [Profiles Onboarding Guide](/docs/profiles/quickstart/).
-### Create a Public API token
-
-To enable the Segment Profiles destination to send data to an existing Profile space, provide an authentication token for the Segment Public API. See [Segment's Public API documentation](https://docs.segmentapis.com/tag/Getting-Started#section/Get-an-API-token){:target="_blank"} for information on how to create a token. The token must include Source Admin permissions. You will need this token in the below steps.
-
### Connect and configure the Segment Profiles destination
1. From the Segment web app, navigate to **Reverse ETL > Destinations**.
2. Click **Add Destination**.
3. Select the Segment Profiles destination, click **Next**, and select the warehouse source that will send data to the Segment Profiles destination. If you have not set up a warehouse source, follow the steps in the Reverse ETL documentation on [Getting started](/docs/reverse-etl/#getting-started).
-4. On the **Settings** tab, name your destination, input the Public API token created above, select an endpoint region, and click **Save Changes**. It is recommended to configure and enable all mappings before enabling the Segment Profiles destination.
+4. On the **Settings** tab, name your destination, select an endpoint region, and click **Save Changes**. It is recommended to configure and enable all mappings before enabling the Segment Profiles destination.
5. On the **Mappings** tab, click **Add Mapping**. Select a data model and the API call type you want to map. Identify calls will create and update user profiles and Group calls will create and update account profiles. Fill in the fields on screen to create the desired mappings, and click **Create Mapping** to complete the configuration. Repeat this step to configure multiple mappings.
6. Enable the configured mapping(s).
7. On the **Settings** tab, click the **Enable Destination** toggle, and then click **Save Changes** to enable the Segment Profiles destination.
@@ -35,3 +31,13 @@ To enable the Segment Profiles destination to send data to an existing Profile s
### API Calls and MTUs
The Segment Profiles destination is not subject to API call or MTU costs. Any users or accounts created and updated by the Segment Profiles destination will not count towards your API call or MTU usage.
+
+### Succesful syncs but no changes on profiles
+Make sure that the Endpoint Region setting matches the region of your workspace. If the region is correct and you don't see any profile changes, [contact Segment](https://segment.com/help/contact/){:target="_blank"}.
+
+### Test Mapping
+The **Test Mapping** feature on the Mapping page does not send events to Profiles. It will only validate the mappings and confirm that the event will be accepted by the Tracking API. To send and validate the event in profile, please run a RETL sync.
+
+### Can I view samples of events received in Engage by the Segment Profiles Destination?
+
+Records sent to the Segment Profiles Destination are managed through a Unify Spaces' Profile Sources. Samples of these events may be reviewed in a [Profile Source Debugger](https://segment.com/docs/unify/debugger/). For a more comprehensive analysis of the events received in Unify & Engage, consider utilizing [Profiles Sync](https://segment.com/docs/unify/profiles-sync/overview/) connected to your Data Warehouse.
diff --git a/src/connections/destinations/catalog/actions-segment/index.md b/src/connections/destinations/catalog/actions-segment/index.md
index d4decadd8d..da70dd5eeb 100644
--- a/src/connections/destinations/catalog/actions-segment/index.md
+++ b/src/connections/destinations/catalog/actions-segment/index.md
@@ -32,3 +32,6 @@ The Segment Connections destination enables you to mold data extracted from your
### API Calls and MTUs
The Segment Connections destination sends data to Segment's Tracking API, which has cost implications. New users will count as new MTUs and each call will count as an API call. For information on how Segment calculates MTUs and API calls, please see [MTUs, Throughput and Billing](/docs/guides/usage-and-billing/mtus-and-throughput/).
+
+### Test Mapping
+The **Test Mapping** feature on the Mapping page does not send events to the Tracking API. It only validates the mappings and confirms that the event will be accepted by the Tracking API. To send and validate the event in your source, run a RETL sync.
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-sendgrid/index.md b/src/connections/destinations/catalog/actions-sendgrid/index.md
index 25877e2117..e2653709f2 100644
--- a/src/connections/destinations/catalog/actions-sendgrid/index.md
+++ b/src/connections/destinations/catalog/actions-sendgrid/index.md
@@ -8,9 +8,7 @@ id: 631a6f32946dd8197e9cab66
---
-{% include content/ajs-upgrade.md %}
-
-[SendGrid Marketing Campaigns](https://sendgrid.com/solutions/email-marketing/) provides email marketing automation for businesses. With Segment you can add contacts and lists to SendGrid Marketing Campaigns.
+[SendGrid Marketing Campaigns](https://sendgrid.com/solutions/email-marketing/){:target="_blank”} provides email marketing automation for businesses. With Segment you can add contacts and lists to SendGrid Marketing Campaigns.
## Getting started
diff --git a/src/connections/destinations/catalog/actions-slack/index.md b/src/connections/destinations/catalog/actions-slack/index.md
index f25e1063ef..aeea0d094a 100644
--- a/src/connections/destinations/catalog/actions-slack/index.md
+++ b/src/connections/destinations/catalog/actions-slack/index.md
@@ -7,7 +7,7 @@ redirect_from:
- '/connections/destinations/catalog/vendor-slack'
versions:
- name: Slack (Classic)
- link: /docs/connections/destinations/slack
+ link: /docs/connections/destinations/catalog/slack/
---
{% include content/plan-grid.md name="actions" %}
@@ -30,21 +30,19 @@ Slack (Actions) provides the following benefits over the classic Slack destinati
3. Click **Configure Actions Slack**.
4. Select an existing Source to connect to Slack (Actions).
5. Click Customized Setup to start from a blank mapping.
+6. In your Slack workspace, create a new [Incoming Webhook URL](https://my.slack.com/services/new/incoming-webhook/){:target="_blank"} and select the Slack channel associated with your account that you'd like to send messages to. The Slack channel you select will be the default channel that receives message events. Paste the Incoming Webhook URL you created into each of your Slack Destination's Actions under the field labeled `Webhook URL*`.
## Important differences from the classic Slack destination
-- The classic Slack destination formats messages using the handlebars syntax. Slack (Actions) follows [Slack's formatting syntax](https://api.slack.com/reference/surfaces/formatting){:target="_blank"}.
+- The classic Slack destination formats messages using the handlebars syntax. Slack (Actions) follows [Slack's formatting syntax](https://api.slack.com/reference/surfaces/formatting){:target="_blank"}.
{% include components/actions-fields.html %}
## Migration from the classic Slack destination
-{% include content/ajs-upgrade.md %}
-
-
Follow the table below to map your existing Slack destination configuration to Slack (Actions).
> warning ""
> Slack (Actions) uses [Slack's formatting syntax](https://api.slack.com/reference/surfaces/formatting){:target="_blank"}. This requires that you manually re-enter any messages from Slack Classic, and pick event data from the event variable picker. The handlebars syntax from Slack Classic is not compatible.
-{% include components/actions-map-table.html name="slack" %}
\ No newline at end of file
+{% include components/actions-map-table.html name="slack" %}
diff --git a/src/connections/destinations/catalog/actions-snap-conversions/index.md b/src/connections/destinations/catalog/actions-snap-conversions/index.md
index edd266b40a..0ef7f67187 100644
--- a/src/connections/destinations/catalog/actions-snap-conversions/index.md
+++ b/src/connections/destinations/catalog/actions-snap-conversions/index.md
@@ -36,6 +36,12 @@ The Snapchat Conversions API destination provides the following benefits:
## FAQ and Troubleshooting
+### Invalid token error
+If you're experiencing 400 Bad Requests errors related to an invalid token, follow [these instructions](/docs/connections/destinations/catalog/actions-snap-conversions/#getting-started) to reauthorize your account:
+- On the **Settings** tab, authenticate with Snap using OAuth.
+- Click **Connect to Snapchat Conversions API**.
+- Follow the prompts to authenticate using OAuth with a Snapchat login. Use a Snapchat login that is a member of the Snapchat Ads account you want to connect.
+
### Deduplication with the Snap Pixel or App Ads Kit (SDK)
There are many ways to send conversion data to Snap, including through the Snap Pixel, App Ads Kit or Conversions API. Snap recommends sending redundant data across sources to ensure the best optimization, targeting, and measurement capabilities. The Client Deduplication ID, Transaction ID, and Mobile Ad Identifier are used by Snap to deduplicate events across sources. Please see below for guidance on when to use each field for deduplication.
- **Web**: Snap Conversions API and PixeI
@@ -51,7 +57,7 @@ There are many ways to send conversion data to Snap, including through the Snap
The Client Deduplication ID allows for a 48-hour deduplication window. The Transaction ID is only eligible for `PURCHASE` events and allows for a 30-day deduplication window. See Snapchat’s [Marketing API documentation](https://marketingapi.snapchat.com/docs/conversion.html#deduplication){:target="_blank"} and [Business Help Center](https://businesshelp.snapchat.com/s/article/event-deduplication?language=en_US){:target="_blank"} for more information.
> info ""
-> Segment does not have client-side destinations for the Snap Pixel or Snap App Ads Kit (SDK). If you choose to integrate client-side, these must be implemented natively. See Snapchat’s [Install Snap Pixel](https://businesshelp.snapchat.com/s/article/pixel-website-install?language=en_US){:target="_blank"} and [App Ads Kit](https://businesshelp.snapchat.com/s/article/app-ads-kit?language=en_US){:target="_blank"} for implementation details.
+> Segment does not have client-side destinations for the Snap Pixel or Snap App Ads Kit (SDK). If you choose to integrate client-side, these must be implemented natively. See Snapchat’s [Install Snap Pixel](https://businesshelp.snapchat.com/s/article/pixel-website-install?language=en_US){:target="_blank"} and [App Ads Kit](https://businesshelp.snapchat.com/s/topic/0TO0y000000YmidGAC/app-ads-kit?language=en_US){:target="_blank"} for implementation details.
### Latency
It may take up to 1-hour for events to appear in the Snapchat [Events Manager](https://businesshelp.snapchat.com/s/article/events-manager?language=en_US){:target="_blank"}.
@@ -62,7 +68,15 @@ If you want to send a Snap Event Type that Segment doesn’t have a prebuilt map
2. Set up your Event Trigger criteria for trial starts.
3. Input a literal string of “START_TRIAL” as the Event Type.
-The Snapchat Conversions API only supports sending Event Types that are in the [predefined `event_type` list](https://marketingapi.snapchat.com/docs/conversion.html#conversion-parameters){:target="_blank"}. This includes custom events. You must use `CUSTOM_EVENT_1`, `CUSTOM_EVENT_2`, `CUSTOM_EVENT_3`, `CUSTOM_EVENT_4`, or `CUSTOM_EVENT_5` as the Event Type. Events sent with an invalid event type will fail with an `Unrecognized event type` error.
+The Snapchat Conversions API only supports sending Event Types that are in the [predefined `event_type` list](https://marketingapi.snapchat.com/docs/conversion.html#conversion-parameters){:target="_blank"}. This includes custom events. You must use `CUSTOM_EVENT_1`, `CUSTOM_EVENT_2`, `CUSTOM_EVENT_3`, `CUSTOM_EVENT_4`, or `CUSTOM_EVENT_5` as the Event Type. Events sent with an invalid event type will fail with an `Unrecognized event type` error.
+
+### Single or multiple products or items
+It's possible to send details of either single or multiple products/items in a single conversion event.
+- **Single product/item**: Use the "Item ID", "Item Category" and "Brand" fields.
+- **Multiple products/items**: Use the "Products" field which accepts an array of products / items.
+
+### Specifying the total value of a purchase
+The "Price" field should be used when specifying the total value of a purchase, and should contain a numeric value only. e.g. 99.5.
### Required parameters and hashing
To match visitor events with Snapchat ads, Snap requires that one or a combination of the following parameters are sent to the Conversions API:
diff --git a/src/connections/destinations/catalog/actions-sprig-web/index.md b/src/connections/destinations/catalog/actions-sprig-web/index.md
index 76be4c9337..4d8f507dce 100644
--- a/src/connections/destinations/catalog/actions-sprig-web/index.md
+++ b/src/connections/destinations/catalog/actions-sprig-web/index.md
@@ -12,7 +12,7 @@ hidden: true
[Sprig (formerly UserLeap)](https://sprig.com/?&utm_source=segmentio&utm_medium=docs_actions&utm_campaign=integration){:target="_blank"} is an in-context user research platform that makes it fast and effortless for product teams to learn from their actual customers in real-time, through microsurveys, concept tests, and video questions.
-Sprig maintains this destination. For any issues with the destination, consult [Sprig's documentation](https://docs.sprig.com/docs/segment-web) or contact [support@sprig.com](mailto:support@sprig.com).
+Sprig maintains this destination. For any issues with the destination, consult [Sprig's documentation](https://docs.sprig.com/docs/segment-web){:target="_blank”} or contact [support@sprig.com](mailto:support@sprig.com).
diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/copy-pixel-id.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/copy-pixel-id.png
new file mode 100644
index 0000000000..5779b94896
Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/copy-pixel-id.png differ
diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/email-event-rule.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/email-event-rule.png
new file mode 100644
index 0000000000..6c108a7fbb
Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/email-event-rule.png differ
diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/install-pixel-link.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/install-pixel-link.png
new file mode 100644
index 0000000000..10dda554bd
Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/install-pixel-link.png differ
diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/order-completed-event-rule.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/order-completed-event-rule.png
new file mode 100644
index 0000000000..d850eceeb0
Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/order-completed-event-rule.png differ
diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/snowflake-mappings.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/snowflake-mappings.png
new file mode 100644
index 0000000000..7ab6cc4a6d
Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/snowflake-mappings.png differ
diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/user-registered-event-rule.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/user-registered-event-rule.png
new file mode 100644
index 0000000000..a4f493cfad
Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/user-registered-event-rule.png differ
diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/index.md b/src/connections/destinations/catalog/actions-stackadapt-cloud/index.md
new file mode 100644
index 0000000000..d0d132e18e
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-stackadapt-cloud/index.md
@@ -0,0 +1,172 @@
+---
+title: StackAdapt Destination
+hide-boilerplate: true
+hide-dossier: true
+beta: true
+id: 61d8859be4f795335d5c677c
+hidden: true
+redirect_from: '/connections/destinations/catalog/actions-stackadapt/'
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+By setting up StackAdapt as a Segment destination, your Segment events will be forwarded to [StackAdapt](https://www.stackadapt.com/){:target="_blank"}. This allows you to generate retargeting and lookalike audiences, track conversions, and measure return on ad spend using your Segment events - bypassing the need to install the StackAdapt pixel on your website and write code to send events to StackAdapt.
+
+This destination is maintained by StackAdapt. For any issues with the destination, please [submit a ticket to StackAdapt's support team](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="_blank"}.
+
+
+## Getting started
+
+### Getting your StackAdapt Universal Pixel ID
+
+1. Log in to your StackAdapt account and navigate to the Pixels page.
+2. Above the list of pixels, click **Install StackAdapt Pixel**.
+
+ 
+
+3. In the instructions that appear, copy the universal pixel ID from the code snippet. Below is an example of a code snippet where the universal pixel ID is `sqQHa3Ob1hFi__2EcYYVZg1`.
+
+
+
+### Setting up the StackAdapt destination in Segment
+
+1. From the Segment web app, navigate to **Connections > Catalog > Destinations**.
+2. Search for and select the "StackAdapt" destination.
+3. Click **Add Destination**.
+4. Select an existing source to connect to the StackAdapt destination.
+5. Give the destination a name.
+6. On the Settings screen, provide your StackAdapt Universal Pixel ID. This can be found on the Pixels page in StackAdapt as described above.
+7. Toggle on the destination using the **Enable Destination** toggle.
+8. Click **Save Change**.
+
+### StackAdapt Pixel setup
+
+Segment events that are forwarded to StackAdapt can be used to track ad conversions, and to generate retargeting and lookalike audiences. Please review the StackAdapt documentation for the general setup of these if you are not already familiar:
+
+- [Creating Conversion Events](https://support.stackadapt.com/hc/en-us/articles/360005859214-Creating-Conversion-Events){:target="_blank"}
+- [Creating Retargeting Audiences](https://support.stackadapt.com/hc/en-us/articles/360005939153-Creating-Retargeting-Audiences){:target="_blank"}
+- [How to Generate and Target a Lookalike Audience](https://support.stackadapt.com/hc/en-us/articles/360023738733-How-to-Generate-and-Target-a-Lookalike-Audience){:target="_blank"}
+
+Setup of conversion events, retargeting audiences, and lookalike audiences that fire on Segment events is largely the same as the setup in the StackAdapt documentation, with a few caveats:
+
+1. You **must** select "Universal Pixel" as the pixel type. This is because the StackAdapt destination in Segment uses your Universal Pixel ID to send events to StackAdapt.
+2. There is no need to install the StackAdapt pixel on your website as instructed in the "Installation" step, since Segment will forward events to StackAdapt that would normally be tracked by the StackAdapt pixel.
+3. If you choose to set up event rules, you will need to ensure that you use the event keys supported by the the StackAdapt destination as described below.
+
+### Event rules
+
+The StackAdapt Segment destination sends an `action` event key which by default is mapped to the Segment event name. Creating rules on this `action` key should be sufficient for most simple event rule use cases. For example, if you fire a Segment event when a user fills out a registration form on your website and want to track this as a conversion event in StackAdapt, you can create a rule in StackAdapt that matches the `action` key with the Segment event name.
+
+A Segment event fired with the code `analytics.track("User Registered")` can be tracked as a conversion event with an event rule that matches an `action` of `User Registered` as shown below:
+
+
+
+#### Ecommerce events
+
+The StackAdapt destination also supports forwarding ecommerce fields for the purpose of creating event rules that match ecommerce events, with default mappings to properties specified in the [Segment V2 Ecommerce Event Spec](/docs/connections/spec/ecommerce/v2/) as described in the below table:
+
+| Segment Ecommerce Event Property | StackAdapt Event Key |
+|----------------------------------|----------------------|
+| `order_id` | `order_id` |
+| `revenue` | `revenue` |
+| `product_id` | `product_id` |
+| `category` | `product_category` |
+| `name` | `product_name` |
+| `price` | `product_price` |
+| `quantity` | `product_quantity` |
+
+For events that can involve multiple products, such as checkout events, StackAdapt forwards a JSON array of product objects with a `products` key and fields that map by default to following Segment product array fields:
+
+| Segment Ecommerce Event Property | StackAdapt Product Object Key |
+|----------------------------------|-------------------------------|
+| `products.$.product_id` | `product_id` |
+| `products.$.category` | `product_category` |
+| `products.$.name` | `product_name` |
+| `products.$.price` | `product_price` |
+| `products.$.quantity` | `product_quantity` |
+
+For example, to create a conversion event when an order is completed with a revenue value greater than 10, you could set up an event rule matching an `action` value of `Order Completed` and a `revenue` value greater than 10 as shown below:
+
+
+
+This rule would match a Segment event fired with code such as:
+
+```javascript
+analytics.track('Order Completed', {
+ order_id: '50314b8e9bcf000000000000',
+ revenue: 11.5
+ products: [
+ {
+ product_id: '507f1f77bcf86cd799439011',
+ name: 'Monopoly: 3rd Edition',
+ price: 11.5,
+ quantity: 1,
+ category: 'Games'
+ }
+ ]
+});
+```
+
+#### Trait Fields
+
+Although trait fields are not frequently used in event rules, the StackAdapt destination forwards them and they can be used if desired.
+
+| Segment Trait Property | StackAdapt Event Key |
+|------------------------|----------------------|
+| `traits.email` | `email` |
+| `traits.first_name` | `first_name` |
+| `traits.last_name` | `last_name` |
+| `traits.phone` | `phone` |
+
+For example, to create a conversion event when a user with the domain `example.com` completes an order, you could set up an event rule matching an `action` value of `Order Completed` and an `email` containing `@example.com` as shown below:
+
+
+
+This rule would match a Segment event fired with code such as:
+
+```javascript
+analytics.track('Order Completed', {
+ order_id: '50314b8e9bcf000000000000',
+ traits: {
+ email: 'john.smith@example.com',
+ first_name: 'John',
+ last_name: 'Smith',
+ phone: '+180055501000'
+ }
+});
+```
+
+### URL rules
+
+If you are using URL rules, these will be matched whenever Segment sends an event to StackAdapt with a `url` matching the URL rule. This should be accomplished by the page event Segment automatically fires when a page is viewed, so setup of URL rules should be identical to setting up URL rules with the StackAdapt pixel.
+
+### Conversion Tracking with Backend Events
+
+When you send events to Segment from your backend, which are forwarded to StackAdapt using Segment's backend SDKs, the user agent and IP address of the user who originated the event must be included in the event context for conversions to be tracked. StackAdapt uses the user agent and IP address to attribute the conversion to the correct event to a user who has interacted with your ads. Examples of how to do this can be found in the documentation for Segment's SDKs. For example, for the [Python SDK](/docs/connections/sources/catalog/libraries/server/python/#override-context-value) this can be done as follows:
+
+```python
+analytics.track('user_id', 'Order Completed', context={
+ 'ip': '203.0.113.1',
+ 'userAgent': 'Mozilla/5.0 (Linux; U; Android 4.1.1; en-gb; Build/KLP) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Safari/534.30'
+})
+```
+
+This is necessary when using backend SDKs but not for events sent from the frontend with `analytics.js`, because `analytics.js` automatically includes the user-agent and IP address in the event context.
+
+### Conversion Tracking with Reverse ETL
+
+When sending past events to StackAdapt using a Reverse ETL tool, the user agent, IP address, event type, and either the page URL (for conversion trackers with URL rules), or the fields the event rules match on, must be included in your mappings. For example, the below mapping for a Snowflake source can be used to match a conversion tracker with an event rule that matches an `action` of `User Registered`:
+
+
+
+Rows forwarded to StackAdapt with this mapping will be matched by the `User Registered` event rule shown below:
+
+
+
+When forwarding past events using Reverse ETL, only users who have interacted with an ad from an associated campaign within the conversion tracker's configured view-through expiry window (for impressions) or click-through expiry window (for clicks) will count as conversions. These windows can be set to up to 180 days in the conversion tracker configuration.
+
+{% include components/actions-fields.html %}
+
+## Data and privacy
+
+Review [StackAdapt's Data Processing Agreement](https://www.stackadapt.com/data-processing-agreement){:target="_blank"} to learn more about StackAdapt's privacy and data terms.
diff --git a/src/connections/destinations/catalog/actions-surveysparrow/index.md b/src/connections/destinations/catalog/actions-surveysparrow/index.md
new file mode 100644
index 0000000000..73f2ca53c4
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-surveysparrow/index.md
@@ -0,0 +1,22 @@
+---
+title: SurveySparrow (Actions) Destination
+hidden: true
+beta: true
+---
+{% include content/plan-grid.md name="actions" %}
+
+[SurveySparrow](https://surveysparrow.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is an end-to-end omnichannel experience management platform that bundles Customer Experience and Employee Experience tools such as NPS, Offline, Chat, Classic, and 360 Surveys which are mobile-first, highly engaging, and user-friendly.
+
+This destination is maintained by SurveySparrow. For any issues with the destination, [contact their Support team](mailto:support@surveysparrow.com).
+
+## Getting started
+
+1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for "SurveySparrow"
+2. Select SurveySparrow and click **Add Destination**
+3. Select an existing Source to connect to SurveySparrow (Actions).
+4. Log in to your [SurveySparrow](https://app.surveysparrow.com/) account, then navigate to **Settings > Apps and Integrations > Create a Custom app**.
+5. Fill in the details for the custom app and choose **Select all** under Scope. Later, you can remove any scopes that are not required.
+6. Click **Save** and copy the **Access Token**.
+7. Enter the **Access Token** in the SurveySparrow destination settings in Segment.
+
+{% include components/actions-fields.html %}
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-survicate/index.md b/src/connections/destinations/catalog/actions-survicate/index.md
new file mode 100644
index 0000000000..3ccd0f53e6
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-survicate/index.md
@@ -0,0 +1,132 @@
+---
+rewrite: true
+title: Survicate (Actions) Destination
+id: 65a6ac19ea6d3ced628be00b
+---
+[Survicate](https://survicate.com/integrations/segment-survey/?utm_source=segment&utm_medium=referral){:target="_blank”} is a complete toolkit for customer feedback.
+
+This destination is maintained by Survicate. For any issues with the destination, [contact the Survicate Support team](mailto:help@survicate.com).
+
+
+## Getting Started
+
+1. From the Segment web app, click **Destinations**.
+2. Search for "Survicate (Actions)" in the Catalog, select it, and choose which of your sources to connect the destination to.
+3. Enter the "Workspace Key" into your Segment Settings UI which you can find from your [Survicate Workspace Settings](https://panel.survicate.com/o/0/w/0/settings/web-surveys){:target="_blank"}.
+{% include components/actions-fields.html %}
+## Identify
+
+If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
+
+```
+analytics.identify('userId123', {
+ email: 'john.doe@example.com',
+ jobTitle: 'CEO',
+ companySize: '50'
+});
+```
+
+When you call Identify, we pass Segment traits as respondents' attributes to Survicate. They can be used to trigger web surveys or filter survey results.
+
+All traits passed in Identify calls will be available in Survicate - once you view a respondent profile or export survey data.
+
+All `camelCase` attribute keys are translated to `snake_case`.
+
+All *object attributes* will be flattened to attributes prefixed by object key. All *array attributes* will be omitted.
+
+```
+analytics.identify('1234', {
+ address: {
+ street: '6th St',
+ city: 'San Francisco',
+ state: 'CA',
+ postalCode: '94103',
+ country: 'USA'
+ },
+ categories: ['startup','SaaS']
+});
+```
+
+The above described call creates following respondent's traits in Survicate:
+
+| key | value |
+| ------------------- | ------------- |
+| id | 1234 |
+| address_street | 6th St |
+| address_city | San Francisco |
+| address_state | CA |
+| address_postal_code | 94103 |
+| address_country | USA |
+
+*Categories* attribute is omitted as it is an array attribute.
+
+## Group
+
+If you're not familiar with the Segment Specs, take a look to understand what the [Group method](/docs/connections/spec/group/) does. An example call would look like:
+
+```
+analytics.group('group123', {
+ name: 'Company Inc.'
+});
+```
+
+All Group traits will be passed to respondent attributes with `group_` prefix. All `camelCase` attribute keys are translated to `snake_case`. All *object attributes* will be flattened to attributes prefixed by object key. All *array attributes* will be omitted.
+
+```
+analytics.group('group123', {
+ name: 'Company Inc.',
+ address: {
+ street: '6th St',
+ city: 'San Francisco',
+ state: 'CA',
+ postalCode: '94103',
+ country: 'USA'
+ },
+ categories: ['startup','SaaS']
+});
+```
+
+The above described call creates the following respondent's traits in Survicate:
+
+| key | value |
+| ------------------------- | ------------- |
+| group_id | group123 |
+| group_name | Company Inc. |
+| group_address_street | 6th St |
+| group_address_city | San Francisco |
+| group_address_state | CA |
+| group_address_postal_code | 94103 |
+| group_address_country | USA |
+
+*Categories* attribute is omitted as it is an array attribute.
+
+## Track
+
+A Segment track call, f.ex:
+```
+analytics.track('plan_purchased', {
+ plan: 'Pro Annual',
+ accountType : 'Facebook'
+});
+```
+
+will trigger a Survicate call that sends the event name and properties to Survicate.
+
+If you want to trigger your survey on a Segment event, you are able to do that by setting that condition in the panel in the targeting tab in the section: "When a user triggers an event" under "Where would you like to show the survey".
+
+When the Segment event fires and other targeting conditions you've set in the panel are met - your survey will show.
+
+Event properties are optional.
+
+### Sending survey answers to Segment
+
+Once the Segment integration is enabled in Survicate Integrations tab, it starts sending track events from your client-side source. Here's a sample call that will be triggered when a survey is answered.
+
+```
+analytics.track('survicate_survey_answered', {
+ answer: 'Great suppport!',
+ answer_type: 'text',
+ question: 'What makes us stand out from the competition?',
+ survey: 'Advantages Over Competition Research',
+});
+```
diff --git a/src/connections/destinations/catalog/actions-the-trade-desk-crm/index.md b/src/connections/destinations/catalog/actions-the-trade-desk-crm/index.md
new file mode 100644
index 0000000000..dbdd3db628
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-the-trade-desk-crm/index.md
@@ -0,0 +1,67 @@
+---
+title: The Trade Desk CRM Destination
+hide-personas-partial: true
+hide-boilerplate: true
+hide-dossier: false
+beta: true
+id: 6440068936c4fb9f699b0645
+redirect_from: "/connections/destinations/catalog/the-trade-desk-crm/"
+---
+
+[The Trade Desk](https://www.thetradedesk.com/us){:target="_blank"} empowers companies and their partners to leverage data in their expansive data marketplace, facilitating seamless discovery, creation, and engagement with valuable audiences. Segment's integration with The Trade Desk allows you to push first-party user data from audiences created in [Twilio Engage](https://www.twilio.com/en-us/engage){:target="_blank"} to The Trade Desk platform, enhancing targeted reach to brand's first-party audiences.
+
+This integration lets users link Engage audiences to The Trade Desk and transmit Personally Identifiable Information (PII), including email addresses and hashed emails. Users have the flexibility to configure their delivery preferences within Segment.
+
+The Trade Desk destination can only be connected to Twilio Engage sources.
+
+## Getting started
+
+### Obtaining credentials from The Trade Desk
+
+> info ""
+> Contact your The Trade Desk account manager to sign the UID POC contract before you activate audiences on The Trade Desk. Afterwards, The Trade Desk will grant permission and share your advertiser ID and secret key for configuring your destination.
+
+Before you begin, generate a [long-lived token](https://partner.thetradedesk.com/v3/portal/api/doc/Authentication#ui-method-create){:target="_blank"} on [The Trade Desk's Developer Portal](https://api.thetradedesk.com/v3/tokens){:target="_blank"}.
+
+### Connecting The Trade Desk CRM
+
+1. Go to the Segment web app and navigate to **Engage > Audiences**. Ensure you are in the Engage space you intend to use with The Trade Desk. Choose an existing Engage Audience or create a new one. This is the audience you plan to send to The Trade Desk.
+2. Access **Engage > Engage Settings** and click on **Destinations**. Confirm that you are in the correct Engage space.
+3. Search for **The Trade Desk CRM** and select the destination.
+4. Click on **Configure The Trade Desk CRM**.
+5. On the **Select Source** screen, your Engage space should already be selected as the source. Click on **Confirm Source**.
+6. Generate a [long-lived token](https://partner.thetradedesk.com/v3/portal/api/doc/Authentication#ui-method-create){:target="_blank"} on [The Trade Desk's Developer Portal](https://auth.thetradedesk.com/Account/Login?ReturnUrl=%2Fconnect%2Fauthorize%2Fcallback%3Fclient_id%3Dttd-dev-portal%26redirect_uri%3Dhttps%253A%252F%252Fpartner.thetradedesk.com%252Fv3%252Fsignin-oidc%26response_type%3Dcode%26scope%3Dopenid%2520profile%2520email%2520ttdui_refresh%2520offline_access%2520applications%26code_challenge%3DG5xIiN4NLQYS_L9kqCGZyWg678USH1pV6D2Iqu1e1Q8%26code_challenge_method%3DS256%26response_mode%3Dform_post%26nonce%3D638441362885322803.NWFjOTk2NTMtMzkyOS00NmJmLWE3N2YtODZlYzZjNGQxZWQ1M2E3OGI1ZmUtOThmNC00MDA5LWFiNzQtZmZiZGI2OTUzMzMy%26state%3DCfDJ8BBsgv10-z9IvE3EffVp_QCSKM7pxVdw3rv-shU-_OG4utdVslWzvw8nfZ0D8TKi75uKGCMPp2hiM-IBxjjwToGR-ryK13SXlVMOGMxXj_FUEV8nQfnRR1oQN6YZED0-48NhERsQr96xbaz6a_pVR_z5OZWgQ6RR9MBMUkHYF5tFp651wtbno-7ES1-zsje7hCqzFMTAVV_qAoNur-f8MGkMdw7oSAOQmoYOW4zV2w6SIMLSIOkUvariDC9EAAVPYTjonQdieo2V0rYscC-aVG6U8ASV3yqJc6RmnGRUEVnKHPt-ZZcvy9PHA2-Et04QlGwz6b-buRbNXd3v1E6zuMC5F7dxcT3otr5TQ4yMuC1JA5VRxT4c1tFON2lY4jtxKuyQIQs5N3a59eFc1wGdUSo%26x-client-SKU%3DID_NETSTANDARD2_0%26x-client-ver%3D6.10.0.0){:target="_blank"}.
+7. After authenticating, enter your Authentication Token and Advertiser ID from your [The Trade Desk's CRM Data Platform API](https://api.thetradedesk.com/v3/portal/data/doc/DataIntegrateCRMData){:target="_blank"} account. Enable the destination by toggling **Enable Destination** and click **Save Changes**.
+8. Navigate to the **Mappings** tab, click **New Mapping**, and choose **Sync Audience to CRM Data Segment**.
+9. In the **Select mappings** section, input the PII Type and maintain other defaults. Click **Save** and toggle to enable the mapping.
+ - **Create only one mapping for every instance.**
+ - If any of the emails stored in your Engage audience are already in a hashed format, please specify the PII type as `Hashed Email.` Failure to do so results in The Trade Desk categorizing the hashed records as invalid during the ingestion process.
+10. Return to **Engage > Audiences** and select the audience from Step 1.
+11. Click **Add Destinations** and choose The Trade Desk CRM destination you just created. In the settings that appear in the side panel, enable the **Send Track** option and **do not** alter the Audience Entered/Audience Exited event names. Fill out the audience settings, specifically the region field, with the geographical region of the CRM data segment based on the origin of the PII (US, EU, or APAC). Click **Save Settings**.
+
+Setup is now complete, and the audience starts syncing to The Trade Desk.
+
+To sync additional Audiences from your Engage space, create a separate instance of The Trade Desk CRM Destination.
+
+{% include components/actions-fields.html settings="true"%}
+
+
+## Limitations
+
+* An audience must have at least 1500 unique members; otherwise, the destination fails, and the data won't sync.
+* Audience attempts to sync once per day.
+* Audience sync is a full sync.
+
+## FAQs
+
+#### How is the CRM Segment Created?
+
+When connecting your audience from your Engage source to an enabled TTD destination, there's no need to manually create CRM Segments. Segment automatically generates a CRM Segment in your TTD account, mirroring the name of the audience linked to the TTD instance.
+
+#### How does TTD handle emails that don't already exist?
+
+The CRM endpoint maps email addresses into UID2s. If it's a valid email address, TTD generates a UID2 for it. However, if there are no bid requests coming in from the SSP with the specific UID2, then the ID would exist in the segment until it hits the TTL and won't be used when purchasing an impression.
+
+#### What PII format should I send?
+
+The Trade Desk recommends transmitting personally identifiable information (PII) in its original, non-hashed format. TTD's preference is to handle the hashing of any PII, like emails, on their end. However, if your data already contains any hashed emails, please ensure you are normalizing and hashing the emails by designating the PII type as `Hashed Email`, in line with TTD's [PII Normalization and Hash Encoding](https://api.thetradedesk.com/v3/portal/data/doc/DataPiiNormalization){:target="_blank”} documentation.
diff --git a/src/connections/destinations/catalog/actions-tiktok-audiences/index.md b/src/connections/destinations/catalog/actions-tiktok-audiences/index.md
index 28e9fcd3d7..45ba7c9e69 100644
--- a/src/connections/destinations/catalog/actions-tiktok-audiences/index.md
+++ b/src/connections/destinations/catalog/actions-tiktok-audiences/index.md
@@ -4,25 +4,59 @@ id: 63d2e550fb90f1632ed8820a
hide-personas-partial: true
hide-boilerplate: true
hide-dossier: false
-hidden: true
---
-The TikTok Audiences destination enables advertisers to send Engage audiences to TikTok as Custom Audiences using [TikTok's Segment API](https://ads.tiktok.com/marketing_api/docs?id=1739940504185857){:target="_blank"}.
+The TikTok Audiences destination enables advertisers to send Twilio Engage audiences to TikTok as custom audiences using [TikTok's Audience API](https://business-api.tiktok.com/portal/docs?id=1739940504185857){:target="_blank"}.
By using Segment's TikTok Audiences destination, you can increase traffic and drive conversions with hyper-relevant ads that promote product discovery.
-> info ""
-> The TikTok Audiences destination is in beta and is in active development. Some functionality may change before it becomes generally available.
-
## Getting started
+### Notes
+
+- If you created a TikTok Audiences destination instance before September 25th, 2023, your instance(s) and all subsequent instances are considered _legacy_ instances. To create a new _legacy_ instance, see the [Create a TikTok audience (Legacy)](#create-a-tiktok-audience-legacy){:target="_blank"} documentation. Users who created their first instance after September 25, 2023 are considered to have _native_ instances. To create a new _native_ instance, see [Configure the TikTok Audiences destination](#configure-the-tiktok-audiences-destination){:target="_blank"} documentation.
+- Both _legacy_ and _native_ instances have the same set of features, but are configured differently. Legacy instances require you to create an audience or action manually, but native instances automatically create audiences and actions.
+- If you update the events names from the default Audience Entered/Audience Exited, please make sure to also update it in the "Add to Audience" and "Remove from Audience" mappings.
+- TikTok [requires](https://business-api.tiktok.com/portal/docs?id=1739940585975809){:target="_blank"} `phone` number to be formatted in E.164 form, e.g. `+1231234567`. If your phone number is missing country code, you can prepend `+1` in the Action Mapping.
+- For more information about how to update from _legacy_ to _native_, reach out to [friends@segment.com](mailto:friends@segment.com).
+
### Prerequisites
-1. Before connecting to the TikTok Audiences destination, you must have a [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account.
+Before connecting to the TikTok Audiences destination, you must have a [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account.
+
+### TikTok Audience Segments
+
+Send Engage audiences to an existing TikTok audience segment or create a new audience. Note the `audience_id` as this is required to send Engage audiences to TikTok.
+
+### Configure the TikTok Audiences destination
+
+1. From the Segment web app, navigate to **Engage > Audiences**. Choose an existing Engage audience or create a new one. Ensure you are in the Engage space you plan to use with the TikTok Audiences destination.
+
+2. Navigate to **Engage > Engage Settings** and click **Destinations**.
+
+3. Search for “TikTok Audiences” and select the destination. Click **Configure TikTok Audiences**.
+
+4. On the Select Source screen, your Engage space should already be selected as the source. Click **Confirm Source**.
+
+5. On the **Settings** tab for the TikTok Audiences destination, name your destination and authenticate with TikTok Audiences using OAuth.
+
+6. Once authenticated, toggle “Enable Destination” on and click **Save Changes**.
+
+7. Navigate to the **Mappings** tab, click **New Mapping**, and select **Add to Audience**.
-2. You must also have an audience segment created in your TikTok Advertising account. You can send Engage audiences to an existing audience segment, or you can create a new audience in TikTok. Please take note of the `audience_id` as this will be required to send Engage audiences to TikTok. See TikTok's [Create/Delete an audience segment](https://ads.tiktok.com/marketing_api/docs?id=1739940583739393){:target="_blank"} for instructions on how to create a TikTok audience segment.
+8. Navigate to the **Mappings** tab, click **New Mapping**, and select **Remove from Audience**.
-### Connect the TikTok Audiences destination
+9. Navigate back to **Engage > Audiences** and click on the audience from step 1.
+
+10. Click **Add Destinations** and select the TikTok Audiences destination you just created.
+ In the settings that appear in the side panel, toggle the **Send Track** option on and **Send Identify** option off. Provide the [Advertiser ID](https://ads.tiktok.com/help/article/ad-account-information-faq?lang=en){:target="_blank"} linked to the TikTok account that will receive the audience data, as well as the **ID Type** of data you'll be sending. Click **Save Settings**.
+
+The setup is complete and the audience will start syncing to TikTok. The audience will appear in your [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account under **Assets > Audiences**. Please note that it can take 24-48 hours for users to appear in TikTok.
+
+### Connect the TikTok Audiences (_Legacy_) destination
+
+> info ""
+> Add User and Remove User are considered legacy actions.
1. From the Segment web app, navigate to **Engage > Audiences**. Ensure you are in the Engage space you plan to use with the TikTok Audiences destination. Either choose an existing Engage audience or create a new one. This is the audience you plan to send to TikTok.
@@ -40,7 +74,9 @@ By using Segment's TikTok Audiences destination, you can increase traffic and dr
8. Under Select mappings, select the TikTok "Advertiser ID" of the audience segment you want to add users to. Input the `audience_id` of that audience segment under "Audience ID." **Note: A separate mapping must be created for each audience segment you plan to send Engage audiences to.**
-9. Repeat Steps 7 and 8 to also set up a **Remove Users** mapping.
+ **Note:** Once you've created the audience using the name of Segment's audience key, you can get the Audience ID from TikTok's Assets>Audiences page. You'll also find the Advertised ID, noted by `aadvid`, over the TikTok URL.
+
+9. Repeat steps 7 and 8 to also set up a **Remove Users** mapping.
10. Navigate back to **Engage > Audiences** and click on the audience from Step 1.
@@ -48,6 +84,29 @@ By using Segment's TikTok Audiences destination, you can increase traffic and dr
The setup is complete and the audience will start syncing to TikTok. The audience will appear in your [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account under **Assets > Audiences**. Please note that it can take 24-48 hours for users to appear in TikTok.
-To sync additional audiences from your Engage space, create a separate mapping in the TikTok Audiences destination. Navigate to **Connections > Destinations**, search and select the TikTok Audiences destination, and follow Steps 7-11 above.
+To sync additional audiences from your Engage space, create a separate mapping in the TikTok Audiences destination. Navigate to **Connections > Destinations**, search and select the TikTok Audiences destination, and follow steps 7-11 above.
+
+### Create a TikTok Audience
+
+To create an audience in Segment:
+
+1. Navigate to New Mapping and select **Create Audience**.
+2. On the Add test event panel, click **Load Sample Event**.
+3. Fill in the mappings on the Select mappings panel accordingly.
+4. On the Send test event panel, click **Test Mapping**.
+5. You've created your audience. Copy the `audience_id` from the response as you will need it to create additional mappings.
+
+You can use the same mapping to create as many audiences as you'd like. To create another audience, change the audience name and click **Test Mapping**.
+
+You can create a duplicate audience since TikTok doesn't restrict users from having multiple audiences with the same name. If you click **Test Mapping** multiple times, you will create audiences with the same name. However, each audience will have its own unique `audience_id`.
+
+You do not need to update the status of the mapping to `enabled`.
+
+For instructions on how to create a TikTok audience segment, see TikTok's [Create/Delete an audience segment](https://ads.tiktok.com/marketing_api/docs?id=1739940583739393){:target="_blank"} docs.
{% include components/actions-fields.html %}
+
+## FAQS
+
+### Why is my audience considered too small in TikTok?
+[TikTok](https://ads.tiktok.com/help/article/custom-audiences?lang=en) requires a minimum audience size of 1,000 to target Custom Audiences in an ad group.
diff --git a/src/connections/destinations/catalog/actions-tiktok-offline-conversions/index.md b/src/connections/destinations/catalog/actions-tiktok-offline-conversions/index.md
new file mode 100644
index 0000000000..6927ed4f3f
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-tiktok-offline-conversions/index.md
@@ -0,0 +1,55 @@
+---
+title: Tiktok Offline Conversions (Actions) Destination
+id: 6447ca8bfaa773a2ba0777a0
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Tiktok's Offline Events API](https://ads.tiktok.com/marketing_api/docs?id=1758049779688450){:target="_blank”} helps advertisers measure how TikTok ads result in offline customer actions, such as in-store purchases or offline subscriptions, purchases and more. Attributing online and offline events is an important step for advertisers to measure omni-channel results from their campaigns.
+
+**Benefits**
+- **Measure how TikTok ads influence offline conversions.** Learn what online strategies lead to better Brick & Mortar sales, subscription sign-ups or leads.
+- **Power holistic attribution models with cross-channel event tracking.** Combine online and offline touchpoints to get comprehensive campaign metrics, like ROAS.
+- **Reach offline customers online with custom audiences.** Promote new products or services to high-value customers who initiative offline events.
+
+
+This destination is maintained by Tiktok. For any issues with the destination, [contact their Support team](mailto:segmenteng@bytedance.com).
+
+## Getting started
+
+Prior to setting up the **TikTok Offline Conversion Destination**, please create an Offline Event Set and generate the Access Token for it from **TikTok Events Manager**.
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Find the Destinations Actions item in the left navigation, and click it.
+3. Click **Configure Tiktok Offline Conversions (Actions)**.
+4. Select an existing Source to connect to Tiktok Offline Conversions (Actions).
+5. Give Destination a name.
+6. On the Settings screen, provide Access Token and Event Set ID.
+7. Toggle on the Destination.
+8. Hit the Save Change button.
+
+**Mappings Enabled by Default**
+
+After setting up the Destination, four mappings will be enabled by default. You can click on the mappings tab to view and edit these mappings.
+
+- Complete Payment: use this to track offline purchase events
+- Subscribe: use this to track offline subscription events
+- Contact: use this to track offline contact events
+- Submit Form: use this to track offline form submissions
+
+{% include components/actions-fields.html %}
+
+## Acess Token & Event Set ID
+Please refer to the [documentation](https://ads.tiktok.com/marketing_api/docs?id=1758051319816193){:target="_blank”} to obtain the **Access Token** and the **Event Set ID**.
+
+## PII Requirement & Validation
+TikTok Offline Events API requires at least one type of PII (email addresses and/or phone numbers) to be included in all offline conversion events. The email addresses and phone numbers will be hashed using SHA 256 from Segment before they are sent to TikTok. TikTok Offline Conversions Destination will automatically hash the provided PII, so please do not hash the PIIs before sending them to Segment. In addition, TikTok Offline Conversions Destination will validate all offline events before forwarding them to TikTok Offline Events API. TikTok Offline Conversions Destination will not send any offline events to TikTok with invalid or missing PIIs.
+
+## Data and Privacy Considerations
+- Every offline event sent to TikTok Offline Events API requires at least one email address or phone number.
+- E-mails and phone numbers will be hashed in a privacy-safe way by default so that TikTok cannot identify customers who are not TikTok users.
+- iOS compliance checks will be performed on PII (ATT opt-out users will still be reported and attributed).
+- TikTok will pruge unmatched offline conversions IDs/records.
+
+
+---
diff --git a/src/connections/destinations/catalog/actions-tiktok-pixel/index.md b/src/connections/destinations/catalog/actions-tiktok-pixel/index.md
new file mode 100644
index 0000000000..5cb68cb960
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-tiktok-pixel/index.md
@@ -0,0 +1,69 @@
+---
+title: TikTok Pixel Destination
+id: 64c1690a9f08c84a420aba78
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[TikTok Pixel](https://ads.tiktok.com/marketing_api/docs?id=1739583652957185){:target="_blank"} is a piece of code that you can place on your website that allows you to share website events with TikTok. With TikTok for Business Tools, the Pixel can help you measure traffic on your website, measure ad campaign performance, optimize your campaigns and find new customers.
+
+### Benefits of TikTok Pixel
+
+Use data collected from TikTok Pixel to:
+- **Build marketing audiences**: Create custom Audiences based on website visitor events, like viewing a product page or making a purchase. Audiences can be used to re-engage previous site visitors or model lookalikes to find new customers.
+- **Optimize ad delivery**: Target Audiences that are more likely to initiate a website event by setting an optimization goal on visitor events like add to cart, view page, or purchase.
+- **Measure campaign performance**: Measure your ad performance and return on ad spend (ROAS) based on a series of conversion events you define.
+
+This destination is maintained by TikTok. For any issues with the destination, [contact TikTok's Support team](mailto:segmenteng@bytedance.com).
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Search for "TikTok Pixel" in the search bar, then click on the Destination "TikTok Pixel".
+3. Click **Add Destination**.
+4. Select an existing JavaScript Source to connect to TikTok Pixel.
+5. Give the Destination a name.
+6. On the Settings screen, provide the Pixel Code. This can be found in the TikTok Events Manager (TTEM).
+7. Toggle on the Destination using the **Enable Destination** toggle.
+8. Click **Save Change**.
+
+### Mappings enabled by default
+
+After setting up the Destination, Segment enables seven mappings by default. You can click on the mappings tab to view and edit these mappings.
+
+- **View Content**: When a page is viewed
+- **Search**: When a search is made
+- **Add to Wishlist**: When an item is added to a wishlist
+- **Add to Cart**: When an item is added to the shopping cart
+- **Initiate Checkout**: When the checkout process is started
+- **Add Payment Info**: When payment information is added in the checkout flow
+- **Place an Order**: When an order is placed
+
+{% include components/actions-fields.html %}
+
+## Getting started with Pixel and obtaining the Pixel code
+
+Please refer to the [TikTok Help Center documentation](https://ads.tiktok.com/help/article/get-started-pixel?redirected=2){:target="_blank"} to learn more about how to get started with TikTok Pixel. Once the Pixel is created, please retrieve the Pixel Code from TikTok Events Manager (TTEM).
+
+## Advanced Matching
+
+Advanced Matching helps you optimize your TikTok ads and drive performance by matching customer information with TikTok users. Hashed customer information can be shared with any TikTok event to attribute more conversions, build bigger audiences, and improve campaign optimization.
+
+There are two types of Advanced Matching: manual or automatic.
+
+**Manual Advanced Matching** is the passing of customer information to TikTok from your website. With this option, you have the flexibility to configure what information and for which event you want to pass to TikTok. This will be enabled automatically if PIIs are included in the Pixel events sent from TikTok Pixel Destination.
+
+When email and/or phone number values are sent to TikTok, TikTok will try to match users with the PII you send to TikTok. If you don't send email or phone number values, TikTok will try to match users with IP and user-agent values that are included in the Pixel event payload.
+
+**Automatic Advanced Matching** is when advertisers instruct TikTok to automatically identify form fields on pages where Pixel is installed and to hash and collect email and phone numbers entered on those pages for ad measurement and attribution purposes. Learn more about Automatic Advanced Matching and how to turn it on in [TikTok help center](https://ads.tiktok.com/help/article/advanced-matching-web?lang=en){:target="_blank"}.
+
+To maximize Advanced Matching's performance, TikTok recommends using both Manual and Automatic Advanced Matching at the same time.
+
+## PII hashing
+- TikTok hashes all values with `sha256` before processing.
+
+- Normalize phone numbers you send to TikTok with in the `E.164` format. This format is a combination of `+［country code]［phone number]`. For example: `+12133734253`.
+
+## Data and privacy
+
+Visit TikTok's [docs](https://ads.tiktok.com/i18n/official/policy/business-products-terms){:target="_blank"} to learn more about TikTok's privacy and data terms.
diff --git a/src/connections/destinations/catalog/actions-toplyne-cloud/index.md b/src/connections/destinations/catalog/actions-toplyne-cloud/index.md
index 9db1283d96..7082de33e8 100644
--- a/src/connections/destinations/catalog/actions-toplyne-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-toplyne-cloud/index.md
@@ -1,26 +1,17 @@
---
-# The end name should be similar to `Slack Destination`
title: Toplyne Cloud Mode (Actions) Destination
beta: true
hide-boilerplate: true
hide-dossier: true
-hidden: true
-private: true
id: 6408ac6c144a7d5ac55cf414
----
-
-
+private: false
+hidden: false
+---
{% include content/plan-grid.md name="actions" %}
[Toplyne](https://www.toplyne.io/){:target="_blank"} is a headless Sales AI for revenue teams. Toplyne's AI captures and understands every user click passed through Segment and enriches it with demographic data (through 3rd party enrichment tools). Toplyne then delivers opportunities for expansion and conversion into your existing CRM. Toplyne does this without involving your data and engineering teams. Cloudflare, Vercel, and Canva depend on Toplyne to build predictable pipelines and improve conversions and expansions for their sales and account management teams.
-
-
-{% include content/ajs-upgrade.md %}
-
-
-
## Benefits of Toplyne (Actions)
Toplyne (Actions) provides the following benefits:
@@ -29,7 +20,7 @@ Toplyne (Actions) provides the following benefits:
- **Clear mapping of data** Actions-based destinations enable you to define the mapping between the data Segment received from your source and the data Segment sends to Toplyne.
- **Pre-built mapping.** Mappings for Toplyne, are prebuilt with the prescribed parameters and available for customization
- **No 3rd party tool is involved.** Move the data directly from Segment to Toplyne without the requirement of a 3rd party tool to facilitate the data sync.
-
+
## Getting started
@@ -43,9 +34,6 @@ Toplyne (Actions) provides the following benefits:
8. Copy the access token that has just been generated. This will be the API key that you will enter in Segment.
9. Save your changes and enable the destination.
-
- {% include components/actions-fields.html %}
-
+
+{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-upollo/index.md b/src/connections/destinations/catalog/actions-upollo/index.md
index 7709441ef4..20bbe96329 100644
--- a/src/connections/destinations/catalog/actions-upollo/index.md
+++ b/src/connections/destinations/catalog/actions-upollo/index.md
@@ -5,10 +5,11 @@ id: 640267d74c13708d74062dcd
{% include content/plan-grid.md name="actions" %}
-[Upollo](https://upollo.ai?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} finds and converts repeat trialers, account sharers and more.
+[Upollo](https://upollo.ai?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} gives unique and actionable insights that lead to conversion, retention and expansion.
-11% of users signing up for free trials have [already had a free trial](https://upollo.ai/blog/turn-repeated-trials-into-growth?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"}, and up to 45% of users [share their logins](https://upollo.ai/blog/grow-by-understanding-account-sharing?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} with others.
-Inviting these users to a paid account is the top underutilized growth channel for SaaS businesses.
+Understand who your users truly are, if they are ready to convert, churn or expand and why they are ready. Upollo provices unique insights from users who are ready to convert because they have [already had a free trial](https://upollo.ai/blog/turn-repeated-trials-into-growth?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"}, a company ripe for a team wide roll out because they [share logins](https://upollo.ai/blog/grow-by-understanding-account-sharing?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} or finding high intent companies [hidden behind public emails](https://upollo.ai/blog/hidden-goldmine-public-emails){:target="_blank”}.
+
+Upollo also enriches your identify data with firmopgrahic data so you can understand your users in Upollo or in your data warehouse. See company name, size and industry for your users as soon as they sign in, for free at unlimited scale.
Upollo maintains this destination. For any questions or issues with the destination, please [contact the Upollo team](https://upollo.ai/contact?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"}.
@@ -16,13 +17,12 @@ Upollo maintains this destination. For any questions or issues with the destinat
Upollo (Actions) provides the following benefits:
-- **Find hidden growth opportunities**. Quickly see how many users are repeating free trials or sharing their account.
+- **Find hidden growth opportunities**. Quickly see opportunities to convert, retain and expand.
- **More happy paying customers**. Upgrade these users onto a paying plan and get more happy paying users.
## Getting Started
-
-1. From the Segment web app, navigate to **Connections > Catalog**, and select the **Destinations** tab.
+1. From the Segment web app, navigate to **Connections > Catalog**, and select the **Destinations** tab.
2. Select **Destinations Actions** under **Categories** in the left navigation.
3. Search for **Upollo (Actions)** and click **Configure Upollo**.
4. Select an existing Source to connect to Upollo (Actions).
@@ -31,15 +31,15 @@ Upollo (Actions) provides the following benefits:
## Identify
-Upollo uses the `identify` call to analyze users on your platform. If the same person is using multiple accounts or if different people are sharing an account, they are flagged and shown in the Upollo dashboard.
-
+Upollo uses the `identify` call to analyze users on your platform. Our unique insights shown in the Upollo dashboard and optionally enriched data is added to identify events.
The `identify` call provides any available information about the user.
+
```js
-analytics.identify('userId123', {
- email: 'john.doe@example.com',
- name: 'John Doe',
- phone: '+123456789'
+analytics.identify("userId123", {
+ email: "john.doe@example.com",
+ name: "John Doe",
+ phone: "+123456789",
});
```
diff --git a/src/connections/destinations/catalog/actions-usermotion/index.md b/src/connections/destinations/catalog/actions-usermotion/index.md
new file mode 100644
index 0000000000..53d884712a
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-usermotion/index.md
@@ -0,0 +1,22 @@
+---
+title: UserMotion (Actions) Destination
+id: 6537b5da8f27fd20713a5ba8
+beta: true
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[UserMotion](https://usermotion.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="\_blank”} is AI-powered predictive lead scoring software that discovers intention signals and scores leads on potential to buy, expand, or churn.
+
+This destination is maintained by UserMotion. For any issues with the destination, [contact their Support team](mailto:support@usermotion.com).
+
+## Getting started
+
+1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="\_blank”} search for "UserMotion (Actions)".
+2. Select UserMotion (Actions) and click **Add Destination**.
+3. Select an existing Source to connect to UserMotion (Actions).
+4. Go to the [UserMotion dashboard](https://app.usermotion.com/?returnPath=/settings/integrations?provider=api){:target="\_blank"}, find and copy the **API key**.
+5. Enter the **API Key** in the UserMotion destination settings in Segment.
+6. Save your changes and enable the destination.
+
+{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-vwo-cloud/index.md b/src/connections/destinations/catalog/actions-vwo-cloud/index.md
index 0c5e1f06e4..837a8a3e26 100644
--- a/src/connections/destinations/catalog/actions-vwo-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-vwo-cloud/index.md
@@ -10,10 +10,10 @@ versions:
{% include content/plan-grid.md name="actions" %}
-[VWO](https://vwo.com/) is an optimization platform that allows websites to run experiments on their platforms to derive insights from visitor behavior and harness the results to amp up the conversion rate. Apart from experimentation, it also provides for personalization of the platform for different cohorts, full stack implementation, and direct deployment of the changes determined through experimentation.
+[VWO](https://vwo.com/){:target="_blank"} is an optimization platform that allows websites to run experiments on their platforms to derive insights from visitor behavior and harness the results to amp up the conversion rate. Apart from experimentation, it also provides for personalization of the platform for different cohorts, full stack implementation, and direct deployment of the changes determined through experimentation.
> info ""
-> The events and attributes that are transferred from Segment to your VWO account will appear under [Unregistered Events](https://help.vwo.com/hc/en-us/articles/8676443712537-Working-with-Events-in-VWO#:~:text=UNREGISTERED%20EVENTS%3A%20These%20are%20the,UNREGISTERED%20EVENTS.){:target="_blank"} and [Unregistered Attributes](https://help.vwo.com/hc/en-us/articles/8681465703705-Working-with-Attributes-in-VWO#:~:text=UNREGISTERED%20ATTRIBUTES%3A%20These%20are%20the,UNREGISTERED%20ATTRIBUTES.){:target="_blank"} sections, respectively. You need to save these events and attributes to VWO for further use.
+> The events and attributes that are transferred from Segment to your VWO account will appear under [UNREGISTERED EVENTS](https://help.vwo.com/hc/en-us/articles/8676443712537-Working-with-Events-in-VWO#:~:text=UNREGISTERED%20EVENTS%3A%20These%20are%20the,UNREGISTERED%20EVENTS.){:target="_blank"} and [UNREGISTERED ATTRIBUTES](https://help.vwo.com/hc/en-us/articles/8681465703705-Working-with-Attributes-in-VWO#:~:text=UNREGISTERED%20ATTRIBUTES%3A%20These%20are%20the,UNREGISTERED%20ATTRIBUTES.){:target="_blank"} sections, respectively. You need to save these events and attributes to VWO for further use.
## Benefits of VWO Cloud Mode(Actions) vs VWO Classic
@@ -32,6 +32,172 @@ VWO Cloud Mode (Actions) provides the following benefits over the classic VWO de
6. To customize the mapping of actions, follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). Mappings in Segment allow you to control the events and attributes that are sent to VWO.
7. Enable the destination using the toggle switch.
+> info ""
+> VWO requires you to include a `vwo_uuid` key for all calls made in cloud-mode. The value of this key must be the VWO UUID(in the case of a website) or the User ID (in the case of FullStack). Track and Page calls require the `vwo_uuid` in the *properties* object. For Identify calls, you can place `vwo_uuid` in the *traits* object.
+
+## Using VWO Cloud mode destination with Web
+
+> info ""
+> VWO recommends using the [VWO Web Mode destination](/docs/connections/destinations/catalog/actions-vwo-web/) for web pages as it requires minimal to no additional setup.
+
+1. Install the VWO SmartCode on your website following VWO's guide [Configuring SmartCode for Your Website](https://help.vwo.com/hc/en-us/articles/360019422834-Configuring-SmartCode-for-Your-Website){:target="_blank"}
+2. Create a VWO campaign on your website.
+3. When a visitor lands on your website VWO generates a `_vwo_uuid` cookie that acts as a unique identifier for the visitor. To learn more about the VWO UUID, see VWO's article [How to locate your VWO UUID](https://help.vwo.com/hc/en-us/articles/360034891513-How-to-Locate-your-VWO-UUID-){:target="_blank"}.
+4. Pass the value of the `_vwo_uuid` cookie with every call to Segment in the `vwo_uuid` key. Track and Page calls require the `vwo_uuid` in the *properties* object. For Identify calls, you can place `vwo_uuid` in the *traits* object.
To automate this step, you can use [Segment Analytics.js middleware](/docs/connections/sources/catalog/libraries/website/javascript/middleware/) and use the following script on your website. This script fetches the VWO UUID from the cookie and adds it to the segment payload so that you don’t have to do the same manually.
+
+```html
+
+```
+
+All the events triggered in Segment will be available under **UNREGISTERED EVENTS** in the **Data360 > Events** section in VWO. For more information about Events in VWO Data360, see VWO's article [Working with Events in VWO](https://help.vwo.com/hc/en-us/articles/8676443712537-Working-with-Events-in-VWO){:target="_blank"}.
+
+## Using VWO Cloud mode destination with VWO FullStack
+
+To use the VWO Cloud mode destination with the VWO FullStack suite, link your VWO FullStack environment with Segment using the environment’s SDK key. After that's done, integrate your VWO account with Segment.
+
+To link your VWO FullStack environment with Segment:
+
+1. From your VWO dashboard, navigate to the nav bar on the left > **FullStack > Projects** and select the appropriate project.
+2. Under the **Environments** section, click the **Copy** button corresponding to the environment that you want to link to Segment.
+3. In the **VWO SDK Key** field in the destination settings in Segment, paste the copied SDK key from the previous step.
+4. Click **Save Changes**.
+
+To integrate Segment with VWO FullStack:
+
+1. Initialize VWO FullStack SDK. Follow the steps for your server in VWO's [Quick Start Guide](https://developers.vwo.com/docs/quick-start-guide){:target="_blank"}.
+2. To track visitors in VWO, provide the user IDs of the visitors, which were used to track them in the VWO FullStack campaign. Pass that same User ID as `vwo_uuid` with all calls to Segment. Track and Page calls require the `vwo_uuid` in the *properties* object. For Identify calls, you can place `vwo_uuid` in the *traits* object..
+3. All the events triggered in Segment will be available under **UNREGISTERED EVENTS** section which can be accessed by navigating from the left navbar > **Data360 > Events**.
+
+## Using VWO Cloud mode destination with audiences in VWO
+
+By adding the VWO Cloud mode destination to your Segment audiences, you can export audiences to your VWO account to target your campaigns in VWO. To achieve this, perform the following steps:
+
+1. Navigate to **Engage > Engage Settings**, and click **Destinations**.
+- Ensure that you're in the Engage space you plan to use for VWO.
+2. Click **Add Destination**.
+3. Search for “VWO Cloud Mode (Actions)” and select the destination. Click **Add Destination**.
+4. On the **Select Source** screen, you'll see your Engage space selected as the source. Click **Confirm Source**.
+5. Select the VWO Cloud mode destination that you’ve created and navigate to the **Settings** tab. Name your destination and enter your **VWO Account ID**. Toggle **Enable Destination** on and click **Save Changes**.
+- You'll find your VWO account ID at the top of the VWO dashboard.
+6. Navigate to the **Mappings** tab and click **New Mapping**. Under **PRE-BUILT MAPPINGS**, select **Sync Audience**, then click **Save**.
+7. The **STATUS** of the mapping displays as disabled by default. Enable the mapping using the toggle.
+8. Navigate to **Engage > Audiences**. Choose an existing Engage audience or create a new one to export to VWO.
+9. Click **Add Destination** and select the VWO Cloud Mode destination you created. From the **Connection Settings** screen, toggle the Send Track option on. Be sure you don't change the **Audience Entered/Audience Exited** event names. Click **Save**.
+
+> success ""
+> After you set up your destination, you can repeat steps eight and nine to sync any subsequent audiences.
+
+Visit [Using Data From Segment](https://help.vwo.com/hc/en-us/articles/16147461611161){:target="_blank"} for more on how to configure audiences in VWO.
+
+## Supported Segment Calls in VWO
+
+VWO Supports the following calls, as specified in the [Segment Spec](/docs/connections/spec/).
+
+### Track
+The [Track](/docs/connections/spec/track/) call records any actions your visitors perform, along with any properties that describe the action. Each action is known as an event.
+
+The destination forwards these events to VWO Data360 where they can be seen under the **UNREGISTERED EVENTS** section in **Data360 > Events** in VWO. These events can be registered and used as [Metrics](https://help.vwo.com/hc/en-us/articles/8675547113625-Working-with-Metrics-in-VWO){:target="_blank"} in VWO.
+
+**Sample payload for Track Call to the destination**
+
+```js
+analytics.track("Segment Test Event", {
+ "vwo_uuid": "",
+ "property1": "value1"
+});
+```
+
+**Corresponding JavaScript event that would generate the above payload**
+
+```js
+{
+ "type": "track",
+ "event": "",
+ "properties": {
+ "vwo_uuid": "",
+ "property1": "value1"
+ }
+}
+```
+
+> info ""
+> Event names are prepended with `segment.` before they're sent to VWO. If an event named "**ctaClick**" is triggered in Segment, it appears as `segment.ctaClick` under **UNREGISTERED EVENTS** in VWO.
+
+### Identify
+The [Identify](/docs/connections/spec/identify/) call associates a visitor with their actions and captures their traits.
+
+The destination forwards these traits to VWO Data360 where they can be seen under the **UNREGISTERED ATTRIBUTES** section in the **Data360 > Attributes** in VWO. These attributes can be registered and used to create [segments in VWO](https://help.vwo.com/hc/en-us/articles/8976459309465-Working-with-Segments-in-VWO-Data360){:target="_blank"}. For more information about Attributes in VWO Data360, see [Working with Attributes in VWO](https://help.vwo.com/hc/en-us/articles/8681465703705-Working-with-Attributes-in-VWO){:target="_blank"}.
+
+**Sample payload for Identify call to the destination**
+
+```js
+{
+ "type": "identify",
+ "traits": {
+ "vwo_uuid": "",
+ "trait1": "value1"
+ }
+}
+```
+
+**Corresponding JavaScript event that would generate the above payload**
+
+```js
+analytics.identify({
+ "vwo_uuid": "",
+ "trait1": "value1"
+});
+```
+
+> info ""
+> Each trait key will be prepended with “**segment.**” before sending to VWO. So if a trait named "**trait1**" is sent in Segment, it’ll appear as "**segment.trait1**" under UNREGISTERED ATTRIBUTES in VWO.
+
+
+### Page
+The [Page](/docs/connections/spec/page/) call records when a visitor arrives at a page of your website, along with any optional properties about the page. When received, the destination triggers VWO’s Page Visit event.
+
+> info ""
+> Use Page calls with web pages only. Server-side sources in VWO's FullStack Suite do not support the Page Visit event.
+
+**Sample payload for Page Call to the destination**
+
+```js
+{
+ "type": "page",
+ "properties": {
+ "vwo_uuid": ""
+ }
+}
+
+```
+
+**Corresponding JavaScript event that would generate the above payload**
+
+```js
+analytics.page({
+ "vwo_uuid": "",
+});
+```
{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-vwo-web/index.md b/src/connections/destinations/catalog/actions-vwo-web/index.md
index d28d1398b4..53a18e8276 100644
--- a/src/connections/destinations/catalog/actions-vwo-web/index.md
+++ b/src/connections/destinations/catalog/actions-vwo-web/index.md
@@ -19,7 +19,7 @@ versions:
VWO Web Mode (Actions) provides the following benefits over the classic VWO destination:
-- **Support for Customer Data Platform (Data360)**. With the Web mode destination enabled, you will be able to transfer all the events and attributes into your VWO account through the [Data360 module](https://help.vwo.com/hc/en-us/articles/8679651827737-About-VWO-Data360). You can use these events and attributes to [create segments](https://help.vwo.com/hc/en-us/articles/360020418454-Using-Segmentation-in-VWO) and [metrics](https://help.vwo.com/hc/en-us/articles/8675547113625) in your VWO campaigns.
+- **Support for Customer Data Platform (Data360)**. With the Web mode destination enabled, you will be able to transfer all the events and attributes into your VWO account through the [Data360 module](https://help.vwo.com/hc/en-us/articles/8679651827737-About-VWO-Data360){:target="_blank”}. You can use these events and attributes to [create segments](https://help.vwo.com/hc/en-us/articles/360020418454-Using-Segmentation-in-VWO){:target="_blank”} and [metrics](https://help.vwo.com/hc/en-us/articles/8675547113625){:target="_blank”} in your VWO campaigns.
## Getting started
diff --git a/src/connections/destinations/catalog/actions-webhook/index.md b/src/connections/destinations/catalog/actions-webhook/index.md
index 270f71bd9a..c3fe75bf68 100644
--- a/src/connections/destinations/catalog/actions-webhook/index.md
+++ b/src/connections/destinations/catalog/actions-webhook/index.md
@@ -23,3 +23,23 @@ Segment's Webhooks (Actions) destination uses internet protocol and HTTP callbac
7. Enable the destination and configured mappings.
{% include components/actions-fields.html settings="true"%}
+
+## Batch size limits
+
+In Webhook Actions mapping, the default value of batch size is `1000`. You can change this value, but there's a maximum batch size limit of `4000`.
+
+## FAQs
+
+### Why is a Webhooks (Actions) Destination helpful with end-to-end tests?
+The easiest way to test whether a source's events are sending through the Segment pipeline is with an end-to-end test. Use the steps below to monitor the events arriving to your Segment source and whether they're successfully sending to your destinations. Connecting a Webhooks (Actions) Destination to your sources makes these requests easy to see. For example, if you connect a Webhooks Destination (Webhook Actions Destination) to your source, you'd be able to see the events received by that source and sent to that destination.
+
+#### Connect a Webhook Actions destination to your workspace
+1. [Add a new Webhook (Actions) destination](https://app.segment.com/goto-my-workspace/destinations/catalog/actions-webhook) to your source. Make sure you select the intended source to connect this destination to.
+2. Visit the webhook's site, and copy the endpoint to your clipboard. An example site you can use is [https://webhook.site/#!/]([url](https://webhook.site/#!/)), but use whichever webhooks site you prefer.
+3. Add a mapping to the Webhook Actions destination, and configure Step 1's conditions to allow for all types of events that you're currently sending through that source.
+4. Add the endpoint you copied from Step 2 to the Webhook Actions Mapping's URL in Step 3.
+5. Enable the Mapping.
+6. Enable the Webhook Actions destination.
+7. Begin sending events to your source.
+8. Verify those events throughout the Segment pipeline (source debugger/ event delivery).
+9. Verify the webhook's website which shows the raw JSON for all of the events successfully received by your Segment source and its Webhooks Actions destination.
diff --git a/src/connections/destinations/catalog/actions-wisepops/images/wisepops-custom-event.png b/src/connections/destinations/catalog/actions-wisepops/images/wisepops-custom-event.png
index 713e26e763..a8cebdc675 100644
Binary files a/src/connections/destinations/catalog/actions-wisepops/images/wisepops-custom-event.png and b/src/connections/destinations/catalog/actions-wisepops/images/wisepops-custom-event.png differ
diff --git a/src/connections/destinations/catalog/actions-wisepops/images/wisepops-goal-id.png b/src/connections/destinations/catalog/actions-wisepops/images/wisepops-goal-id.png
new file mode 100644
index 0000000000..8215580af2
Binary files /dev/null and b/src/connections/destinations/catalog/actions-wisepops/images/wisepops-goal-id.png differ
diff --git a/src/connections/destinations/catalog/actions-wisepops/images/wisepops-group-id.png b/src/connections/destinations/catalog/actions-wisepops/images/wisepops-group-id.png
deleted file mode 100644
index 25caaadda0..0000000000
Binary files a/src/connections/destinations/catalog/actions-wisepops/images/wisepops-group-id.png and /dev/null differ
diff --git a/src/connections/destinations/catalog/actions-wisepops/images/wisepops-group-plan.png b/src/connections/destinations/catalog/actions-wisepops/images/wisepops-group-plan.png
index e31e0f4f3f..61743a972a 100644
Binary files a/src/connections/destinations/catalog/actions-wisepops/images/wisepops-group-plan.png and b/src/connections/destinations/catalog/actions-wisepops/images/wisepops-group-plan.png differ
diff --git a/src/connections/destinations/catalog/actions-wisepops/images/wisepops-setup-code.png b/src/connections/destinations/catalog/actions-wisepops/images/wisepops-setup-code.png
deleted file mode 100644
index d6b428ebbf..0000000000
Binary files a/src/connections/destinations/catalog/actions-wisepops/images/wisepops-setup-code.png and /dev/null differ
diff --git a/src/connections/destinations/catalog/actions-wisepops/images/wisepops-website-hash.png b/src/connections/destinations/catalog/actions-wisepops/images/wisepops-website-hash.png
new file mode 100644
index 0000000000..b8a58a3be9
Binary files /dev/null and b/src/connections/destinations/catalog/actions-wisepops/images/wisepops-website-hash.png differ
diff --git a/src/connections/destinations/catalog/actions-wisepops/index.md b/src/connections/destinations/catalog/actions-wisepops/index.md
index 2e25030c75..f177ee8a87 100644
--- a/src/connections/destinations/catalog/actions-wisepops/index.md
+++ b/src/connections/destinations/catalog/actions-wisepops/index.md
@@ -12,9 +12,6 @@ Wisepops powers 2,000 brands in 53 countries and delivers 2 billion personalized
When you use the Wisepops destination, Segment loads Wisepops on your website for you. With no development, you can target your users based on their traits or events, display personalized messages, and track the revenue generated by your campaigns.
-{% include content/ajs-upgrade.md %}
-
-
## Getting started
1. From the Segment web app, click **Catalog**, then click **Destinations**.
@@ -22,8 +19,8 @@ When you use the Wisepops destination, Segment loads Wisepops on your website fo
3. Click **Configure Wisepops**.
4. Select an existing Source to connect to Wisepops.
5. Give the destination a name.
-6. In the **Basic Settings** page, enter your **Website Identifier**. It can be found in your [Wisepops setup code](https://app.wisepops.com/f/settings/websites){:target='_blank'}. It's the bolded string in the setup code of the Popups service that's 10 characters long.
- 
+6. In the **Basic Settings** page, enter your **Website Identifier**. It can be found in your [Wisepops setup code](https://id.wisepops.com/r/id/workspaces/_workspaceId_/settings/setup-code){:target='_blank'}. It's the bolded string that's 10 characters long.
+ 
7. Toggle **Enable Destination** and click **Save Changes**.
> info "Wisepops Destination is device mode only (web)"
@@ -68,10 +65,17 @@ For example, you can display a popup when a product is added to the cart:
### Track Goal
-By default, when you track the event **Order Completed**, Segment sends a [goal completion](https://support.wisepops.com/article/mx3z8na6yb-set-up-goal-tracking){:target='_blank'} to Wisepops.
-The goal and its revenue are attached to one of your campaigns based on your Wisepops' goal attribution model.
-You can easily track more goals by editing the mapping.
-The goals are named after the Segment event name.
+The Track Goal action is not mapped by default. You can enable it to track [goal completion and revenue](https://support.wisepops.com/article/mx3z8na6yb-set-up-goal-tracking){:target='_blank'} on Wisepops.
+
+To track a JavaScript goal using Segment:
+
+1. [Create your JavaScript goal in Wisepops](https://id.wisepops.com/r/id/workspaces/_workspaceId_/goals){:target='_blank'}.
+2. Copy the goal identifier. It is a 32-character string visible after the goal is created:
+ 
+3. In Segment, create a new mapping with the action **Track Goal**.
+4. In the first section, configure when the goal should be tracked.
+5. In the third section, paste the goal identifier, without quotes, into the **Goal Identifier** field.
+6. Save the new mapping.
### Track Page
diff --git a/src/connections/destinations/catalog/actions-xtremepush/index.md b/src/connections/destinations/catalog/actions-xtremepush/index.md
new file mode 100644
index 0000000000..983c2e7d0d
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-xtremepush/index.md
@@ -0,0 +1,77 @@
+---
+title: Xtremepush (Actions) Destination
+beta: true
+id: 661e9787658d112ba31b59a7
+versions:
+ - name: Xtremepush Destination
+ link: /docs/connections/destinations/catalog/xtremepush/
+---
+{% include content/plan-grid.md name="actions" %}
+
+[Xtremepush](https://xtremepush.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a complete digital engagement platform that empowers global brands to create personalized, real-time experiences for their customers across mobile, web, email, SMS and social. Xtremepush's clients are increasing revenue through data-driven, contextually-relevant interactions. The software is flexible, reliable and quick to deploy, backed up by a team of expert strategists and technical support.
+
+This destination is maintained by Xtremepush. For any issues with the destination, [contact the Xtremepush Support team](mailto:support@xtremepush.com).
+
+## Benefits of Xtremepush (Actions) vs Xtremepush Classic
+
+Xtremepush (Actions) provides the following benefits over the classic Xtremepush destination:
+
+- **Easier setup**: Users see fewer initial settings which can decrease the time spent configuring the destination.
+- **Increased transparency**: Users can see both the exact data that is sent to the destination and the time that Segment sent it.
+- **Improved customization**: Users can determine how the events their sources trigger map to actions supported by the Xtremepush (Actions) destination.
+
+## Getting started
+
+1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Xtremepush".
+2. Select **Xtremepush (Actions)** and click **Add destination**.
+3. Select an existing Source to connect to **Xtremepush (Actions)**, and click **Next**.
+4. Enter a name for your Xtremepush (Actions) destination and click **Create destination**.
+5. From the Segment destinations settings page, enter the "API Key" and "API Endpoint". You can find these values in your Xtremepush Project under *Settings > Integrations* as described in the [Xtremepush Segment integration user guide](https://docs.xtremepush.com/docs/segment){:target="_blank"}.
+
+{% include components/actions-fields.html %}
+
+## Identify
+
+If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
+
+```
+analytics.identify('userId123', {
+ email: 'john.doe@example.com',
+ phone: '1234567890',
+ firstName: 'John'
+});
+```
+
+When you identify a user, Segment passes that user's information to Xtremepush and creates a new user, if no profile exists with that `user_id`, or updates an existing profile if the `user_id` already exists.
+
+Some user traits are also passed as additional user identifiers:
+
+| Segment Trait | Xtremepush User Identifier |
+| ------------- | -------------------------- |
+| email | email |
+| phone | mobile_number |
+
+For any additional traits you want to save, create [User Profile Attributes](https://docs.xtremepush.com/docs/attributes-tags){:target="_blank"} in your Xtremepush Project.
+
+If a trait does not match a custom Xtremepush User Profile Attribute and is not recognized as a User Identifier, Xtremepush ignores the trait.
+
+## Track
+
+If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
+
+```
+analytics.track('Product Purchased', {
+ productName: 'Some Product'
+})
+```
+
+Track calls are sent to Xtremepush as a `event hits` and you can use them to [trigger a campaign](https://docs.xtremepush.com/docs/campaign-events){:target="_blank"} for a user.
+
+Event properties can be used as merge tags in the message content. You can also define additional rules on where to trigger the campaign based on event properties value.
+
+## Enabling Push and In-App Notifications
+To enable Xtremepush push and in-app notifications you must also install the relevant Xtremepush SDKs.
+
+[Xtremepush iOS SDK Docs](https://docs.xtremepush.com/docs/ios-integration){:target="_blank"}
+
+[Xtremepush Android SDK Docs](https://docs.xtremepush.com/docs/android-integration){:target="_blank"}
diff --git a/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-1.png b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-1.png
new file mode 100644
index 0000000000..a9f77078c0
Binary files /dev/null and b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-1.png differ
diff --git a/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-2.png b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-2.png
new file mode 100644
index 0000000000..bc5a96ac12
Binary files /dev/null and b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-2.png differ
diff --git a/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-3.png b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-3.png
new file mode 100644
index 0000000000..7bad4b6e31
Binary files /dev/null and b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-3.png differ
diff --git a/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-4.png b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-4.png
new file mode 100644
index 0000000000..a47150bf40
Binary files /dev/null and b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-4.png differ
diff --git a/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-5.png b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-5.png
new file mode 100644
index 0000000000..a84425d074
Binary files /dev/null and b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-5.png differ
diff --git a/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-6.png b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-6.png
new file mode 100644
index 0000000000..bc7ad77cbe
Binary files /dev/null and b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-6.png differ
diff --git a/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-7.png b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-7.png
new file mode 100644
index 0000000000..7f328557b0
Binary files /dev/null and b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-7.png differ
diff --git a/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-8.png b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-8.png
new file mode 100644
index 0000000000..01f22d25b8
Binary files /dev/null and b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-8.png differ
diff --git a/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-9.png b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-9.png
new file mode 100644
index 0000000000..53fae42296
Binary files /dev/null and b/src/connections/destinations/catalog/actions-yahoo-audiences/images/yahoo-9.png differ
diff --git a/src/connections/destinations/catalog/actions-yahoo-audiences/index.md b/src/connections/destinations/catalog/actions-yahoo-audiences/index.md
new file mode 100644
index 0000000000..6dadbf32fe
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-yahoo-audiences/index.md
@@ -0,0 +1,98 @@
+---
+title: Yahoo Audiences Destination
+id: 6514281004d549fae3fd086a
+beta: true
+---
+
+The Yahoo Audiences integration facilitates seamless connectivity between Engage Audiences and Yahoo DSP, offering users the flexibility to configure their data delivery preferences within the Segment platform.
+
+This integration is designed to accommodate various identifiers, including **email**, **phone**, and **MAIDs** (iOS IDFA, Android Advertising Id). To ensure data security, the integration hashes **email** and **phone** identifiers, while also formatting phone numbers to comply with E.164 requirements.
+
+Operating on the [Yahoo DataX platform](https://developer.yahooinc.com/datax/guide/){:target="_blank"}, the integration harnesses the power of the [Yahoo Realtime API](https://developer.yahooinc.com/datax/guide/datax-online-spec/user-data-audience-data/){:target="_blank"} for audience synchronization. Users can enjoy the convenience of syncing both realtime and batch audiences, with incremental batches supporting a maximum of 1000 user records. Notably, each synchronized user record can encompass the individual's membership in multiple audiences.
+
+In addition to these features, the integration provides support for [Trait Activation](/docs/engage/trait-activation/) functionalities, specifically [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/) and [ID Sync](/docs/engage/trait-activation/id-sync/), enhancing the overall user experience.
+
+
+## Getting started
+
+To connect your Yahoo Audiences Destination:
+1. Create your Engage Audience.
+2. Navigate to **Engage** > **Engage Settings** > **Destinations** and click **Add Destination**.
+3. Select **Yahoo Audiences**, select your Engage space as the source, and name your destination.
+4. Configure global destination settings on the **Settings** tab:
+
+ Settings | Details
+ -------- | -------
+ Name | Specify the destination name, for example “Yahoo Audiences Production”. This value is only available in Segment.
+ MDM ID | Specify the MDM ID provided by your Yahoo DSP representative.
+ Engage Space ID | Specify the Engage Space ID. To locate Engage Space ID navigate to **Unify** > **Unify Settings** > **API Access**. This value identifies your customer node in Yahoo Data Taxonomy. Don't provide arbitrary values in this field, or any values other than your Engage Space ID.
**Note:** The destination displays an error if the provided value includes any characters other than [a-zA-Z0-9] and “_” (underscore). This is to prevent passing values not supported by Yahoo.
+ Customer Description | Provide an optional description for the integration.
+5. Turn on the **Enable Destination** toggle.
+6. Click **Save Changes** to save the destination.
+7. Configure destination Action Mappings. Action Mappings determine the information sent from Engage to the Yahoo Audiences destination.
+ 1. On the **Mapping** tab click **Add Mapping** and select **Sync to Yahoo Ads Segment**.
+ 2. Within the mapping’s **Select events to map and send** configure whether the mapping should be triggered for all audiences connected to the destination, or for specific audiences only.
+ - **Note:** Action mapping settings apply to all audiences that are processed by the mapping. The mapping can be configured to process all audiences connected to the destination, or only specific audiences. This can be helpful when enabling the GDPR flag only for specific audiences.
+ - To apply the mapping only to specific audiences, modify the trigger as follows:
+ 
+ - To apply the mapping to all audiences, modify the trigger as follows:
+ 
+ 3. Configure the mapping for **Email**, **Phone**, **Mobile Advertising Id** and **Device Type** fields. You can keep default mapping for these fields, if your data matches default mappings.
+ - **Note:** The destination expects the mobile advertising ID to be a combination of 2 fields: advertising ID and device type. If device type field is not available in your data, the destination deduces the platform (iOS /Android) based on advertising ID value formatting. If the value is capitalized - the destination assumes that this is iOS IDFA, otherwise the destination assumes that is Android DSP ID.
+ 4. Configure whether **GDPR Flag** should be sent.
+ - **Note:** **GDPR Flag** setting applies to the entire audience. Set this setting to TRUE if the audience is subject to GDPR regulations. If you set the **GDPR Flag** to YES, then populate **GDPR Consent Attributes** setting with the following IAB user consent attributes: “Access of Information” and “Personalization”. See more in [Yahoo DSP API documentation](https://developer.yahooinc.com/datax/guide/gdpr/faq/){:target="_blank"}. If the **GDPR Flag** setting is set to YES, and **GDPR Consent Attributes** is not populated, the audience sync fails.
+ 5. Provide **GDPR Consent Attributes** if you opted to send a **GDPR Flag**.
+ 6. Save the mapping.
+8. Connect the Destination to the Audience and configure the Audience Sync settings.
+ 1. Navigate to **Engage** > **Audiences** > **(your audience)**. Click **Add Destination** and select the destination you just created.
+ 2. Configure how the audience should be synced. Enable **Send Track** and disable **Send Identify**.
+ 3. Select the identifiers to be synced to Yahoo:
+ - **Default Setup**: Sends all email IDs available on a user profile.
+ - **Customized Setup**: Configure the identifiers to be sent to Yahoo DSP.
+ 4. If you’d like to send iOS IDFA and Android Advertising ID - turn on **Send Mobile IDs** and map MAIDs using **Customized Setup**.
+ 5. Don't modify the **Placeholder** setting.
+ 6. Click **Save Settings**.
+
+> info ""
+> Yahoo DSP supports the following identifiers: **email**, **phone**, **iOS IDFA**, **Android Advertising Id**. Segment hashes email and phone per Yahoo DSP requirements, so you don’t have to hash email and phone. Segment formats the phone to meet E.164 requirements: removes non-digit characters and adds “+” sign. Your phone trait/identifier must include country code, as Segment does not prepend phone with country code.
+
+Once the Audience is connected to the Destination, Segment makes a request to Yahoo DSP to create an ‘audience’ (‘segment’) node in Yahoo Data Taxonomy. The node is identified by Audience ID, and named with Audience Key. After Engage has computed the audience, the Destination syncs the audience to Yahoo DSP.
+
+{% include components/actions-fields.html %}
+
+## Destination configurations for various use cases
+
+### Use case 1
+
+Email, phone, IOS IDFA and Android Advertising ID are available as Engage Identifiers.
+
+Setting | Details
+------- | --------
+Action Mappings | Keep default field mappings.
+Audience Sync settings | Select **Customized Setup**, and map available identifiers under the Identifiers section. You can select whether Engage should send First, Last, or All Available identifiers.
+
+### Use case 2
+
+Email, phone, IOS IDFA and Android Advertising Id are available as Engage Identifiers and/or Traits.
+
+Settings | Details
+-------- | --------
+Action Mappings | Modify the mapping to reflect your custom trait names. For example, if you’re planning to send `email_addr` trait as email to Yahoo Audiences, map `email_addr` trait in the **User Email** field.
+Audience Sync settings | Click **Customized Setup** and select the **Identifiers** and **Traits** that you plan to send to Yahoo Audiences. For example, if you plan to send `phone` identifier and `email_addr` trait, map these fields as shown below: 
+
+### Use case 3
+Send mobile advertising ID custom traits to Yahoo Audiences.
+
+Settings | Details
+-------- | --------
+Action Mappings | The destination expects 2 fields for mobile advertising ID: 1) advertising ID field (trait) storing the ID value iteself, and 2) device type field (trait) storing mobile platform name (`ios` or `android`).
* If your Engage data includes these 2 fields, you can map them as: `traits.advertising_id_trait` → `User Mobile Advertising ID` and `traits.device_type_trait` → `User Mobile Device Type`.
* If your data doesn't include a field with the device type, you can only map the advertising ID trait. The destination detects device type based on the ID value format. Apple IDFA is typically capitalized, and Android advertising ID is typically lowercase.
* If you have separate traits for iOS IDFA and Android Advertising ID, you can map them using the coalesce() function: `coalesce( traits.ios_ad_id_trait`, `traits.android_ad_id_trait)` → `User Mobile Advertising ID`
+Audience Sync settings | Use **Customized Setup** to map custom advertising ID and, if available, device type traits. 
+
+
+## FAQs
+
+### Why am I seeing the difference between audience size in Engage and in Yahoo DSP?
+The difference between audience size in Segment and in Yahoo DSP is expected due to ID matching. Yahoo DSP will recognize only users it has matching ID (email / phone / MAID) for.
+
+### The audience has synced, but I’m seeing 0 population in Yahoo DSP UI.
+As soon as user records land in Yahoo DSP, users become targetable in minutes. However, Yahoo DSP reporting is not realtime, and might take 24-48 hours to catch up. This delay does not affect targeting. Because of that you might see 0 users in the Yahoo DSP audience immediately after the sync.
diff --git a/src/connections/destinations/catalog/activecampaign/index.md b/src/connections/destinations/catalog/activecampaign/index.md
index 940e5ed0ca..06cfb1cced 100644
--- a/src/connections/destinations/catalog/activecampaign/index.md
+++ b/src/connections/destinations/catalog/activecampaign/index.md
@@ -3,13 +3,13 @@ rewrite: true
title: ActiveCampaign Destination
id: 55d66bb5ebe537b09c977fa3
---
-[ActiveCampaign](https://www.activecampaign.com) is an integrated email marketing, marketing automation, and small business CRM. It allows you to send beautiful newsletters, set up behavioral based automations, and benefit from sales automation.
+[ActiveCampaign](https://www.activecampaign.com){:target="_blank”} is an integrated email marketing, marketing automation, and small business CRM. It allows you to send beautiful newsletters, set up behavioral based automations, and benefit from sales automation.
-This destination is maintained by ActiveCampaign. For any issues with the destination, [contact the ActiveCampaign support team](https://www.activecampaign.com/contact/).
+This destination is maintained by ActiveCampaign. For any issues with the destination, [contact the ActiveCampaign support team](https://www.activecampaign.com/contact/){:target="_blank”}.
## Getting Started
-{% include content/connection-modes.md %}
+
1. From your Segment UI's Destinations page click on "Add Destination".
2. Search for "Active Campaign" in the Catalog, select it, and choose which of your sources to connect the destination to.
diff --git a/src/connections/destinations/catalog/adikteev/index.md b/src/connections/destinations/catalog/adikteev/index.md
index 048a67bcfb..065af29ecd 100644
--- a/src/connections/destinations/catalog/adikteev/index.md
+++ b/src/connections/destinations/catalog/adikteev/index.md
@@ -5,12 +5,10 @@ id: 5c75564f1d2f34000116ef78
---
This destination is maintained by Adikteev. For any issues with the destination, [contact the Adikteev support team](mailto:contact@adikteev.com).
-{% include content/beta-note.md %}
-
## Getting Started
-{% include content/connection-modes.md %}
+
Currently, this destination supports events originating from Mobile sources alone.
diff --git a/src/connections/destinations/catalog/adjust/index.md b/src/connections/destinations/catalog/adjust/index.md
index 5825aebee8..f01340d82f 100644
--- a/src/connections/destinations/catalog/adjust/index.md
+++ b/src/connections/destinations/catalog/adjust/index.md
@@ -5,12 +5,12 @@ id: 56f6ce7280412f644ff12fb2
---
[Adjust](https://adjust.com){:target="_blank"} is the mobile attribution provider of choice for hundreds of organizations across the globe. They unify all your marketing activities into one powerful platform, giving you the insights you need to scale your business. The Adjust Destination is open-source. You can browse the code on GitHub for [iOS](https://github.com/segment-integrations/analytics-ios-integration-adjust){:target="_blank"} and [Android](https://github.com/segment-integrations/analytics-android-integration-adjust){:target="_blank"}.
-If you notice any gaps, out-dated information, or want to leave feedback to help improve Segment's documentation, [let us know](https://segment.com/help/contact).
+If you notice any gaps, out-dated information, or want to leave feedback to help improve Segment's documentation, [let us know](https://segment.com/help/contact){:target="_blank”}.
## Getting started
-{% include content/connection-modes.md %}
+
1. From the Segment web app, click **Catalog**.
2. Search for "Adjust" in the Catalog, select it, and choose which of your sources to connect the destination to.
@@ -109,10 +109,6 @@ analytics = new Analytics.Builder(this, "write_key")
After you build and release to the App Store, Segment automatically starts translating and sending your data to Adjust.
-### React Native
-
-{% include content/react-dest.md %}
-
### Server
The Cloud-mode integration allows you to send *supplemental* data to Adjust. This *does not* include attribution events. If you rely on the Adjust server-side component, and do not bundle the Segment-Adjust SDK, your installs will not be attributed. E-commerce events and other general `track` events are supported out of the box. You **must** map your `track` events to your custom Adjust Event Token in your [Adjust destination settings](#map-your-events-to-custom-adjust-event-tokens).
@@ -237,7 +233,7 @@ If you're using Adjust's iOS SDK, it will automatically takes care of duplicate
### In-app purchase receipts
-The destination does not currently support in-app purchase receipts. If this is important to you, [reach out to support](https://segment.com/help/contact/).
+The destination does not currently support in-app purchase receipts. If this is important to you, [reach out to support](https://segment.com/help/contact/){:target="_blank”}.
### Push notifications
diff --git a/src/connections/destinations/catalog/adobe-analytics/best-practices.md b/src/connections/destinations/catalog/adobe-analytics/best-practices.md
index 7285a3df48..138082951b 100644
--- a/src/connections/destinations/catalog/adobe-analytics/best-practices.md
+++ b/src/connections/destinations/catalog/adobe-analytics/best-practices.md
@@ -9,7 +9,7 @@ This page contains best practices and tips for setting up and testing Adobe Anal
The following list contains tools you can use to validate data coming from Segment and going to each different Adobe Analytics component
-- **Analytics.js** - [Adobe Experience Cloud Debugger](https://chrome.google.com/webstore/detail/adobe-experience-cloud-de/ocdmogmohccmeicdhlhhgepeaijenapj) and Chrome Developer Tools
+- **Analytics.js** - [Adobe Experience Cloud Debugger](https://chromewebstore.google.com/detail/adobe-experience-platform/bfnnokhpnncpkdmbokanobigaccjkpob){:target="_blank”} and Chrome Developer Tools
- **Other Segment server libraries** - Segment's in-app [Event Tester Tool](/docs/connections/test-connections/)
- **iOS Device mode** - Charles Proxy, DEBUG mode
- **Android Device Mode** - Charles Proxy, VERBOSE logging
@@ -48,7 +48,7 @@ If you are setting up the Adobe Analytics destination in cloud-mode, you can pas
**Note**: If you pass in the `visitorId` in a destination-specific `integration` object in your Segment Page or Track events, the `visitorId` passed persists on Page or Track calls that occur after an Identify call. This effectively supersedes the `visitorId` variable Segment would set to your `userId` after an Identify call.
-We know this is daunting territory, so don't hesitate to [contact us directly for guidance](https://segment.com/help/contact/)!
+We know this is daunting territory, so don't hesitate to [contact us directly for guidance](https://segment.com/help/contact/){:target="_blank”}.
### Setting the event linkType
diff --git a/src/connections/destinations/catalog/adobe-analytics/heartbeat.md b/src/connections/destinations/catalog/adobe-analytics/heartbeat.md
index 107168e53e..601b49848a 100644
--- a/src/connections/destinations/catalog/adobe-analytics/heartbeat.md
+++ b/src/connections/destinations/catalog/adobe-analytics/heartbeat.md
@@ -3,7 +3,7 @@ title: Setting up Adobe Analytics Heartbeat
strat: adobe
---
-Adobe Heartbeat is an Adobe Analytics add-on that allows you to collect video analytics data from [mobile applications, and JavaScript or website sources](https://marketing.adobe.com/resources/help/en_US/sc/appmeasurement/hbvideo/).
+Adobe Heartbeat is an Adobe Analytics add-on that allows you to collect video analytics data from [mobile applications, and JavaScript or website sources](https://marketing.adobe.com/resources/help/en_US/sc/appmeasurement/hbvideo/){:target="_blank”}.
> info ""
> At this time, Adobe Heartbeat is only available for events sent using [device mode](/docs/connections/destinations/#connection-modes).
@@ -24,9 +24,9 @@ Next, enable Adobe's VisitorID service in your Adobe account. You must do this t
For Android:
-1. If you haven't done so already, go to the Adobe Mobile Services UI and follow [these steps](https://docs.adobe.com/content/help/en/mobile-services/android/getting-started-android/requirements.html#section_044C17DF82BC4FD8A3E409C456CE9A46) to download the core `adobeMobileLibrary` and configure in your Android project. Add the `ABDMobileConfig.json` to your project from the downloaded SDK.
-2. Download the latest version of the `MediaSDK.jar` file and [include it in your Android project using Adobe's documentation steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html).
-3. Follow the [remaining set up steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html) to complete the installation.
+1. If you haven't done so already, go to the Adobe Mobile Services UI and follow [these steps](https://docs.adobe.com/content/help/en/mobile-services/android/getting-started-android/requirements.html#section_044C17DF82BC4FD8A3E409C456CE9A46){:target="_blank”} to download the core `adobeMobileLibrary` and configure in your Android project. Add the `ABDMobileConfig.json` to your project from the downloaded SDK.
+2. Download the latest version of the `MediaSDK.jar` file and [include it in your Android project using Adobe's documentation steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html){:target="_blank”}.
+3. Follow the [remaining set up steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html){:target="_blank”} to complete the installation.
For iOS: The Adobe Heartbeat SDK is already included with the Segment-Adobe-Analytics SDK when you add a Heartbeat Tracking Server URL. Ensure you have added the `ABDMobileConfig.json` for your iOS project from the Adobe Mobile Services UI.
@@ -174,7 +174,7 @@ Adobe Analytics supports many - but not all - of the [Segment Video Spec events]
`s` - the name of the event to build an extractor for | +| Return Type | `VectorExtractor` | +| Example | `event('Shoes Bought')` | + +| `trait` | | +| ----------- | --------------------------------------------------------------------------------------------------- | +| Syntax | `trait({s: String})`
`s` - the name of the the trait to reference | +| Return Type | `ScalarExtractor` | +| Description | Similar to the event operator, the trait operator is used to specify profile trait filter criteria. | +| Notes | You can reference other audiences by using the audience key as the trait name. | +| Example | `trait('total_spend')` | + +| `property` | | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Syntax | `property({s: String})`
`s` - the name of the property to build an extractor for
In the context of funnel audiences, you can add a parent prefix to reference the parent event.
`property(parent: {s: String})` | +| Return Type | `ScalarExtractor` | +| Notes | Only valid within a `where` function or a Reducer. | +| Example | `property('total')` | + +| `context` | | +| ----------- | ----------------------------------------------------------------------------------- | +| Syntax | `context({s: String})`
`s` - the name of the context to build an extractor for | +| Return Type | `ScalarExtractor` | +| Notes | Only valid within a `where` function or a Reducer. | +| Example | `context('page.url')` | + +| `literal` | | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Syntax | `literal({a: Any})`
`a` - the value to treat as a literal expression | +| Operations allowed in call-chain | None allowed; typically used within another function, like a comparison (with syntactic sugar, this would appear on the right side of the comparison). The outer function or comparison dictates the operations allowed in the call-chain. | +| Example | `literal(100)`
| + + + +### Filters + +| `where` | | +| ----------- | ------------------------------------------------------------------------------------- | +| Syntax | `where({e: Comparator})`
`e` - a subexpression terminating in a boolean Comparator | +| Return Type | `StreamFilter` | +| Description | Filters the stream to only items where a property satisfies a particular condition. | +| Notes | The parameter is a sub-expression, something that terminates in a boolean Comparator. | +| Example | `where({property('price_usd') > 100})` | + +| `sources` | | +| ----------- | ------------------------------------------------------------------------------------- | +| Syntax | `sources({exclude: {a: Array}})`
`a` - an array of source `ids` to exclude | +| Return Type | `StreamFilter` | +| Description | Filters the stream to only items whose source `id` does not match the exclusion list. | +| Example | `sources({exclude: 'QgRHeujRJBM9j18yChyC', '/;hSBZDqGDPvXCKHbikPm'})` | + +| `within` | | +| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Syntax | `within({d: Integer} {u: TimeUnit})`
`d` - duration value
u - hour (s) day (s)
In the context of funnel audiences, you can add a parent prefix to reference the parent event.
`within(parent: {d: Integer} {u: TimeUnit})` | +| Return Type | `WindowedFilter` | +| Description | Provides time windowing so that events are only looked at over a specified number of hours or days into the past. You can add a prefix to direct the evaluation to be relative to the timestamp of a different event. | +| Example | `within(7 days)` | + +| `between` | | +| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Syntax | `between({s: Integer} {su: TimeUnit}, {e: Integer} {eu: TimeUnit})`
`s` - start value
su - hour (s) day (s)
`e` - end value
eu - hour (s) day (s) | +| Return Type | `WindowedFilter` | +| Description | You can add a prefix to direct the evaluation to be relative to the timestamp of a different event. | +| Example | `between(7 days, 10 days)` | + + +### Reducers + +| `count` | | +| ----------- | ---------------------------------------------------------------- | +| Syntax | `count()` | +| Return Type | `Scalar` | +| Description | Counts the number of entries in a stream and returns the result. | +| Example | `count()` | + +| `sum` | | +| ----------- | ----------------------------------------------------------- | +| Syntax | `sum({s: EventPropertyExtractor})`
`s` - property to sum | +| Return Type | `Scalar` | +| Example | `sum(property('spend'))` | + +| `avg` | | +| ----------- | --------------------------------------------------------------- | +| Syntax | `avg({s: EventPropertyExtractor})`
`s` - property to average | +| Return Type | `Scalar` | +| Example | `avg(property('spend'))` | + +| `max` | | +| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Syntax | `max({s: EventPropertyExtractor})` or `max({s: EventPropertyExtractor} as type)`
`s` - property to get the maximum value of
`type` - number, string | +| Return Type | `Scalar` | +| Notes | If no type is passed, Segment assumes `number` as the `type` and selects the greatest value. You can override the behavior to select the max based on lexicographical ordering by specifying `as string`. | +| Example | `max(property('spend'))`
`max(property('spend') as string)` | + +| `min` | | +| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Syntax | `min({s: EventPropertyExtractor})` or `min({s: EventPropertyExtractor} as type)`
`s` - property to get the minimum value of
`type` - number, string | +| Return Type | `Scalar` + | +| Notes | If no type is passed, Segment assumes `number` as the `type` and selects the smallest value. You can override the behavior to select the max based on lexicographical ordering by specifying `as string`. | +| Example | `min(property('spend'))`
`min(property('spend') as string)` | + +| `mode` | | +| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Syntax | `mode({s: EventPropertyExtractor}, {d: Integer})` or `mode({s: EventPropertyExtractor} as type, {d: Integer})`
`s` - the property to find the most frequent value of
`d` - minimum frequency expected
`type` - number, string, array | +| Return Type | `Scalar` | +| Description | Find the most frequent value for a given property name. | +| Notes | If no type is passed, Segment assumes `string` as the `type` and selects the most frequent value assuming all data is a string. `number` will behave the same as `string`. `array` will also behave the same way, except when used in combination with the `$` operator where instead of treating each individual value within the array separately Segment will instead treat the whole array as a string. | +| Example | `mode(property('spend'), 2)`
`mode(property('spend') as array, 2)` | + +| `first` | | +| ----------- | ------------------------------------------------------------------------------------------------ | +| Syntax | `first({s: EventPropertyExtractor})`
`s` - the property to find the first value of | +| Return Type | `Scalar` | +| Description | Find the first value for the given property name within the stream of filterable data extracted. | +| Example | `first(property('spend'))` | + +| `last` | | +| ----------- | ----------------------------------------------------------------------------------------------- | +| Syntax | `last({s: EventPropertyExtractor})`
`s` - the property to find the last value of | +| Return Type | `Scalar` | +| Description | Find the last value for the given property name within the stream of filterable data extracted. | +| Example | `last(property('spend'))` | + +| `unique` | | +| ----------- | ----------------------------------------------------------------------------------- | +| Syntax | `unique({s: EventPropertyExtractor})`
`s` - property to get the unique values of | +| Return Type | `ListScalar` | +| Description | Generate a unique list of values for the given property name. | +| Example | `unique(property('spend'))` | + + +### Comparisons + +| `equals` | | +| ----------- | ------------------------------------------------------------ | +| Syntax | `equals({v: Scalar})`
`v` - value to compare for equality | +| Return Type | `Comparator` | +| Example | `equals(500)`
Syntactic Sugar: `== 500` | + +| `differs` | | +| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Syntax | `differs({v: Scalar})`
`v` - value to compare for inequality | +| Return Type | `Comparator` | +| Notes | 'differs' only returns true if the value exists and is not equal. If null values need to be considered then use 'NOT (expression) = (value)' or add a condition to check for nulls '(expression) != (value) OR (expression).absent()'. | +| Example | `differs(500)`
Syntactic Sugar: `!= 500` | + +| `absent` | | +| ----------- | ----------------------------------------------------------------------------- | +| Syntax | `absent()` | +| Return Type | `Comparator` | +| Description | Returns true when a value is null. Equivalent to `NOT (expression).exists()`. | +| Example | `absent()` | + +| `exists` | | +| ----------- | ----------------------------------------------------------------------------------------------- | +| Syntax | `exists()` | +| Return Type | `Comparator` | +| Description | Returns true when a value is set, meaning not null. Equivalent to `NOT (expression).absent()`. | +| Example | `exists()` | + +| `greater_than` | | +| -------------- | ----------------------------------------------------- | +| Syntax | `greater_than({n: Scalar})`
`n` - value to compare | +| Return Type | `Comparator` | +| Example | `greater_than(500)`
Syntactic Sugar: `> 500` | + +| `at_least` | | +| -------------- | ------------------------------------------------- | +| Syntax | `at_least({n: Scalar})`
`n` - value to compare | +| Return Type | `Comparator` | +| Example | `at_least(500)`
Syntactic Sugar: `>= 500` | + +| `less_than` | | +| -------------- | ------------------------------------------------ | +| Syntax | `less_than({n: Scalar})`
n - value to compare | +| Return Type | `Comparator` | +| Example | `less_than(500)`
Syntactic Sugar: `< 500` | + +| `at_most` | | +| -------------- | ------------------------------------------------ | +| Syntax | `at_most({n: Scalar})`
`n` - value to compare | +| Return Type | `Comparator` | +| Example | `at_most(500)`
Syntactic Sugar: `<= 500` | + +| `contains` | | +| -------------- | ------------------------------------------------------------------------------------------ | +| Syntax | `contains({a: Array})`
`a` - array of possible values | +| Return Type | `Comparator` | +| Description | Matches when the value contains one of the elements of the parameter array as a substring. | +| Example | `contains('shoes','shirts')` | + +| `omits` | | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------- | +| Syntax | `omits({s: String})`
`s` - string to search for if missing in a containing string | +| Return Type | `Comparator` | +| Description | Evaluates to true when a substring isn't present in a containing string, equivalent to `NOT (expression).contains(
`s` - string to search for at start of containing string | +| Return Type | `Comparator` | +| Example | `starts_with('total')` | + +| `ends_with` | | +| ----------- | ---------------------------------------------------------------------------------- | +| Syntax | `ends_with({s: String})`
`s` - string to search for at end of containing string | +| Return Type | `Comparator` | +| Example | `ends_with('total')` | + +| `one_of` | | +| ----------- | ---------------------------------------------------------------------------------- | +| Syntax | `one_of({a: Array})`
`a` - array of possible values | +| Return Type | `Comparator` | +| Description | Matches when the value exactly matches one of the values from the parameter array. | +| Example | `one_of('shoes','shirts')` | + +| `before_date` | | +| ------------- | --------------------------------------------------------- | +| Syntax | `before_date({t: Timestamp})`
`t` - ISO 8601 timestamp | +| Return Type | `Comparator` | +| Example | `before_date('2023-12-07T18:50:00Z')` | + +| `after_date` | | +| ------------ | -------------------------------------------------------- | +| Syntax | `after_date({t: Timestamp})`
`t` - ISO 8601 timestamp | +| Return Type | `Comparator` | +| Example | `after_date('2023-12-07T18:50:00Z')` | + +| `within_last` | | +| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Syntax | `within_last({d: Integer} {u: TimeUnit})`
`d` - duration value
u - hour(s), day(s) | +| Return Type | `Comparator` | +| Description | Represents the date range between today and the past `d` days - inclusive where today represents the current date at the time Segment determines audience membership or calculates the trait. | +| Example | `within_last(7 days)` | + +| `within_next` | | +| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Syntax | `within_next({d: Integer} {u: TimeUnit})`
`d` - duration value
`u` - hour(s), day(s) | +| Return Type | `Comparator` | +| Description | Represents the date range between today and the next `d` days - inclusive where today represents the current date at the time Segment determines audience membership or calculates the trait. | +| Example | `within_next(7 days)` | + +| `before_last` | | +| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Syntax | `before_last({d: Integer} {u: TimeUnit})`
`d` - duration value
u - hour(s), day(s) | +| Return Type | `Comparator` | +| Description | Represents the date range between today - `d` days and any past date prior to that - inclusive where today represents the current date at the time Segment determines audience membership or calculates the trait. | +| Example | `before_last(7 days)` | + +| `after_next` | | +| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Syntax | `after_next({d: Integer} {u: TimeUnit})`
`d` - duration value
u - hour(s), day(s) | +| Return Type | `Comparator` | +| Description | Represents the date range between today + `d` days and any future date - inclusive where today represents the current date at the time Segment determines audience membership or calculates the trait. | +| Example | `after_next(7 days)` | + + +### Junctions + +| `AND` | | +| ----------- | ---------------------------------------------------- | +| Syntax | `{Comparator} AND {Comparator}` | +| Base Type | `Junction` | +| Return Type | `Comparator` | +| Description | True only if both subexpressions evaluate to `true`. | + +| `OR` | | +| ----------- | ------------------------------------------------- | +| Syntax | `{Comparator} OR {Comparator}` | +| Base Type | `Junction` | +| Return Type | `Comparator` | +| Description | True if either subexpression evaluates to `true`. | + +| `NOT` | | +| ----------- | ---------------------------------------------------- | +| Syntax | `NOT ({Comparator})` | +| Base Type | `Junction` | +| Return Type | `Comparator` | +| Description | True only if the subexpression evaluates to `false`. | + +| `ANY` | | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Syntax | `ANY ({Comparator})` | +| Base Type | `Junction` | +| Return Type | `Comparator` | +| Description | Used to evaluate an aggregatable boolean expression to determine if any expression is true. Used to specify account-level audience queries that aggregate across user-level queries. | + +| `ALL` | | +| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Syntax | `ALL ({Comparator})` | +| Base Type | `Junction` | +| Return Type | `Comparator` | +| Notes | Used to evaluate an aggregatable boolean expression to determine if every expression is true. Used to specify account-level audience queries that aggregate across user-level queries. | + + +## Return Type + +| `Extractor` | | +|-------------|------------------------| +| Operations | None included | + +| `VectorExtractor` (extends `Extractor`, `StreamFilter`) | | +| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Base Type | `Extractor`, `StreamFilter` | +| Operations allowed in call-chain | `where`, `sources`, `within`, `between`, `count`, `sum`, `avg`, `max`, `min`, `mode`, `first`, `last`, `unique` (inherited from `StreamFilter`) | +| Notes | A `VectorExtractor` represents extractions of data sets that need to be filtered and reduced to a scalar. Adds `isVector` property to entire expression. | + + +| `ScalarExtractor` (extends `Extractor`, `Scalar`) | | +| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Base Type | `Extractor`, `Scalar` | +| Operations allowed in call-chain | `equals`, `differs`, `absent`, `exists`, `greater_than`, `at_least`, `less_than`, `at_most`, `contains`, `omits`, `starts_with`, `ends_with`, `one_of`, `before_date`, `after_date`, `within_last`, `before_last`, `after_next` (inherited from `Scalar`) | +| Notes | A `ScalarExtractor` represents extractions of a single data element, like a field value or a trait value. | + +| `EventPropertyExtractor` (extends `Extractor`) | | +| ---------------------------------------------- | ---------------------------------------------------- | +| Base Type | `Extractor`, `Scalar` | +| Operations allowed in call-chain | None | +| Notes | Used to refer to properties for comparison purposes. | + +| `Filter` | | +| -------------------------------- | ------------- | +| Operations allowed in call-chain | None included | + +| `StreamFilter` (extends `Filter`) | | +| --------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| Base Type | `Filter` | +| Operations allowed in call-chain | `where`, `sources`, `within`, `between`, `count`, `sum`, `avg`, `max`, `min`, `mode`, `first`, `last`, `unique` | + +| `WindowedFilter` (extends `StreamFilter`) | | +| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| Base Type | `StreamFilter` | +| Operations allowed in call-chain | `where`, `sources`, `within`, `between`, `count`, `sum`, `avg`, `max`, `min`, `mode`, `first`, `last`, `unique` | + +| `Scalar` | | +| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Operations allowed in call-chain | `equals`, `differs`, `absent`, `exists`, `greater_than`, `at_least`, `less_than`, `at_most`, `contains`, `omits`, `starts_with`, `ends_with`, `one_of`, `before_date`, `after_date`, `within_last`, `before_last`, `after_next`, `within_next` | + +| `ListScalar` | | +| -------------------------------- | ------- | +| Operations allowed in call-chain | `count` | + +| `Comparator` | | +| -------------------------------- | ---------------------------------------------------------------------------------- | +| Base Type | `Comparator` | +| Operations allowed in call-chain | None allowed; once an expression is terminated with a Comparator, it is completed. | + +| `Junction` | | +| ---------- | --------------------------------------------------- | +| Base Type | `Junction` | +| Notes | Preserves any set properties set by subexpressions. | + +## Examples + +### Audiences + +Suppose you wanted to collect all users who performed the `Shoes Bought` event at least once within the last seven days, where the purchase price was greater than or equal to 100. + +Another way to think of this scenario would be: + +- Collect all users who performed the `Shoes Bought` event. +- Filter down to only consider events with a price greater than or equal to 100. +- Filter for events that occurred within the last seven days. +- Only include users who have one or more of the previous events. + +Here's how you could do that in Segment's query language: + +```sql +event('Shoes Bought').where( property('price') >= 100 ).within(7 days).count() >= 1 +``` + +#### Bought and returned + +This example collects: + +- all users who performed the `Shoes Bought` event at least once within the last 30 days +- where the price was greater than or equal to the average spend +- and the user performed the `Shoes Returned` event at least once, five days after the `Shoes Bought` event + +```sql +event('Shoes Bought').where( +property('price') >= trait('avg_spend') +AND +event('Shoes Returned').within(parent: 5 days).count() >= 1 +).within(30 days).count() >= 1 +``` + +#### Did not perform `Shoes Bought` + +This example collects all users who did not perform the `Shoes Bought` event at least once and don't have a `total_spend` trait with a value greater than `200`: + +```sql +NOT ( event('Shoes Bought').count() >= 1 AND trait('total_spend') > 200 ) +``` + +#### Bought with minimum total spend + +This example collects all accounts where all associated users performed the `Shoes Bought` event at least once and have a `total_spend` trait greater than `200`: + +```sql +ALL ( event('Shoes Bought').count() >= 1 AND trait('total_spend') > 200 ) +``` + +#### No users bought at least once + +This example collects all accounts where no associated users performed the `Shoes Bought` event at least once: + +```sql +ALL NOT event('Shoes Bought').count() >= 1 +``` + +#### Any users bought at least once + +This example collects all accounts where any associated users performed the `Shoes Bought` event at least once: + +```sql +ANY event('Shoes Bought').count() >= 1 +``` + +### Computed Traits + +Suppose you wanted to calculate the average spend based on all `Shoes Bought` events performed within the last 30 days for each user. + +Another way to think of this would be: + +- Find all `Shoes Bought` events. +- Filter down to only consider events that occurred within the last 30 days. +- For these events, calculate the average spend for each user. + +Here's how you could do that in Segment's query language: + +```sql +event('Shoes Bought').within(30 days).avg(property('spend')) +``` + +#### Calculate minimum spend + +This example calculates the minimum spend for each user, based on all `Shoes Bought` events, where the price was greater than `100` and the brand was `My_Brand`: + +```sql +event('Shoes Bought').where( property('price') > 100 AND property('brand') = 'My Brand' ).min(property('spend')) +``` + +#### Calculate first seen spend + +This example calculates the first-seen spend value for each user, based on all `Shoes Bought` events performed within the last 30 days: + +```sql +event('Shoes Bought').within(30 days).first(property('spend')) +``` + +#### Most frequent spend value + +This example calculates the most frequent spend value for each user, based on all `Shoes Bought` events performed within the last 30 days. It only considers spend values that have a minimum frequency of `2`: + +```sql +event('Shoes Bought').within(30 days).mode(property('spend'), 2) +``` diff --git a/src/assets/pdf/faq-segment-dissolution-vat.pdf b/src/assets/pdf/faq-segment-dissolution-vat.pdf index 546d93ea91..907707752d 100644 Binary files a/src/assets/pdf/faq-segment-dissolution-vat.pdf and b/src/assets/pdf/faq-segment-dissolution-vat.pdf differ diff --git a/src/connections/alerting.md b/src/connections/alerting.md new file mode 100644 index 0000000000..c838645131 --- /dev/null +++ b/src/connections/alerting.md @@ -0,0 +1,61 @@ +--- +title: Connections Alerting +beta: true +--- + +Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection. + +To access Connections Alerting, select an event-streaming connection (like a web library source or cloud mode destination) and click the **Alerts** tab. + +On the Alerts tab, you can create alerts and view all active alerts for this connection. You can only edit or delete the alerts that you create. + +## Source volume alerts + +You can create an alert that notifies you when the volume of events received by your source in the last 24 hours changes beyond a percentage you set. For example, if you set a change percentage of 4% and your source received 100 events over the first 24 hours, Segment would notify you the following day if your source ingested fewer than 96 or more than 104 events. + +To receive a source volume alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see the [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation. + +
+
+To create a source volume alert:
+1. In your workspace, navigate to Connections, select Sources, and select the Event streams tab.
+2. Select the [event streams source](/docs/connections/sources/#event-streams-sources) you'd like to configure alerts for.
+2. Select the Alerts tab and click **Create alert**.
+3. On the Create alert sidesheet, enter a percentage of source volume change that you'd like to be notified for.
+4. Select one or more of the following alert channels:
+ - **Email**: Select this to receive notifications at the provided email address.
+ - **Slack**: Select this to send alerts to one or more channels in your workspace.
+ - **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app.
+5. Click **Save**.
+
+To make changes to a source volume alert, select the icon in the Actions column for the alert and click **Edit**.
+
+To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**.
+
+> info "Deleting alerts created by other users requires Workspace Owner permissions"
+> All users can delete source volume alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
+
+## Successful delivery rate alerts
+
+You can create an alert that notifies you when the volume of events successfully received by your destination in the last 24 hours falls below a percentage you set. For example, if you set a percentage of 99%, Segment notifies you if your destination had a successful delivery rate of 98% or below.
+
+To receive a successful delivery rate alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see the [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.
+
+To create a successful delivery rate alert:
+1. Navigate to the [cloud-mode destinations](/docs/connections/destinations/#:~:text=Cloud%2Dmode%3A%20The%20sources%20send%20data%20directly%20to%20the%20Segment%20servers%2C%20which%20then%20translate%20it%20for%20each%20connected%20downstream%20destination%2C%20and%20send%20it%20on.) you'd like to configure alerts for.
+2. Select the Alerts tab and click **Create alert**.
+3. On the Create alert sidesheet, enter a percentage. You will receive events if your successful delivery rate falls below this percentage.
+4. Select one of the following alert channels:
+ - **Email**: Select this to receive notifications at either the email address associated with your account or another email address that you enter into this field.
+ - **Slack**: Select this and enter a Slack webhook URL and channel name to send alerts to a channel in your Slack workspace.
+ - **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app.
+5. Click **Save**.
+
+To make changes to a successful delivery rate alert, select the icon in the Actions column for the alert and click **Edit**.
+
+To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**.
+
+> info "Deleting alerts created by other users requires Workspace Owner permissions"
+> All users can delete successful delivery alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
+
+Segment generates delivery alerts for failed deliveries and successful deliveries, which are the last two stages of the delivery pipeline. As a result, alerts are based on Segment's attempts to send qualified events to your destination, excluding those filtered out by business rules (like protocols, destination filters, or mappings).
diff --git a/src/connections/auto-instrumentation/configuration.md b/src/connections/auto-instrumentation/configuration.md
new file mode 100644
index 0000000000..b7ed3975c7
--- /dev/null
+++ b/src/connections/auto-instrumentation/configuration.md
@@ -0,0 +1,313 @@
+---
+title: Generate Events from Signals
+hidden: true
+---
+
+This guide is a reference to configuring, generating, and using signals in the Signals SDK with Auto-Instrumentation. On this page, you'll find details on:
+
+- Setting up and managing signal types in the Signals SDK
+- Creating custom rules to capture and translate signals into actionable analytics events
+- Example rules that you can use as a basis for further customization
+
+This guide assumes that you've already added the Signals SDK to your application. If you haven't yet, see the [Auto-Instrumentation Setup](/docs/connections/auto-instrumentation/setup/) guide for initial setup.
+
+> info "Auto-Instrumentation Pilot"
+> Auto-Instrumentation is currently in pilot and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment doesn't recommend Auto-Instrumentation for use in a production environment, as Segment is actively iterating on and improving the user experience.
+
+> success "Enable Auto-Instrumentation"
+> To enable Auto-Instrumentation in your Segment workspace, reach out to your dedicated account manager.
+
+## Signals configuration
+
+Using the Signals Configuration object, you can control the destination, frequency, and types of signals that Segment automatically tracks within your application. The following tables detail the configuration options for both Signals-Swift and Signals-Kotlin.
+
+### Signals-Swift
+
+| `Option` | Required | Value | Description |
+| ---------------------- | -------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `writeKey` | Yes | String | Source write key |
+| `maximumBufferSize` | No | Integer | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. |
+| `relayCount` | No | Integer | Relays signals to Segment every Xth event. Default is `20`. |
+| `relayInterval` | No | TimeInterval | Relays signals to segment every X seconds. Default is `60`. |
+| `broadcasters` | No | `SignalBroadcaster` | An array of broadcasters. These objects forward signal data to their destinations, like `WebhookBroadcaster` or `DebugBroadcaster` writing to the developer console. Default is `SegmentBroadcaster`. |
+| `useUIKitAutoSignal` | No | Bool | Tracks UIKit component interactions automatically. Default is `false`. |
+| `useSwiftUIAutoSignal` | No | Bool | Tracks SwiftUI component interactions automatically. Default is `false`. |
+| `useNetworkAutoSignal` | No | Bool | Tracks network events automatically. Default is `false`. |
+| `allowedNetworkHosts` | No | Array | An array of allowed network hosts. |
+| `blockedNetworkHosts` | No | Array | An array of blocked network hosts. |
+
+
+### Signals-Kotlin
+
+| `Option` | Required | Value | Description |
+| ------------------- | -------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `writeKey` | Yes | String | Source write key |
+| `maximumBufferSize` | No | Integer | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. |
+| `broadcastInterval` | No | Integer | Broadcasts signals to Segment every X event. Default is `60`. |
+| `broadcasters` | No | `ListThe following RDS Postgres integrations support PrivateLink: + - [RDS Postgres storage destination](/docs/connections/storage/catalog/postgres/) + - [RDS Postgres Reverse ETL source](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/postgres-setup/) + +## Redshift + +### Prerequisites +- **You're using the RA3 node type**: To access Segment's PrivateLink integration, use an RA3 instance. +- **You've enabled cluster relocation**: Cluster relocation migrates your cluster behind a proxy and keeps the cluster endpoint unchanged, even if your cluster needs to be migrated to a new Availability Zone. A consistent cluster endpoint makes it possible for Segment's Edge account and VPC to remain connected to your cluster. To enable cluster relocation, follow the instructions in the AWS [Relocating your cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-recovery.html){:target="_blank”} documentation. +- **Your cluster is using a port within the ranges 5431-5455 or 8191-8215**: Clusters with cluster relocation enabled [might encounter an error if updated to include a port outside of this range](https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-recovery.html#:~:text=You%20can%20change%20to%20another%20port%20from%20the%20port%20range%20of%205431%2D5455%20or%208191%2D8215.%20(Don%27t%20change%20to%20a%20port%20outside%20the%20ranges.%20It%20results%20in%20an%20error.)){:target="_blank”}. + +### Configure PrivateLink for Redshift +Implement Segment's PrivateLink integration by taking the following steps: +1. Let your Customer Success Manager (CSM) know that you're interested in PrivateLink. They will share information with you about Segment’s Edge account and VPC. +2. After you receive the Edge account and VPC, [grant cluster access to Segment's Edge account and VPC](https://docs.aws.amazon.com/redshift/latest/gsg/rs-gsg-connect-to-cluster.html){:target="_blank”}. +3. Reach back out to your CSM and provide them with the Cluster identifier for your cluster and your AWS account ID. +4. Segment creates a Redshift managed VPC endpoint within the Segment Redshift subnet on your behalf, which creates a PrivateLink Endpoint URL. Segment then provides you with the internal PrivateLink Endpoint URL. +5. After Segment provides you with the URL, use it to update or create new Redshift integrations. The following integrations support PrivateLink: + - [Redshift storage destination](/docs/connections/storage/catalog/redshift/) + - [Redshift Reverse ETL source](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/redshift-setup/) diff --git a/src/connections/delivery-overview.md b/src/connections/delivery-overview.md new file mode 100644 index 0000000000..2cd1501545 --- /dev/null +++ b/src/connections/delivery-overview.md @@ -0,0 +1,118 @@ +--- +title: Delivery Overview +--- + +Delivery Overview is a visual observability tool designed to help Segment users diagnose event delivery issues for any cloud-streaming destination receiving events from cloud-streaming sources. + +> info "Delivery Overview for RETL destinations, Storage destinations, and Engage Audience Syncs currently in development" +> This means that Segment is actively developing Delivery Overview features for RETL destinations, Storage destinations, and Engage Audience syncs. Some functionality may change before Delivery Overview for these integrations becomes generally available. +> +> Delivery Overview is generally available for streaming connections (cloud-streaming sources and cloud-streaming destinations). +> All users of Delivery Overview have access to the Event Delivery tab, and can configure delivery alerts for their destinations. + +## Key features + +Delivery Overview has three core features: +- [Pipeline view](#pipeline-view): a visual overview of each step your data takes during the delivery process +- [Breakdown table](#breakdown-table): contains more detail about the events that were processed at each pipeline step +- [Discard table](#discard-table): contains details about the events that failed or were filtered out of your process and allows you to inspect samples of them + +You can refine these tables using the time picker and the metric toggle, located under the destination header. With the time picker, you can specify a time period (last 10 minutes, 1 hour, 24 hours, 7 days, 2 weeks, or a custom date range over the last two weeks) for which you'd like to see data. With the metric toggle, you can switch between seeing metrics represented as percentages (for example, *85% of events* or *a 133% increase in events*) or as counts (*13 events* or *an increase of 145 events*.) Delivery Overview shows percentages by default. + +### Pipeline view +The pipeline view provides insights into each step your data is processed by enroute to the destination, with an emphasis on the steps where data can be discarded due to errors or your filter preferences. Each step provides details into counts, change rates, and event details (like the associated Event Type or Event Names), and the discard steps (Failed on ingest, Filtered at source, Filtered at destination, & Failed delivery) provide you with the reasons events were dropped before reaching the destination. Discard steps also include how to control or alter that outcome, when possible. The pipeline view also shows a label between the Filtered at destination and Failed delivery steps indicating how many events are currently pending retry. + +The pipeline view shows the following steps: + +- **Successfully received**: Events that Segment ingested from your source +- **Failed on ingest**: Events that Segment received, but were dropped due to internal data validation rules +- **Filtered at source**: Events that were discarded due to schema settings or [Protocols](/docs/protocols/) Tracking Plans +- **Filtered at destination**: Events that were discarded due to [Destination Filters](/docs/guides/filtering-data/#destination-filters), [filtering in the Integrations object](/docs/guides/filtering-data/#filtering-with-the-integrations-object), [Destination Insert functions](/docs/connections/functions/insert-functions/), or [per source schema integration filters](/docs/guides/filtering-data/#per-source-schema-integrations-filters). [Actions destinations](/docs/connections/destinations/actions/) also have a filtering capability: for example, if your Action is set to only send Identify events, all other event types will be filtered out. Actions destinations with incomplete triggers or disabled mappings are filtered out at this step. [Consent Management](/docs/privacy/consent-management/) users also see events discarded due to consent preferences. +- **Failed delivery**: Events that have been discarded due to errors or unmet destination requirements +- **Successful delivery**: Events that were successfully delivered to the destination + +Actions destinations also include a mapping dropdown, which allows you to select a [mapping](/docs/connections/destinations/actions/#customize-mappings) to filter the events in the Filtered at destination, Failed delivery and Successful delivery pipeline steps. The following image shows an Actions destination filtered to include only Track Page View events in the last three pipeline steps: + + + +### Breakdown table +The breakdown table provides you with greater detail about the selected events. + +To open the breakdown table, select either the first step in the pipeline view (Successfully received,) the last step in the pipeline view (Successful delivery,) or select a discard step and then click on a discard reason. + +The breakdown table displays the following details: +- **Event type**: The Segment spec event type (Track call vs. Identify call, for example) +- **Event name**: The event name, provided by you or the source (*not available for inspection at all steps*) +- **App version**: The app/release version, provided by you or the source (*not available for inspection at all steps*) +- **Event count**: How many of each event either successfully made it through this pipeline step (in the case of the first or last steps in the pipeline view) or were filtered out (if you access it from a discard table) +- **% Change**: Insight into how the event counts differ from the last comparable time range as a percentage1 + +1: *Segment calculates the related change percentage by subtracting the percent of events impacted in the previous time period from the percent of impacted events in the current time period. For example, if last week 15% of your events were filtered at a source, but this week, 22% of your events were filtered at a source, you would have a related change percentage of 7%.* + +### Discard table +The discard table provides you with greater detail about the events that failed to deliver or were filtered out of your sources and destinations. + +To open the discard table, click on one of the discard steps. If you click on a row in the discard table, you can see the breakdown table for the discarded events. + +The discard table displays the following details: + +- **Discard reason**: Any relevant error code, message, or description associated with the event's failure. When possible, Delivery Overview links to any troubleshooting information you can use to get your events up and running again. Clicking on a discard reason brings you to the [breakdown table](#breakdown-table,) where you can see more detail about discarded events. For more context about discard reasons, see the [Troubleshooting](#troubleshooting) documentation. +- **Details & Samples**: View up to ten samples over the selected time range. Examine the error message and reason for the error or discard and inspect the payloads involved with the attempted transaction (*not available for inspection at all steps*) +- **Event count**: How many of each event were discarded in this pipeline step +- **% Change**: Insight into how the event counts differ from the last comparable time range as a percentage1 + +1: *Segment calculates the related change percentage by subtracting the percent of events impacted in the previous time period from the percent of impacted events in the current time period. For example, if last week 15% of your events were filtered at a source, but this week, 22% of your events were filtered at a source, you would have a related change percentage of 7%.* + +## When should I use Delivery Overview? +Delivery Overview is useful to diagnose delivery errors in the following scenarios: +- **When setting up a destination, tracking plan, or filter for the first time**: With Delivery Overview, you can verify that the data you're sending to a new destination, a new tracking plan, or a new filter arrives in your destination as expected. +- **When data is missing from your destination**: The pipeline view can help you see where your data is getting "stuck" on the way to your destination, which can help you quickly diagnose and address problems in your data pipeline. +- **When emission or delivery volume fluctuates out of expected norms**: Delivery Overview will highlight where the largest rate change(s) occurred and what events were associated with the change. + +> info "Delivery Overview in Engage Destinations" +> Because Engage uses sources for multiple purposes, you can expect to see `filtered at destination` events with the integrations object in destinations linked to Engage. Engage uses the integrations object to route events to destinations you've added to your audiences, traits, and journey steps. As a result, some events aren't meant to be delivered by the destination, so the integrations object filters them. + +## Where do I find Delivery Overview? +To view the Delivery Overview page: +1. Sign into Segment. +2. From the homepage, navigate to **Connection** > **Destinations** and click on the destination you'd like to investigate. +3. Select the **Delivery Overview** tab from the destination header. + +## How do I use Delivery Overview? +To use Delivery Overview: + +1. Navigate to the destination you'd like to review, and select **Delivery Overview** from the destination header. +2. On the **Delivery Overview** tab, select a time period from the time picker. The time picker reflects data in the user's local time.
___Optional___: *Turn the metric toggle off if you'd like to see the quantity of events as counts instead of percentages. Delivery Overview shows percentages by default.* +3. Select a success or discard step to view additional context about the events that passed through that step. + +## How does Delivery Overview differ from other Segment monitoring and observability tools? +With Source Debugger or Event Delivery, you can only verify that events are successfully making it from your source or to your destination. If events fail, you have to troubleshoot to see where in the pipeline your events are getting stuck. With Event Tester, you can verify that your event makes it from your source to your destination, but if the results aren't what you expected, you're stuck troubleshooting your source, filters, tracking plans, and destinations. + +With Delivery Overview, you can verify that your source receives your events, that any filters and tracking plans work as expected, and that events successfully make it to your destination. Any errors or unexpected behavior can be identified using the pipeline view, leading to quicker resolution. + +## How can I configure alerts? + +You can use the Event Delivery alerting features (Delivery Alerts) by selecting the **Alerts** tab in the destination header. Once you enable alerts, if the successful delivery rate of all events is less than the threshold percentage in the last 24 hours, you'll be notified through in-app notification and/or workspace email. + +Note that this is dependent on your [notification settings](/docs/segment-app/#segment-settings). For example, if the threshold is set to 99%, then you'll be notified each time less than 100% of events fail. + +You can also use Connections Alerting, a feature that allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection. + +Connections Alerting allows you to create two different alerts: +- **Source volume alerts**: These alerts notify you if your source ingests an abnormally small or large amount of data. For example, if you set a change percentage of 4%, you would be notified when your source ingests less than 96% or more than 104% of the typical event volume. +- **Successful delivery rate alerts**: These alerts notify you if your destination's successful delivery rate falls outside of a percentage that you set. For example, if you set a percentage of 99%, you would be notified if you destination had a successful delivery rate of 98% or below. + +## How "fresh" is the data in Delivery Overview? +The data in Delivery Overview has an expected latency of approximately 30 seconds after event ingestion, but this may vary, depending on the features you’ve enabled in your workspace and spikes in volume. Segment delays the data visible in the Delivery Overview UI by 5 minutes to allow for more precise metric correlation. Segment does not impose the 5 minute delay if you access data using the Public API. + +## Why is the Delivery Overview page only available for cloud-mode destinations? +Similar to Segment's [Event Delivery](/docs/connections/event-delivery/) feature, the Delivery Overview page is only available for server-side integrations (also known as cloud-mode destinations). You won't be able to use the Delivery Overview page for client side integrations (also known as device-mode destinations) because device-mode data is sent directly to the destination tool's API. In order to report on deliverability, data must be sent to destinations using a server-side connection. + +## Troubleshooting + +The Delivery Overview pipeline steps Failed on Ingest, Filtered at Source, Filtered at Destination, and Failed Delivery display a [discard table](#discard-table) with information about why your events failed or were discarded. + +This table provides a list of all possible discard reasons available at each pipeline step. + +{% include content/delivery-overview-discards.html %} + \ No newline at end of file diff --git a/src/connections/destinations/actions.md b/src/connections/destinations/actions.md index b77f0a9ef3..6681fb62b6 100644 --- a/src/connections/destinations/actions.md +++ b/src/connections/destinations/actions.md @@ -1,18 +1,14 @@ --- title: Destination Actions +plan: dest-actions --- -{% include content/plan-grid.md name="dest-actions" %} - The Destination Actions framework improves on classic destinations by enabling you to see and control how Segment sends the event data it receives from your sources, to actions-based destinations. Each Action in a destination lists the event data it requires, and the event data that is optional. You can also choose which event types, event names, or event property values trigger an Action. These Triggers and mappings make it possible to send different versions of the Action, depending on the context from which it is triggered. Each Actions-framework Destination you see in the Segment catalog represents a feature or capability of the destination which can consume data from your Segment source. The Action clearly lists which data from the events it requires, and which data is optional. For example, Amplitude requires that you always send a `LogEvent` , or Slack always requires a `PostMessage`. Each Action also includes a default mapping which you can modify. -{% include content/ajs-upgrade.md %} - - ## Benefits of Destination Actions - **Easier setup**: Users see fewer initial settings which can decrease the time spent configuring the destination. @@ -70,9 +66,6 @@ To set up a new Actions-framework destination for the first time: ## Migrate a classic destination to an actions-based destination -{% include content/ajs-upgrade.md %} - - Moving from a classic destination to an actions-based destination is a manual process. Segment recommends that you follow the procedure below: 1. Create the actions-based destination with your development or test source. @@ -82,6 +75,69 @@ Moving from a classic destination to an actions-based destination is a manual pr 5. Verify that data is flowing from the development or test source to the partner tool. 6. Repeat the steps above with your production source. +### Migrate your destination filters from the classic destination to the actions destination + +> warning "" +> You can only migrate your destination filters using the Public API if you're on the business tier plan. This functionality isn't available in the Segment app. + +To migrate your destination filters to your actions destination from the classic destination: +1. Send a request to the Public API endpoint. + - Use [List Filters from Destination](https://docs.segmentapis.com/tag/Destination-Filters#operation/listFiltersFromDestination){:target="_blank"} . The `destinationId` can be found in the URL while viewing the destination in your Segment workspace. +2. Grab the response and parse through the `data.filters` object. Each object returned inside the `data.filters` object is an individual filter associated with the specified destination. +4. Send individual `POST` requests to the Public API endpoint. + - Use [Create Filter for Destination](https://docs.segmentapis.com/tag/Destination-Filters/#operation/createFilterForDestination){:target="_blank"} , for each of the filters from step 2. + - Specify the Actions `destinationId`, found in the URL when viewing that destination. The body of the request is the individual filters from step 2. +6. If the bodies of those requests don't already include the field `"enabled": true`, make sure to enable each of those filters after you create them. + +### Migrate to an actions-based destination using Destination Filters +For a more comprehensive migration from a classic destination to an actions-based destination, follow the steps outlined below. This implementation strategy is only available for customers on a Segment Business Tier plan with access to [Destination Filters](/docs/connections/destinations/destination-filters/). By adding additional line of defense with Destination Filters, you remove the possibility of duplicate events or dropped events and ensure that events sent before/after a specified `received_at` timestamp are sent to each destination. + +This migration strategy involves configuring a destination filter on both the Classic destination and the Actions destination. Configure the classic destination filter to block events by the `received_at` field with a certain value, and the Actions destination to drop events until the `received_at` timestamp field reaches that same value. Destination Filters within the UI have a limitation where they cannot access any top-level fields, but this is not a limitation for [Destination Filters](https://docs.segmentapis.com/tag/Destination-Filters/){:target="_blank”} created by the [Public API](https://segment.com/docs/api/public-api/){:target="_blank”} using [FQL](https://segment.com/docs/api/public-api/fql/){:target="_blank”}. Because the `received_at` is a top-level field in the payload, you'll need to create a destination filter with the Public API and submit the request with that FQL information described below. + +By combining these Filters, Segment sends events through the Classic integration up until a specified time and then blocks events after that time. Then the Actions integration blocks events until that specified time, and only allows events beginning at that specified time. + +The following code samples show you how you can create filters for your destinations using the [Create Filter for Destination](https://docs.segmentapis.com/tag/Destination-Filters#operation/createFilterForDestination){:target="_blank”} Public API operation. + +#### Classic destination +_Endpoint_: `POST` `https://api.segmentapis.com/destination/classic_destination_id_from_url/filters` +``` +// JSON BODY : +{ + "sourceId": "add_source_id_here", + "destinationId": "classic_destination_id_from_url", + "title": "drop event after (timestamp) received_at > value April 4, 2023 19:55pm", + "description": "drop event after (timestamp) received_at > value April 4, 2023 19:55pm", + "if": "(received_at >= '2023-04-21T19:55:00.933Z')", + "actions": [ + { + "type":"DROP" + } + ], + "enabled": true +} +``` + +#### Actions destination +_Endpoint_: `POST` `https://api.segmentapis.com/destination/actions_destination_id_from_url/filters` +``` +// JSON BODY : +{ + "sourceId": "add_source_id_here", + "destinationId": "actions_destination_id_from_url", + "title": "drop event before (timestamp) received_at < value April 4, 2023 19:55pm", + "description": "drop event before (timestamp) received_at < value April 4, 2023 19:55pm", + "if": "(received_at < '2023-04-21T19:55:00.933Z')", + "actions": [ + { + "type":"DROP" + } + ], + "enabled": true +} +``` + +After configuring the Destination Filter on both the Classic and Actions destination, see each destination's Filters tab and enable the filters. After completing the migration, you can disable the Classic destination on the Settings page, and remove each of the filters from both destinations. + ## Edit a destination action You can add or remove, disable and re-enable, and rename individual actions from the Actions tab on the destination's information page in the Segment app. Click an individual action to edit it. @@ -89,6 +145,8 @@ From the edit screen you can change the action's name and mapping, and toggle it  +When an Action is created, it's disabled by default, to ensure that it's only used after being fully configured. To begin sending data through an Action, enable it on the Actions page by selecting the toggle so that it appears blue. + ## Disable a destination action If you find that you need to stop an action from running, but don't want to delete it completely, you can click the action to select it, then click the toggle next to the action's name to disable it. This takes effect within minutes, and disables the action until you reenable it. @@ -119,11 +177,13 @@ If necessary, click **New Mapping** to create a new, blank action. 1. In the edit panel, define the [conditions](#conditions) under which the action should run. 2. Test those conditions to make sure that they correctly match an expected event. This step looks for events that match the criteria in the [debugger queue](/docs/connections/sources/debugger/), so you might need to Trigger some events with the expected criteria to test your conditions. You can skip the test step if needed, and re-try it at any time. -3. Next, set up the data mapping from the Segment format to the destination tool format. -4. Test the mapping with data from a sample event. - The edit panel shows you the mapping output in the format for the destination tool. You can change your mapping as needed and re-test. -5. When you're satisfied with the mapping, click **Save**. Segment returns you to the Mappings table. -6. In the Mappings table **Status** column, verify that the **Enabled** toggle is on for the mapping you just customized. +3. Select data models to [enrich your events](/docs/unify/linked-profiles/linked-events/) with. +4. Set up the data mapping from the Segment format to the destination tool format. +- You can click the Source field, then select the **Enrichments** tab to view and select Enrichments to use. +5. Test the mapping with data from a sample event. + The edit panel shows you the mapping output in the format for the destination tool. The **Select Object** option sends the entire object from the event, while the **Edit Object** option lets you map each individual property. You can change your mapping as needed and re-test. +6. When you're satisfied with the mapping, click **Save**. Segment returns you to the Mappings table. +7. In the Mappings table **Status** column, verify that the **Enabled** toggle is on for the mapping you just customized. > info "" @@ -133,7 +193,9 @@ If necessary, click **New Mapping** to create a new, blank action. The coalesce function takes a primary value and uses it if it is available. If the value isn't available, the function uses the fallback value instead. +### Replace function +The replace function allows you to replace a string, integer, or boolean with a new value. You have the option to replace up to two values within a single field. ### Conditions @@ -141,7 +203,7 @@ The coalesce function takes a primary value and uses it if it is available. If t > Self-service users can add a maximum of two conditions per Trigger. -The following type filters and operators are available to help you build conditions: +Mapping fields are case-sensitive. The following type filters and operators are available to help you build conditions: - **Event type** (`is`/`is not`). This allows you to filter by the [event types in the Segment Spec](/docs/connections/spec). - **Event name** (`is`, `is not`, `contains`, `does not contain`, `starts with`, `ends with`). Use these filters to find events that match a specific name, regardless of the event type. @@ -150,6 +212,10 @@ The following type filters and operators are available to help you build conditi You can specify nested properties using dot notation, for example `context.app.name`. If the property might appear in more than one format or location, you can use an ANY statement and add conditions for each of those formats. For example, you might filter for both `context.device.type = ios` as well as `context.os.name = "iPhone OS``"` The `does` `not exist` operator matches both a `null` value or a missing property. {% comment %} + +> info "Valid property and trait values" +> Property and trait names must begin with the characters: [a-z], [A-Z] or '_'. Property and trait names don't support special characters in the first character. If you save a property or trait with a special character in the first character, you'll get an Invalid Trigger error. + > info "Event property operators and supported data types" > Operators support matching on values with a **string** data type: > - `is`, `is not`, `contains`, `does not contain`, `starts with`, `ends with` @@ -172,7 +238,10 @@ The available operators depend on the property's data type: You can combine criteria in a single group using **ALL** or **ANY**. Use an ANY to “subscribe” to multiple conditions. Use ALL when you need to filter for very specific conditions. You can only create one group condition per destination action. You cannot created nested conditions. > info "Unsupported Special Characters" -> Mappings do not support the use of double quotes " or a tilde ~ in the trigger fields. +> Mappings do not support the use of double quotes " or a tilde ~ in the trigger fields. In mapping fields, the . character is not supported unless it's being used to access an object key. If a string has a . in it, that is not supported. + +> info "Limitations" +> Mapping fields don't support dot notation. For example, properties.amount.cost or properties_amount.cost aren't supported. > info "Destination Filters" > Destination filters are compatible with Destination Actions. Consider a Destination Filter when: @@ -181,12 +250,33 @@ You can combine criteria in a single group using **ALL** or **ANY**. Use an ANY > > If your use case does not match these criteria, you might benefit from using Mapping-level Triggers to match only certain events. -## FAQ & Troubleshooting +## FAQ and troubleshooting ### Validation error when using the Event Tester When you send an event with an actions destination Event Tester that doesn't match the trigger of any configured and enabled mappings, you'll see an error message that states, *You may not have any subscriptions that match this event.* To resolve the error, create a mapping with a trigger to handle the event being tested, or update the test event's payload to match the trigger of any existing mappings. +### Data not sending downstream + +If no mappings are enabled to trigger on an event that has been received from the connected source, the destination will not send any events. Ensure that at least one mapping has been configured and enabled in the destination mappings for an event that you would like to reach downstream. + +> info "" +> Events without mappings enabled to handle them display as being discarded due to "No matching mapping" in a destination's Delivery Overview. + ### Multiple mappings triggered by the same event When the same event triggers multiple mappings, a request will be generated for each mapping that's configured to trigger on an event. For example, for the *Subscription Updated* event, if two mappings are enabled and both have conditions defined to trigger on the *Subscription Updated* event, the two requests will be generated and sent to the destination for each *Subscription Updated* event. + +### Oauth "access token expired" message shown in Segment UI +Access Tokens that were generated from initial authorization, for example, when you connect a destination via Oauth, are always short-lived. Commonly, the token remains valid for 30 minutes to 1 hour. When Segment receives 401 error responses from the destination after a token has expired, it will automatically make another request to the destination for a new token and will then retry the event. Therefore, 401 responses are sometimes expected and do not indicate an event failure. There are three event flows when events are received and sent to a destination: + +- through source +- through event tester +- through actions tester in mapping screen + +The underlying systems for these flows have their own copy of the token, which can expire at different points in time. +Threfore, if you see a 401 error in a sample response, it is likely that you’ll also see another request was made after it, to ask the downstream destination for a new token. Then one more request was made to actually send the data in your payload to the downstream destination. + +### Is it possible to map a field from one event to another? + +Segment integrations process events through mappings individially. This means that no context is held that would allow you to map a value from one event to the field of a subsequent event. Each event itself must contain all of the data you'd like to send downstream in regards to it. For example, you cannot send `email` in on an Identify call and then access that same `email` field on a Track call that comes in later if that Track call doesn't also have `email` set on it. diff --git a/src/connections/destinations/add-destination.md b/src/connections/destinations/add-destination.md index f38593aaa2..a28a475d20 100644 --- a/src/connections/destinations/add-destination.md +++ b/src/connections/destinations/add-destination.md @@ -2,13 +2,17 @@ title: Sending Segment Data to Destinations --- -You've decided how to format your data, and collected it using [Segment Sources](/docs/connections/sources/). Now what do you do with it? You send the data to Destinations! +You've decided how to format your data, and collected it using [Segment Sources](/docs/connections/sources/). Now what do you do with it? You send the data to Destinations. Destinations are tools or services which can use the data sent from Segment to power analytics, marketing, customer outreach, and more. > info "" -> Each Segment Workspace has its own set of destinations, which are connected to the workspace's sources. When you add or modify a destination, make sure you're working with the correct workspace! +> Each Segment Workspace has its own set of destinations, which are connected to the workspace's sources. When you add or modify a destination, make sure you're working with the correct workspace. +> info "Healthcare and Life Sciences (HLS) customers can encrypt data flowing into their destinations" +> HLS customers with a HIPAA eligible workspace can encrypt data in fields marked as Yellow in the Privacy Portal before they flow into an event stream, cloud-mode destination. +> +> To learn more about data encryption, see the [HIPAA Eligible Segment documentation](/docs/privacy/hipaa-eligible-segment/#data-encryption). ## Adding a destination @@ -31,7 +35,7 @@ There are two ways to add a destination to your deployment: using the Segment we 8. Click the toggle at the top of the Settings page to enable the destination. > success "" -> If you have more than one instance of the same destination, you can click **Copy Settings From Other Destination** to save yourself time entering the settings values. +> If you have more than one instance of the same destination, you can click **Copy Settings From Other Destination** to save yourself time entering the settings values manually. #### Adding a destination to a specific Segment Source @@ -58,7 +62,7 @@ You can use the Segment Public API to add destinations to your workspace using t Adding a destination can have a few different effects, depending on which sources you set up to collect your data, and how you configured them. -#### Analytics.js +### Analytics.js If you are using [Segment's JavaScript library, Analytics.js](/docs/connections/sources/catalog/libraries/website/javascript/), then Segment handles any configuration changes you need for you. If you're using Analytics.js in cloud-mode, the library sends its tracking data to the Segment servers, which route it to your destinations. When you change which destinations you send data to, the Segment servers automatically add that destination to the distribution list. @@ -66,13 +70,13 @@ If you're using Analytics.js in device-mode, then Analytics.js serves as a wrapp You can enable device-mode for some destinations from the destination's Settings page in the Segment web app. You don't need to use the same mode for all destinations in a workspace; some can use device-mode, and some can use cloud-mode. -#### Mobile sources +### Mobile sources By default, Segment's [mobile sources](/docs/connections/sources/catalog/#mobile) send data to Segment in cloud-mode to help minimize the size of your apps. In cloud-mode the mobile source libraries forward the tracking data to the Segment servers, which route the data to the destinations. Since the Segment servers know which destinations you're using, you don't need to take any action to add destinations to mobile apps using cloud-mode. However, if the destination you're adding has features that run on the user's device, you might need to update the app to package that destination's SDK with the library. Some destinations require that you package the SDK, and some only offer it -#### Server sources +### Server sources Segment's [server sources](/docs/connections/sources/catalog/#server) run on your internal app code, and never have access to the user's device. They run in cloud-mode only, and forward their tracking calls to the Segment servers, which forward the data to any destinations you enabled. @@ -98,6 +102,19 @@ For example, you might set up a single Segment source to send data both to separ You can also connect multiple instances of a destination to help you smoothly migrate from one configuration to another. By sending each version the same data, you can check and validate the new configuration without interrupting use of the old one. +However, there are a few considerations: + +Device-mode destinations do not support connecting multiple instances of the destination to the same source. If you try to a connect an additional instance of a device-mode destination to your source, the option to add a second instance does not appear. + +Mobile sources, and the legacy Project source, can connect to multiple instances of destinations that operate only in cloud-mode. Mobile and Project sources cannot connect to multiple instances of destinations that operate in both cloud-mode and device-mode. Non-mobile sources can only connect to _one_ device-mode instance of a destination. + +Multi-instance support is not available for most hybrid Actions destinations or Web mode Actions destinations. + +Segment does not support connecting a single source to multiple instances of a [Data Lakes](/docs/connections/storage/data-lakes/) destination. + +> warning "Non-mobile sources can only connect to _one_ device-mode instance of a destination" +> You cannot connect a source to more than one instance of a destination that operates only in device-mode. For more information about device-mode restrictions, see the [Sending Segment data to Destinations](/docs/connections/destinations/add-destination/#connecting-one-source-to-multiple-instances-of-a-destination:~:text=Multi%2Dinstance%20destinations-,and,-Device%2Dmode) documentation. + > success "" > If your organization is on a Segment Business tier plan, you can use [Replay](/docs/guides/what-is-replay/) to send historical data to new instances of a destination. @@ -114,6 +131,8 @@ Some destinations do not support having multiple instances connected to the same You can create unique destination filters for each destination instance connected to the same source. +> info "" +> Some destinations don't support multiple instances connected to the same source. If this is the case, you won't see the option to add a second instance of that destination. ### Connect multiple sources to one instance of a destination diff --git a/src/connections/destinations/catalog/1flow-analytics/index.md b/src/connections/destinations/catalog/1flow-analytics/index.md index e108e006db..a48bc5ee5e 100644 --- a/src/connections/destinations/catalog/1flow-analytics/index.md +++ b/src/connections/destinations/catalog/1flow-analytics/index.md @@ -5,7 +5,7 @@ hidden: true published: false --- -[1Flow](https://1flow.app/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses. +[1Flow](https://1flow.app/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses. Using 1Flow, you can reach users _in-the-moment_ while they are interacting with your website or application, to collect highly contextual user insights that help you improve your product offering and customer experience. @@ -17,7 +17,7 @@ This destination is maintained by 1Flow. For any issues with the destination, [c 1. From the Destinations catalog page in the Segment App, click **Add Destination**. 2. Search for **1Flow** in the Destinations Catalog, and select the **1Flow** destination. 3. Choose which Source should send data to the 1Flow destination. -4. Go to the [1Flow dashboard](https://dashboard.1flow.app/){:target="\_blank"} and find the **API Key** in Project Settings. +4. Go to the [1Flow dashboard](https://dashboard.1flow.app/){:target="_blank"} and find the **API Key** in Project Settings. 5. Enter the **API Key** in the 1Flow destination settings in Segment. ## Supported methods diff --git a/src/connections/destinations/catalog/1flow-mobile-plugin/index.md b/src/connections/destinations/catalog/1flow-mobile-plugin/index.md new file mode 100644 index 0000000000..3d5f58188a --- /dev/null +++ b/src/connections/destinations/catalog/1flow-mobile-plugin/index.md @@ -0,0 +1,133 @@ +--- +title: 1Flow Mobile Plugin Destination +id: 64dd07c1fed86b6866cd93f5 +beta: true +--- + +[1Flow](https://1flow.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses. + +Using 1Flow, you can reach users _in-the-moment_ while they are interacting with your website or application, to collect highly contextual user insights that help you improve your product offering and customer experience + +The 1Flow Mobile Plugin Destination is open-source and available on GitHub. You can view these repositories here: + +- [iOS](https://github.com/1Flow-Inc/segment-1flow-ios.git){:target="_blank"} +- [Android](https://github.com/1Flow-Inc/segment-1flow-android.git){:target="_blank"} + +This destination is maintained by 1Flow. For any issues with the destination, [contact Support team](mailto:support@1flow.app). + +## Getting started + +1. From the Segment web app, click **Catalog**, then search for **1Flow Mobile Plugin**. +2. Click **Add Destination**. +4. Select an existing Source to connect to 1Flow Mobile Plugin. +5. Go to 1flow.ai -> Settings -> Project Settings, copy the 1Flow project key, and paste it into the Destination Settings in Segment. +6. Depending on the mobile source you’ve selected, include 1Flow's library by adding the following lines to your dependency configuration. + +## iOS + +### Step 1: Add Segment1Flow Package using Swift Package Manager + +In the Xcode File menu, click Add Packages. You'll see a dialog where you can search for Swift packages. In the search field, enter the URL to this repo. + +- `https://github.com/1Flow-Inc/segment-1flow-ios` + +You'll then have the option to pin to a version, or specific branch, as well as which project in your workspace to add it to. Once you've made your selections, click the Add Package button. + +### Step 2: Initialize Segment and add 1Fow Destination + +``` +import Segment1Flow +... +let config = Configuration(writeKey: "YOUR_WRITE_KEY_HERE") +let analytics = Analytics(configuration: config) +analytics.add(plugin: OneFlowDestination()) +``` + +## Android + +### Step 1: Install Segment1Flow Package + +- If gradle version is 6.5 or lower, include the below repository in your project's build.gradle file: + +``` +allprojects{ + repositories{ + google() + jcenter() + maven{url 'https://jitpack.io'} + } +} +``` + +- If gradle version is higher than 6.5, add the below code in settings.gradle. + +``` +dependencyResolutionManagement { + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) + repositories { + google() + mavenCentral() + maven{url 'https://jitpack.io'} + } +} +``` + +- Add dependency in your app's build.gradle file: + +``` +compileSdkVersion 34 +.... +defaultConfig { + .... + minSdkVersion 21 + } +dependencies { + .... + + implementation 'com.segment.analytics.android:analytics:4.11.3' + implementation "com.github.1Flow-Inc:segment-1flow-android:2023.09.26" +} +``` + +### Step 2: Initialize Segment and add 1Flow Destination +``` +Analytics analytics = new Analytics.Builder(context, "YOUR_WRITE_KEY_HERE") + .use(OneFlowIntegration.FACTORY) + ... + .build(); + ... + Analytics.setSingletonInstance(analytics); + +``` + +## Supported methods + +### Identify +If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like: + +```swift +analytics.identify(userId: "peter@example.com", traits: [ + "name": "Peter Gibbons", + "email": "peter@example.com", + "mobile": 1234567890 +]) +``` +When you call identify method of segment, it will be equivalent to `logUser` of 1Flow. `userId` will be `userID` and `traits` will be `userDetails`. + +### Track +If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like: + +```swift +analytics.track(name: "ButtonClicked") +``` +Any value passed in `name`, will be eventName and if you have passed any event property, then it will be event `parameters`. + +### Screen + +Send [Screen](/docs/connections/spec/screen) calls to record which mobile app screens users have viewed. For example: + +```swift +analytics.screen(title: "Home") +``` + +Segment sends Screen calls to 1Flow as a `screen_[name]` event (or `screen_view` if a screen name isn't provided). diff --git a/src/connections/destinations/catalog/1flow-web-actions/index.md b/src/connections/destinations/catalog/1flow-web-actions/index.md new file mode 100644 index 0000000000..3d8000dd5e --- /dev/null +++ b/src/connections/destinations/catalog/1flow-web-actions/index.md @@ -0,0 +1,7 @@ +--- +title: '1Flow Web (Actions) Destination' +hidden: true +id: 656773f0bd79a3676ab2733d +published: false +beta: true +--- diff --git a/src/connections/destinations/catalog/1flow/index.md b/src/connections/destinations/catalog/1flow/index.md index 9c132ec9ad..508e5bfd85 100644 --- a/src/connections/destinations/catalog/1flow/index.md +++ b/src/connections/destinations/catalog/1flow/index.md @@ -5,7 +5,7 @@ redirect_from: - '/connections/destinations/catalog/1flow-analytics' --- -[1Flow](https://1flow.app/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses. +[1Flow](https://1flow.app/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses. Using 1Flow, you can reach users _in-the-moment_ while they are interacting with your website or application, to collect highly contextual user insights that help you improve your product offering and customer experience. @@ -16,7 +16,7 @@ This destination is maintained by 1Flow. For any issues with the destination, [c 1. From the Destinations catalog page in the Segment App, click **Add Destination**. 2. Search for **1Flow** in the Destinations Catalog, and select the **1Flow** destination. 3. Choose which Source should send data to the 1Flow destination. -4. Go to the [1Flow dashboard](https://dashboard.1flow.app/){:target="\_blank"} and find the **API Key** in Project Settings. +4. Go to the [1Flow dashboard](https://dashboard.1flow.app/){:target="_blank"} and find the **API Key** in Project Settings. 5. Enter the **API Key** in the 1Flow destination settings in Segment. ## Supported methods diff --git a/src/connections/destinations/catalog/2mee/index.md b/src/connections/destinations/catalog/2mee/index.md index dbdb52227e..03706fdde7 100644 --- a/src/connections/destinations/catalog/2mee/index.md +++ b/src/connections/destinations/catalog/2mee/index.md @@ -3,19 +3,19 @@ title: 2mee Destination rewrite: true id: 60b5d0a01f3726b85dc05aab --- -[2mee](https://2mee.com ) is a Human Hologram platform that automatically cuts the person out from the background, removing the visual clutter, and places them in the familiar context of your phone or website so that they dominate the screen. +[2mee](https://2mee.com){:target="_blank”} is a Human Hologram platform that automatically cuts the person out from the background, removing the visual clutter, and places them in the familiar context of your phone or website so that they dominate the screen. This destination is maintained by 2mee. For any issues with the destination, [contact the 2mee Support team](mailto:support@2mee.com). ## Getting Started -{% include content/connection-modes.md %} + 1. From the Destinations catalog page in the Segment App, click **Add Destination**. 2. Search for **2mee** in the Destinations Catalog and it. 3. Click **Configure 2mee**. 4. Choose which Source should send data to the 2mee destination. -5. Go to 2mee and copy the [API Key and Application ID](https://docs.2mee.com/documentation/segment) from the 2mee Dashboard. +5. Go to 2mee and copy the [API Key and Application ID](https://docs.2mee.com/documentation/segment){:target="_blank”} from the 2mee Dashboard. 6. Go back to Segment and paste the API Key and Application ID you just copied in the 2mee destination settings. Make sure to paste the API Key in this format: `Bearer
* An association record fails if there is more than one record returned from the search association object.
* An association skips if no record is found with the data provided in key:value format. +ObjectType to associate | To associate the newly created and updated custom object record with another object type, select the object type you want it to be associated with. +Association Label | Select an association label between both the object types. From the HubSpot Dashboard, you can create associations between any type of object. To create an association label:
1. Log in to the [HubSpot Dashboard](https://app.hubspot.com/){:target="_blank"}.
2. Go to **Data Management > Objects > Custom Objects**.
3. Go to the **Associations** tab and click **Create association label**. + +## FAQ and troubleshooting ### How do I send other standard objects to HubSpot? Segment provides prebuilt mappings for contacts and companies. If there are other standard objects you would like to create records in, please use the **Create Custom Object Record** action. For example, to create a deal in HubSpot, add a mapping for Create Custom Object Record, set up your Event Trigger criteria, and input a literal string of "deals" as the Object Type. You can use the Properties object to add fields that are in the [deals object](https://developers.hubspot.com/docs/api/crm/deals){:target="_blank"}, such as `dealname` and `dealstage`. The same can be done with other object types (for example, tickets, quotes, etc). Ending fields that are to go to HubSpot outside of the properties object isn't supported. This includes sending [associations](https://developers.hubspot.com/docs/api/crm/associations){:target="_blank"}. Please note, Segment only supports creating new records in these cases; updates to existing records are only supported for contacts and companies. - +### How do I send `Page` events to HubSpot? +The [Track Page View action](/docs/connections/destinations/catalog/actions-hubspot-web/#track-page-view) is only available in [HubSpot Web (Actions) destination](/docs/connections/destinations/catalog/actions-hubspot-web/). As a workaround, with HubSpot Cloud Mode (Actions) destination, you can use the [Custom Behavioral Event](/docs/connections/destinations/catalog/actions-hubspot-cloud/#send-custom-behavioral-event) to send Page events to Hubspot. You'll need to [follow Hubspot's instructions](https://knowledge.hubspot.com/analytics-tools/create-custom-behavioral-events-with-the-code-wizard){:target="_blank"} to create a custom behavioral event for `Page Viewed` in HubSpot. ### Why aren't my custom behavioral events appearing in HubSpot? 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, the request will fail. See [HubSpot documentation](https://knowledge.hubspot.com/analytics-tools/create-custom-behavioral-events#define-the-api-call){:target="_blank"} for other limits. -> note "" -> A HubSpot Enterprise Marketing Hub account is required to send Custom Behavioral Events. +### How do I resolve a `403` error for custom behavioral events? +`403` errors indicate that Segment is unable to send your event to HubSpot because the account connected doesn't have sufficient permissions. If you're observing `403` errors for Custom Behavioral Events, ensure that your HubSpot account is a `HubSpot Enterprise Marketing Hub` account. After upgrading your account to `Enterprise Marketing Hub`, **Reauthorize** from the **Settings** page of your destination to resolve the `403` errors. + +### Why can't I set an entire object for the Other properties field? + +This destination doesn't allow selecting an entire object for the Other properties field. HubSpot rejects API calls if a property name doesn't match with HubSpot's internal name. When working with a large object of key/value pairs, map each key/value pair to prevent rejection. This ensures that every key matches the pre-created property names in HubSpot. ### Does the HubSpot Cloud Mode (Actions) destination support EU data residency? Yes. HubSpot will automatically redirect API requests directly to an EU data center if your HubSpot instance is on an EU data center. See more in HubSpot's [Routing API Traffic](https://product.hubspot.com/blog/routing-api-traffic){:target="_blank"} article. +### How do I attribute a custom behavioral event with a user token instead of Email? +Event payloads should contain an email with either a valid format, empty string, or a `null` value. As a result, the user token takes precedence and is validated in a `Send custom behavioral event` mapping. Segment can't deliver the event to your destination if the email is invalid. + +### How can I disable or delete a destination from Segment? +Follow the instructions in the docs to [disable](/docs/connections/destinations/actions/#disable-a-destination-action) or [delete](/docs/connections/destinations/actions/#delete-a-destination-action) a destination action from Segment. + +### How can I uninstall an app from my HubSpot account? +Follow the steps mentioned [here](https://knowledge.hubspot.com/integrations/connect-apps-to-hubspot#uninstall-an-app){:target="_blank"} to uninstall or disconnect an app from your HubSpot account. + +### How does disconnecting and uninstalling affect a user's data and HubSpot account? +Segment immediately stops sending data to HubSpot after you disconnect and uninstall a HubSpot account. + +### Understanding HubSpot's `date` and dateTime` custom property types +If you plan on sending a _date_ value that includes time data to your mapped HubSpot custom properties, select HubSpot's `dateTime` property type in HubSpot. If you plan to send a _date_ value that does not contain time data, select the `date` property value in HubSpot. For more information about custom property types, see HubSpot's [Custom objects](https://developers.hubspot.com/docs/api/crm/crm-custom-objects#properties){:target="_blank”} documentation. + +If you send a _date_ value that contains time data to a custom property in HubSpot with a `date` property type, the event might fail due to an "**Invalid Date Error**." + +Both of HubSpot's _date_ property types each accept ISO 8601 formatted values, but only the `dateTime` property type accepts values that include time data. diff --git a/src/connections/destinations/catalog/actions-hyperengage/index.md b/src/connections/destinations/catalog/actions-hyperengage/index.md new file mode 100644 index 0000000000..6f48d9d027 --- /dev/null +++ b/src/connections/destinations/catalog/actions-hyperengage/index.md @@ -0,0 +1,34 @@ +--- +title: Hyperengage (Actions) Destination +hide-boilerplate: true +hide-dossier: true +beta: true +private: true +id: 651c1db19de92d8e595ff55d +--- + +{% include content/plan-grid.md name="actions" %} + +[Hyperengage](https://hyperengage.io/){:target="_blank"} tracks thousands of data points to trigger smart alerts on hidden opportunities when the accounts are ready for upsell, or likely to churn. By integrating product data into your GTM strategy, Hyperengage's platform empowers CSM’s and AE’s to achieve up to 5x higher lead conversion and better retention and adoption. + +## Benefits of Hyperengage (Actions) + +Hyperengage (Actions) offers several advantages: + +- **Seamless Data Mapping**: Hyperengage streamlines the process of syncing your user and account data. When you link your data with Segment, Hyperengage automatically processes Segment's Identify, Track, and Group calls, eliminating the need for manual API integrations. +- **Pre-configured Mappings**: The Hyperengage (Actions) Destination has prebuilt mappings tailored for Hyperengage with all the necessary parameters, reducing the need for manual customization. +- **Direct Data Transfer**: Data moves straight from Segment to Hyperengage, eliminating the need for third-party intermediaries. +- **Event Tracking and User Identification**: With Segment's Actions-based destination, you can keep track of events and identify users and organizations in Hyperengage. + +## Getting started + +1. From the Segment web app, navigate to **Connections > Catalog**, then select **Destinations**. +2. In the Destinations Catalog, search for "Hyperengage" and select the Hyperengage (Actions) destination. +3. Click **Add destination**. +4. Choose an existing source to connect to Hyperengage (Actions) and click **Next**. +5. Enter a name for your destination and click **Create destination**. +6. Open the [Hyperengage App](https://hyperengage.io/){:target="_blank"}, proceed to **Integration Settings**, and copy the API Key and Workspace Identifier. +7. Open the Segment app, navigate to your Hyperengage (Actions) destination, and paste the API Key and Workspace Identifier into the destination's settings page. + + +{% include components/actions-fields.html %} \ No newline at end of file diff --git a/src/connections/destinations/catalog/actions-insider-audiences/index.md b/src/connections/destinations/catalog/actions-insider-audiences/index.md new file mode 100644 index 0000000000..81c6b27f0f --- /dev/null +++ b/src/connections/destinations/catalog/actions-insider-audiences/index.md @@ -0,0 +1,50 @@ +--- +title: Insider Audiences (Actions) +id: 643698ffee21b544f6aa756a +hide-boilerplate: true +hide-dossier: true +--- + +{% include content/plan-grid.md name="actions" %} + +[Insider](https://useinsider.com/integration/segment/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} Growth Management Platform (GMP) helps digital marketers drive growth across the funnel. Insider GMP helps marketers deliver personalized journeys across the web, mobile web, mobile apps, messaging, email, and ad channels using the unified data. + +This destination is maintained by Insider. For any issues with the destination, contact the [Insider Support team.](mailto:insiderhelp@useinsider.com){:target="_blank"} + +## Getting started + +> info "Prerequisites" +> Before connecting to the [Insider Audiences (Actions) destination](/docs/connections/destinations/catalog/actions-insider-audiences/), you must have an Insider Account, Account Name, and a [Unified Customer Database API Key](https://academy.useinsider.com/docs/api-authentication-tokens){:target="_blank"}. + +To add the Insider Audiences Destination: + +1. From your Segment workspace, navigate to **Connections > Catalog** and select the **Destinations** tab. + +2. Search for **Insider Audiences** and select the destination. + +3. Click **Add destination**. + +4. Select the space in Engage to use as the Source as this destination only supports sending Engage Audiences to Insider. + +5. Name your destination on the settings tab. + +6. Add the following settings to your Insider Destinations: + + - **Account Name**: Your Insider Account (Partner) Name. + - **API Key**: Your Unified Customer Database API Key. See how you can generate the API key in the [Insider Academy API Authentication Tokens](https://academy.useinsider.com/docs/api-authentication-tokens#generate-api-key){:target="_blank”} documentation. + +7. Click **Save** Changes. + +8. In the Mappings tab, click **New Mapping** and select **Sync Engage Audience to Insider**. + +9. Go to the Settings tab and enable the destination. + +Your Insider destination is now ready to receive audiences, and your segment will start to populate over at Insider Audiences. To use the segment, select Segment Audience Name from your segmentation over at the Insider InOne panel. If you enable track option, Insider also receives the events defined on Segment Panel with the same name. + +Be aware that, populating all user information might take a while to process. + +{% include components/actions-fields.html %} + +## Migration from the classic Insider destination + +If you’re already using the Insider (Classic) Destination, you’re not expected to have breaking changes when upgrading to the Insider (Actions) destination. You can configure the new Actions mode destination and connect it to the same source(s) as the Classic destination and manually verify it before fully switching over. diff --git a/src/connections/destinations/catalog/actions-insider-cloud/index.md b/src/connections/destinations/catalog/actions-insider-cloud/index.md new file mode 100644 index 0000000000..a05cf98b3c --- /dev/null +++ b/src/connections/destinations/catalog/actions-insider-cloud/index.md @@ -0,0 +1,45 @@ +--- +title: Insider Cloud Mode (Actions) +id: 643697f531f98a978f414453 +versions: + - name: Insider Destination + link: /docs/connections/destinations/catalog/insider/ +--- + +{% include content/plan-grid.md name="actions" %} + +[Insider](https://useinsider.com/integration/segment/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} Growth Management Platform (GMP) helps digital marketers drive growth across the funnel. Insider GMP helps marketers deliver personalized journeys across the web, mobile web, mobile apps, messaging, email, and ad channels using unified data. + +This destination is maintained by Insider. For any issues with the destination, contact the [Insider Support team.](mailto:insiderhelp@useinsider.com){:target="_blank”} + +## Benefits of Insider (Actions) vs Insider Classic + +Insider (Actions) provides the following benefits over the classic Insider destination: + +- **Adjustable Mappings**: By using Insider (Actions), you can map your events and attributes to Insider events and attributes, and easily adjust as needed. +- **Data Consistency**: Pre-Built Mappings can help you to integrate Insider faster and ensure data consistency between Insider and Segment. + +## Getting started + +1. From the Segment web app, click **Catalog**, then click **Destinations**. + +2. Find the Destinations Actions item in the left navigation, and click it. + +3. Click Configure Insider. + +4. Select an existing Source to connect to Insider Cloud Mode (Actions) and click **Next**. + +5. Give your destination a name and click **Create destination**. + +6. On the settings page for your destination, add the following settings: + + - **Account Name**: Your Insider Account (Partner) Name. + - **API Key**: Your Unified Customer Database API Key, see how you can generate API key in the [Insider Academy API Authentication Tokens](https://academy.useinsider.com/docs/api-authentication-tokens#generate-api-key){:target="_blank”} documentation. + +7. Enable your destination and click **Save**. + +{% include components/actions-fields.html %} + +## Migration from the classic Insider destination + +If you’re already using Insider (Classic) Destination, you’re not expected to have breaking changes when upgrading to the Insider (Actions) destination. You can configure the new Actions mode destination and connect it to the same source(s) as the Classic destination and manually verify it before fully switching over. diff --git a/src/connections/destinations/catalog/actions-intercom-cloud/index.md b/src/connections/destinations/catalog/actions-intercom-cloud/index.md index 02cc17ed7b..b62ec0b0d3 100644 --- a/src/connections/destinations/catalog/actions-intercom-cloud/index.md +++ b/src/connections/destinations/catalog/actions-intercom-cloud/index.md @@ -24,6 +24,9 @@ Intercom Cloud Mode (Actions) provides the following benefits over the classic I - **Granular control over data sent.** You can customize the conditions under which the events are sent to Intercom. - **Support for lead creation.** You can create contacts with a role of `lead`, associate them with a company, send events for them, and convert them to a `user`. +## Limitations of Intercom Cloud Mode (Actions) + +The Intercom Cloud Mode (Actions) destination doesn't have access to Intercom’s chat widget. Implement the [Intercom Web Actions](/docs/connections/destinations/catalog/actions-intercom-web/) destination if you need access to Intercom's chat widget. ## Getting started @@ -40,7 +43,7 @@ Intercom Cloud Mode (Actions) provides the following benefits over the classic I ## FAQ & Troubleshooting ### Why is a company I created missing from my Intercom dashboard? -If a company is created without an attached user, the company does not appear on Intercom's dashboard. This is expected. Once a user is attached to the company, it should appear in the list of companies. +If a company is created without an attached user, the company does not appear on Intercom's dashboard. This is expected. Once a user is attached to the company, it should appear in the list of companies. You can associate a company with a user by providing your Identify Contact mapping with a user's `External ID`, `Email Address`, or `Contact ID`. ### Why isn’t a user getting attached to a company? When you use the Identify Company action, Segment creates or updates a company's information. In the same action, Segment also attaches the user in your group call to that company. If the user doesn't exist in Intercom when the action runs, Segment creates or updates the company but can't attach the user. Ensure the user is created in Intercom first. diff --git a/src/connections/destinations/catalog/actions-intercom-web/index.md b/src/connections/destinations/catalog/actions-intercom-web/index.md index 42d77ffb60..bcbd869c67 100644 --- a/src/connections/destinations/catalog/actions-intercom-web/index.md +++ b/src/connections/destinations/catalog/actions-intercom-web/index.md @@ -28,8 +28,23 @@ Intercom Web (Actions) provides the following benefits over the classic Intercom - **Clearer mapping of data.** Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to the destination. - **Granular control over data sent.** You can customize the conditions under which the events are sent to Intercom. - **Selectively shows the Intercom chat widget.** + +### Intercom's chat widget -## Getting Started +The [Intercom Cloud Mode (Actions)](/docs/connections/destinations/catalog/actions-intercom-cloud/) destination doesn't have access to Intercom’s chat widget. Only the [Intercom Web (Actions)](/docs/connections/destinations/catalog/actions-intercom-web/) destination has access to this. + +If you're using the [Analytics.js source](/docs/connections/sources/catalog/libraries/website/javascript/), use the Intercom Web Mode (Actions) destination which sends data directly to Intercom from the client-side by loading the Intercom SDK directly onto your website. + +However, [Intercom Cloud Mode (Actions)](/docs/connections/destinations/catalog/actions-intercom-cloud/) sends data to Segment, after which Segment forwards the data to Intercom. This allows Segment users to send data to Intercom from sources that are incompatible with their SDK. + +When you configure the Segment Intercom destination in device-mode, you'll have access to Intercom's chat widget without loading Intercom separately outside of Segment. + +To access the Intercom Messaging Box, you'll need to configure and connect the Intercom Web (Actions) destination to your Analytics.js source. + +> success "" +> Visit the [Destination Overview docs](/docs/connections/destinations/#connection-modes) to learn the difference between cloud and device modes. + +## Getting started 1. From the Segment web app, navigate to **Connections > Catalog**. 2. Search for **Intercom Web (Actions)** in the Destinations Catalog, and select the destination. @@ -39,4 +54,21 @@ Intercom Web (Actions) provides the following benefits over the classic Intercom 6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings). 7. Enable the destination and configured mappings. +> info "Regional Data Hosting in the EU and Australia" +> For Regional Data Hosting in the EU and Australia, you'll need an Intercom plan that [supports regional data hosting](https://www.intercom.com/help/en/articles/5778275-additional-details-on-intercom-regional-data-hosting){:target="_blank"}. + +> info "" +> Segment doesn't support the creation of **Leads** for Intercom Web. Segment recommends using [Intercom Cloud Mode](/docs/connections/destinations/catalog/actions-intercom-cloud/) to support leads creation. + {% include components/actions-fields.html settings="true"%} + +## Troubleshooting + +### Requests to Intercom return a 404 response +If you are seeing 404 responses in your browser's network tab, you've likely encountered one of two issues: + +- You set the wrong App ID on the Intercom Actions (Web) destination settings page. +- You set the wrong Regional Data Hosting value on the Intercom Actions (Web) destination settings page. Intercom gates regional endpoints by plan level, so you may not have access to EU data hosting. + +### Intercom does not support rETL event batching +The Intercom (Web) Actions destination does not support the bulk contacts endpoint, and therefore is unable to support batching events in rETL. diff --git a/src/connections/destinations/catalog/actions-ironclad/index.md b/src/connections/destinations/catalog/actions-ironclad/index.md index acd84add46..612f48d14e 100644 --- a/src/connections/destinations/catalog/actions-ironclad/index.md +++ b/src/connections/destinations/catalog/actions-ironclad/index.md @@ -14,9 +14,6 @@ id: 63c874d328bd6bd1aa1f90a0 Ironclad maintains this destination. Contact [support@ironcladhq.com](mailto:support@ironcladhq.com) with any questions. - -{% include content/ajs-upgrade.md %} - ## Benefits of Ironclad Clickwrap (Actions) Ironclad (Actions) provides the following benefits: diff --git a/src/connections/destinations/catalog/actions-iterable/index.md b/src/connections/destinations/catalog/actions-iterable/index.md new file mode 100644 index 0000000000..cafad4bb25 --- /dev/null +++ b/src/connections/destinations/catalog/actions-iterable/index.md @@ -0,0 +1,83 @@ +--- +title: Iterable (Actions) Destination +hide-boilerplate: true +id: 645babd9362d97b777391325 +hide-dossier: true +--- + +{% include content/plan-grid.md name="actions" %} + +[Iterable](https://www.iterable.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a cross-channel marketing platform that powers unified customer experiences and empowers you to create, optimize and measure every interaction across the entire customer journey. + +This destination is maintained by Iterable. For any issues with the destination, [contact the Iterable Support team](mailto:support@iterable.com). + +> success "" +> This page is about the [Actions-framework](/docs/connections/destinations/actions/) Iterable Segment destination. There's also a page about the [non-Actions Iterable destination](/docs/connections/destinations/catalog/iterable/). Both of these destinations receive data from Segment. + +## Benefits of Iterable (Actions) vs Iterable Classic + +Iterable (Actions) provides the following benefit over Iterable Classic: + +- **Transparent data mapping**. The Classic Iterable destination receives data from Segment and converts Segment events to Iterable's format using hard coded mappings that are unable to be adjusted. The Iterable (Actions) destination allows clients to fully define their own mappings of Segment events, ensuring they receive data structured specifically for their needs. + +## Getting Started + +Follow these steps to connect the Iterable (Actions) destination to your Segment sources: + +1. Access the Segment web app and click on **Catalog**. +2. In the Catalog, use the search function to find "Iterable". Select the **Iterable (Actions)** destination from the results, and choose which of your sources to connect the destination to. + + +1. From the Segment web app, navigate to **Connections > Catalog > Destinations**. +2. Click the **Destination Actions** category item in the left navigation. +3. Search for **Iterable (Actions)** and select it. +4. Click **Configure Iterable (Actions)**. +5. Select an existing Source to connect to Iterable (Actions). +6. Complete the Destination Settings as listed below. + +{% include components/actions-fields.html %} + +## Important differences from the classic Iterable destination + +Since the release of Iterable's Classic Segment destination, Iterable has expanded its support for multiple project types. To determine the appropriate identifier for your project type, please refer to the list of available project types and their respective identifiers found at the following link: [Project Types and Unique Identifiers](https://support.iterable.com/hc/en-us/articles/9216719179796-Project-Types-and-Unique-Identifiers){:target="_blank”}. + +### Creating or Updating Users + +The method by which you identify users depends on the project type you use: + +#### Email-based Projects +In email-based projects, it is necessary to include the email to successfully create a user in Iterable. Once both the email and `userId` have been set in Iterable, the `userId` can be utilized for any future user updates. + +#### UserID-based Projects +For userID-based projects, a unique `userId` is required for creating a user in Iterable. While it is optional to add an email to a userID-based user profile, all subsequent user updates must be performed using the `userId`. + +#### Hybrid Projects** +In hybrid projects, you have the flexibility to choose between using a unique email or a `userId` to create a user in Iterable. + +In Iterable's previous classic destination, when making Identify calls, certain context fields were automatically mapped to user profiles. However, this behavior has been changed. Please note that the following context fields are no longer automatically mapped to Iterable user profiles during Identify calls: + +- app +- device +- ip +- locale +- page +- timezone + +To include these fields in user profiles, pass them as traits with Identify calls. This change offers more control and customization options for managing user data within Iterable. + +Additionally, the integration has been updated to support explicit mappings for updating the `phoneNumber` user profile field, as well as support of the `mergeNestedObject` boolean field in user update calls. + +### Custom Events + +In UserID and Hybrid projects, when a passed ``userId`` doesn't match an existing user, Iterable creates a new user automatically. In email-based projects, tracking a custom event for an unidentified user will not create a user profile. + +To ensure proper user profile creation in email-based projects: + +- Call the Identify method with both a ``userId`` and an `email` to create a user profile. +- After you create the user profile, proceed with tracking the custom event for that user. + +If you follow this approach, you can guarantee the creation of user profiles and accurately track custom events within Iterable for email-based projects. + +### Commerce Events + +In the classic destination of Iterable, cart updates were associated with Segment's `Product Added` and `Product Removed` events. However, in the Action destination, there have been updates to the default mappings. Now, custom events titled `Cart Updated` are routed to Iterable's Update Cart API. diff --git a/src/connections/destinations/catalog/actions-iterate/index.md b/src/connections/destinations/catalog/actions-iterate/index.md index cdbb4e0f5c..65b6f409b3 100644 --- a/src/connections/destinations/catalog/actions-iterate/index.md +++ b/src/connections/destinations/catalog/actions-iterate/index.md @@ -2,24 +2,18 @@ title: Iterate (Actions) Destination hide-boilerplate: true hide-dossier: true -hidden: true -private: true +beta: true id: 62fec615a42fa3dbfd208ce7 --- - {% include content/plan-grid.md name="actions" %} - + [Iterate](https://iteratehq.com){:target="_blank"} helps you harness customer insights across your whole business with the world’s leading Customer Insights Manager. Put customer insights at the center of your business with user-friendly research tools that look and feel like your brand. With mobile, website and email surveys that are highly targeted, user-friendly, and on-brand, you can learn directly from your visitors, customers, and users. Iterate maintains this destination. See [Iterate's documentation](http://help.iteratehq.com/en/articles/6515486-segment-integration){:target="_blank"} or contact [support@iteratehq.com](mailto:support@iteratehq.com) with any questions. - - -{% include content/ajs-upgrade.md %} - ## Benefits of Iterate (Actions) @@ -29,7 +23,7 @@ Iterate (Actions) provides the following benefits: - **More control** - Actions-based destinations enable you to define the mapping between the data Segment receives from your sources, and the data Segment sends to Iterate. - **Default property mappings** - Default mappings from the Segment like userId, userTraits, and more, allow data to be mapped correctly without any setup required. - + ## Getting started @@ -40,16 +34,9 @@ Iterate (Actions) provides the following benefits: 5. Select an existing Source to connect to Iterate (Actions). 6. Set your Embed API Key. See [Getting your Embed API Key](#getting-your-embed-api-key) for details. - {% include components/actions-fields.html %} - - ## Get your Embed API Key To get your Embed API Key: diff --git a/src/connections/destinations/catalog/actions-jimo/index.md b/src/connections/destinations/catalog/actions-jimo/index.md new file mode 100644 index 0000000000..0fc4c1e8bb --- /dev/null +++ b/src/connections/destinations/catalog/actions-jimo/index.md @@ -0,0 +1,20 @@ +--- +title: Jimo (Actions) Destination +id: 652d4cf5e00c0147e6eaf5e7 +beta: true +--- +{% include content/plan-grid.md name="actions" %} + +[Jimo](https://usejimo.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} helps you to publish personalized product experiences to elevate adoption and user engagement without code as a layer on top of your app. + +This destination is maintained by Jimo. For any issues with the destination, [contact their Support team](mailto:support@usejimo.com). + +## Getting started + +1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Jimo (Actions)". +2. Select Jimo (Actions) and click **Add Destination**. +3. Select an existing Source to connect to Jimo (Actions). +4. Open your [Jimo dashboard](https://i.usejimo.com/settings/general){:target="_blank"}, find and copy your **project id**. +5. Return to Segment and open the destination settings for the Jimo (Actions) destination that you just created. Enter your Jimo **project id**. + +{% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-kafka/index.md b/src/connections/destinations/catalog/actions-kafka/index.md new file mode 100644 index 0000000000..c114335dca --- /dev/null +++ b/src/connections/destinations/catalog/actions-kafka/index.md @@ -0,0 +1,101 @@ +--- +title: Kafka Destination +beta: true +id: 65dde5755698cb0dab09b489 +--- + +{% include content/plan-grid.md name="actions" %} + +[Kafka](https://kafka.apache.org/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} provides a highly scalable and fault-tolerant messaging system that enables real-time data processing and stream processing at scale. When integrated with Segment, Kafka serves as a powerful backbone for managing and processing event data collected by Segment, allowing businesses to efficiently ingest, route, and analyze data across various applications and systems in real time. + +## Getting started + +### Create the Kafka Destination + +1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Kafka". +2. Select the "Kafka" tile and click **Add Destination**. +3. Select an existing Source to connect to Kafka. +4. Enter a name for your Kafka destination. + +### Configure the Kafka Destination + +The way you've configured your Kafka Cluster informs the authentication and encryption settings you'll need to apply to the Segment Kafka Destination. You may need the assistance of someone technical to provide values for the following Settings: + +
-
+
- + On the Settings tab, enter values into the **Client ID**, **Brokers** and **Authentication Mechanism** setting fields. + +
-
+ Populate fields based on the value you selected from the Authentication Mechanism field:
+
-
+
- + Plain or SCRAM-SHA-256 / 512 authentication: provide values for Username and Password fields. + +
- + AWS authentication: provide values for AWS Access Key ID and AWS Secret Key fields, and optionally for the AWS Authorization Identity field. + +
- + Client Certificate authentication: provide values for the SSL Client Key and SSL Client Certificate fields. + +
+ - + Populate the **SSL Certificate Authority** field, if necessary. + +
- + Save your changes and proceed to [Configure the Send Action](#configure-the-send-action). + +
-
+
- + Select the Mappings tab and add a new **Send** mapping. + +
- + Select a Topic to send data to. This field should auto-populate based on the credentials you provided in the Settings tab. + +
-
+ Map your payload using the **Payload** field.
_(Optional)_: Specify partitioning preferences, Headers and Message Key values. +
+ - + Save and enable the Action, then navigate back to the Kafka destination's Settings tab to enable and save the Destination. + +
| | |
+| Track Event | | | |
+| Upsert Profile | | | |
+| Remove Profile | | | |
+| Subscribe Profile | | | **\*** |
+| Unsubscribe Profile | | | |
+
+> info ""
+> **\*** Though technically possible, it may not be the most intuitive approach to using RETL.
+>
+> **e.g.,** Triggering a **Subscribe Profile** action when a user is **deleted** from a Model that queries unsubscribed users.
+
+In order to add users to a list, use the **Upsert Profile** Action and fill out the **List** field with the Klaviyo list to add the profile to.
+
+Follow these steps to create a list in Klaviyo:
+
+1. Navigate to **Audience > Lists & Segments**.
+2. Click **Create List/Segment**.
+3. Choose **List**.
+4. Give your list a name and add any applicable tags.
+5. Click **Create List**.
+
+## Using Klaviyo with Engage
+
+Klaviyo (Actions) Destination can accept your [Engage](/docs/engage/) data. If you wish to add a profile to a list associated with the Engage audienceId, you **don't** need to create a list in Klaviyo. During the first sync with the **Add Profile To List (Engage)** Mapping, Segment creates a list with the same ID as your audience.
+
+To add and remove profiles in Klaviyo with Engage Audience data:
+
+1. Create and configure your Engage Audience.
+2. Navigate to **Engage > Engage Settings > Destinations** and click **Add Destination**.
+3. Select **Klaviyo (Actions)**.
+4. Select your Audience Space as the source, and name your destination.
+5. On the **Mappings** tab, click **Add Mapping** and select **Add Profile To List (Engage)**.
+6. Click **Save** and make sure to enable the mapping.
+7. On the **Mappings** tab, click **Add Mapping** and select **Remove Profile from List (Engage)**.
+8. Click **Save** and make sure you enable the mapping.
+9. Enable the destination.
+10. On the **Engage > Audiences > (your audience)** page, click **Add Destination** and select the destination created.
+11. In the settings that appear in the side panel, toggle the **Send Track** option on, and don't change the **Audience Entered/Audience Exited** event names.
+12. Click **Save Settings**.
+
+## FAQ
+
+### Dealing with 429 Responses from Klaviyo's API
+
+If you're encountering rate limiting issues, consider enabling batching for the Action receiving these errors. Ensure that within the mapping configuration, "Batch data to Klaviyo" is set to "Yes". This adjustment can help alleviate the rate limiting problem.
+
+### Can I send Engage Audiences to a pre-created Klaviyo List?
+
+No. Engage audiences are designed to initiate the creation of new lists in Klaviyo when you use the "Add Profile to List - Engage" mapping. You cannot link Engage lists to existing Klaviyo lists and cannot edit the List ID for Engage audiences.
+
+### How can I unsuppress a profile when adding it to a list?
+
+When adding a user to a list, our action make use of the [Bulk Profile Import](https://developers.klaviyo.com/en/reference/spawn_bulk_profile_import_job){target="_blank"} endpoint (when batching is enabled), and the [Add Profile To List](https://developers.klaviyo.com/en/reference/create_list_relationships){target="_blank"} endpoint for non-batched requests. Both of which will not update a users suppression status if they were previously suppressed.
+
+To ensure a suppressed profile gets unsuppressed, you can use the "Subscribe Profile" action. When a profile is subscribed in Klaviyo, it automatically unsuppresses any previously suppressed user. You can combine this action with other actions to achieve your goal. If this solution does not fully address your use case, please contact us at friends@segment.com so we can consider your specific requirements.
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/actions-koala/index.md b/src/connections/destinations/catalog/actions-koala/index.md
new file mode 100644
index 0000000000..b91b239676
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-koala/index.md
@@ -0,0 +1,22 @@
+---
+title: Koala Destination
+id: 6230c835c0d6535357ee950d
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+Koala enables you to identify website visitors with ease so you can turn traffic into actionable leads. See which companies are researching your docs, checking out your pricing page, and showing intent to buy.
+
+Segment is the easiest way to install Koala. If you've already got Segment running on your website, Koala recommends this approach. With Segment, you can instrument Koala without code.
+
+Koala maintains this destination. For any issues with the destination, [contact the Koala Support team](mailto:support@getkoala.com).
+
+## Getting Started
+
+1. From the Segment web app, navigate to **Connections > Catalog > Destinations**.
+2. Search for *Koala* and select **Add Destination**.
+4. Select the web source that will send data to Koala and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/).
+5. On the **Settings** tab, input your **Public API Key** which can be found in your Koala workspace settings under **Settings > Install**.
+6. Once connected, you can configure how you want to send data to Koala. By default, Segment forwards track events and identify events to Koala. Koala recommends sticking with the defaults.
+
+{% include components/actions-fields.html settings="true"%}
diff --git a/src/connections/destinations/catalog/actions-launchdarkly-audiences/index.md b/src/connections/destinations/catalog/actions-launchdarkly-audiences/index.md
new file mode 100644
index 0000000000..ba6d721e76
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-launchdarkly-audiences/index.md
@@ -0,0 +1,29 @@
+---
+title: LaunchDarkly Audiences Destination
+id: 64e72a310da9ebedf99c8937
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[LaunchDarkly](https://launchdarkly.com){:target="_blank"} is a feature management platform that empowers development teams to safely deliver, control, and measure their software through feature flags.
+
+With LaunchDarkly, you can release features that target specific groups, such as beta users, and premium accounts, using segments. This destination allows you to sync Engage Audiences to LaunchDarkly segments, letting you concentrate more on deploying features and less on managing end users between platforms.
+
+LaunchDarkly maintains this destination. For any issues with the destination, [contact the LaunchDarkly Support team](mailto:support@launchdarkly.com).
+
+## Getting started
+
+1. In LaunchDarkly, navigate to [Account settings](https://app.launchdarkly.com/settings/projects){:target="_blank"} and copy the client-side ID for the project and environment where you would like to create an Engage Audience synced segment.
+2. In LaunchDarkly, create a service token with either a Writer role or a custom role. If your service token has a custom role, it must have the actions `createSegment` and `updateIncluded` to sync a segment from an Engage Audience. To learn how to create a service token, read [Creating API access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens#creating-api-access-tokens){:target="_blank"}.
+3. From the Segment web app, navigate to **Engage > Audiences**. Ensure you are in the Engage space you plan to use with the LaunchDarkly Audiences destination. Either choose an existing Engage audience or create a new one. This is the audience you plan to sync with LaunchDarkly.
+4. Navigate to **Engage > Engage Settings** and click **Destinations**. Ensure you are still in the correct Engage space.
+5. Search for `LaunchDarkly Audiences` and select the destination. Click **Add destination**.
+6. On the **Select Source** screen, your Engage space should already be selected as the source. Click **Confirm Source**.
+7. On the Destination **Settings** tab, name your destination and provide your LaunchDarkly client-side ID and service token.
+8. Toggle **Enable Destination** on and click **Save Changes**.
+9. Navigate to the **Mappings** tab, click **New Mapping**, and select the **Sync Engage Audience to LaunchDarkly** pre-built mapping.
+10. Under **Select mappings**, modify the default mappings as needed. In most cases, you shouldn't need to make any changes.
+11. Click **Save**.
+12. Ensure the **Status** toggle on the **Mappings** tab is enabled.
+
+{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-launchdarkly/index.md b/src/connections/destinations/catalog/actions-launchdarkly/index.md
index bbacc1335f..cfaaa98b35 100644
--- a/src/connections/destinations/catalog/actions-launchdarkly/index.md
+++ b/src/connections/destinations/catalog/actions-launchdarkly/index.md
@@ -6,16 +6,14 @@ id: 624dddd054ced46facfdb9c0
{% include content/plan-grid.md name="actions" %}
-[LaunchDarkly](https://launchdarkly.com) is a feature management platform that empowers development teams to safely deliver, control, and measure their software through feature flags.
+[LaunchDarkly](https://launchdarkly.com){:target="_blank”} is a feature management platform that empowers development teams to safely deliver, control, and measure their software through feature flags.
With LaunchDarkly, you can run experiments on any feature flag. This destination allows you to connect existing Segment events to LaunchDarkly custom metrics for use in LaunchDarkly experiments.
> success ""
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) LaunchDarkly Segment destination. There's also a page about the [non-Actions LaunchDarkly destination](/docs/connections/destinations/catalog/launchdarkly-events/). Both of these destinations receives data from Segment.
-
-{% include content/ajs-upgrade.md %}
@@ -31,7 +29,7 @@ LaunchDarkly (Actions) provides the following benefits over the classic LaunchDa
## Getting started
To get started with LaunchDarkly (Actions):
-1. In LaunchDarkly, navigate to [Account settings](https://app.launchdarkly.com/settings/projects) and copy the client-side ID for the project and environment that you would like to connect to Segment.
+1. In LaunchDarkly, navigate to [Account settings](https://app.launchdarkly.com/settings/projects){:target="_blank”} and copy the client-side ID for the project and environment that you would like to connect to Segment.
2. From the Segment web app, click **Catalog**, then click **Destinations**.
3. Search for **LaunchDarkly (Actions)** and select it.
4. Click **Configure LaunchDarkly**.
diff --git a/src/connections/destinations/catalog/actions-launchpad/index.md b/src/connections/destinations/catalog/actions-launchpad/index.md
index 4192a2d095..cf0a06327a 100644
--- a/src/connections/destinations/catalog/actions-launchpad/index.md
+++ b/src/connections/destinations/catalog/actions-launchpad/index.md
@@ -14,9 +14,6 @@ id: 63e42aa0ed203bc54eaabbee
Launchpad maintains this destination. For any issues with the destination, [contact the Launchpad Support team](mailto:support@launchpad.pm).
-{% include content/ajs-upgrade.md %}
-
-
## Getting started
1. From the Segment web app, navigate to **Connections > Catalog** and click **Destinations**.
diff --git a/src/connections/destinations/catalog/actions-linkedin-audiences/index.md b/src/connections/destinations/catalog/actions-linkedin-audiences/index.md
index 1228e43967..9aeaf52035 100644
--- a/src/connections/destinations/catalog/actions-linkedin-audiences/index.md
+++ b/src/connections/destinations/catalog/actions-linkedin-audiences/index.md
@@ -4,6 +4,7 @@ hide-personas-partial: true
hide-boilerplate: true
hide-dossier: false
id: 62f435d1d311567bd5bf0e8d
+engage: true
---
diff --git a/src/connections/destinations/catalog/actions-linkedin-conversions/index.md b/src/connections/destinations/catalog/actions-linkedin-conversions/index.md
new file mode 100644
index 0000000000..9c15b0e465
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-linkedin-conversions/index.md
@@ -0,0 +1,49 @@
+---
+title: LinkedIn Conversions API Destination
+id: 652e765dbea0a2319209d193
+beta: true
+---
+
+The LinkedIn Conversions API (CAPI) is a conversion tracking tool that creates a direct connection between marketing data from an advertiser’s server and LinkedIn. This integration enables advertisers to measure the performance of their LinkedIn marketing campaigns no matter where the conversion happens and use this data to power campaign optimization. The Conversions API can help strengthen performance and decrease cost per action with more complete attribution, improved reliability, and optimized delivery.
+
+This destination is maintained by Segment. For any issues with the destination, [contact the Segment Support team](mailto:friends@segment.com).
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Search for “LinkedIn Conversions API” in the Destinations Catalog, and select the destination.
+3. On the LinkedIn Conversions API overview page, click **Add destination**.
+4. Select the source that you want to connect to the LinkedIn Conversions API and click **Next**.
+5. Enter a name for your destination and click **Create destination**.
+6. On the Settings tab, click Connect to `[destination-name]` and follow the prompts to authenticate with LinkedIn using OAuth.
+7. Enable the destination and click **Save Changes**.
+
+### Set up a mapping to Stream Conversion Events
+
+Follow the steps in the Destination Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). You must create 1 mapping for every conversion rule. After you create a conversion rule, you cannot update the connected LinkedIn Ad account.
+
+1. On the Mappings tab, click on **+ New Mapping** and Select **Stream Conversion Event**.
+2. Select the events you'd like to map and send to your LinkedIn Conversions API destination.
+3. Create a conversion rule or enter the link to an existing rule. _If you chose to create a new conversion rule, Segment creates the conversion rule as soon as you click **Save**._
+4. Configure the mappings to map event fields and user attributes from your source to the Conversion API.
+5. Click **Save**.
+
+After you've created a Stream Conversion Event mapping, Segment displays the connected rule for each mapping on the Mappings tab. To update the conversion rule you created, select the menu icon for the mapping you'd like to update and click **Edit Mapping**. Scroll to section 3, Create a Conversion Rule, and select **Edit your configuration**. After making changes to your conversion rule, click **Save** to save your changes. You can make changes to all fields except for the Ad account field. After you save your changes, Segment updates the conversion rule in LinkedIn.
+
+{% include components/actions-fields.html %}
+
+## FAQ and troubleshooting
+
+### Why are my inputs failing?
+
+Your inputs must meet the following criteria:
+- Contains a valid URN with the following format: `urn:lla:llaPartnerConversion:id` +- The authenticated user must have write access to the ad account used to create conversion rules +- Contains a userInfo combination that requires firstName and lastName **OR** a userId mapped to at least one of the following idTypes: + - `SHA256_EMAIL` + - `LINKEDIN_FIRST_PARTY_ADS_TRACKING_UUID` + - `ACXIOM_ID` + - `ORACLE_MOAT_ID` +- `conversionHappenedAt` must be a valid timestamp (milliseconds since epoch) and must have happened in the past 90 days + +Any deviations from this specification might lead to failed inputs. diff --git a/src/connections/destinations/catalog/actions-listrak/index.md b/src/connections/destinations/catalog/actions-listrak/index.md new file mode 100644 index 0000000000..40ef2f72b0 --- /dev/null +++ b/src/connections/destinations/catalog/actions-listrak/index.md @@ -0,0 +1,57 @@ +--- +title: Listrak (Actions) Destination +id: 64b6a221baf168a989be641a +--- + +{% include content/plan-grid.md name="actions" %} + +[Listrak](https://www.listrak.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is the retail industry’s leading customer engagement platform. Listrak delivers results for more than 1,000 retailers by providing best-in-class email, text message marketing, identity resolution marketing and push notifications through seamless cross-channel orchestration. Listrak’s data-first approach delivers 1:1 personalization at scale so you can send messages at precisely the right time across the right combination of channels and devices to maximize customer engagement, revenue, and lifetime value. + +Listrak maintains this destination. For any issues with the destination, [contact the Listrak Support team](mailto:support@listrak.com). + +## Getting started + +To add the Listrak Actions destination: + +1. Set up the [Listrak Source](/docs/connections/sources/catalog/cloud-apps/listrak/) first before connecting to the Listrak Actions Destination. Note the API client ID and client secret after creating the integration in Listrak. +2. From your Segment workspace, go to **Connections > Catalog** and select the **Destinations** tab. +3. Search for **Listrak (Actions)** in the Catalog and select the destination. +4. Click **Add destination**. +5. On the **Select data source** step, select your desired source. The source should not be a Listrak source. If you want to sync an Engage Audience, select the Engage space as the source. Click **Confirm Source**. +6. On the **Settings** tab, name your destination. For example, `Listrak`. +7. In the same section of the **Settings** tab, enter your Listrak API client ID and client secret. +8. Click **Save Changes**. +9. Follow the steps in the Destinations Actions documentation to [customize mappings](/docs/connections/destinations/actions/#customize-mappings) or follow the steps below to Sync an Engage Audience. +10. Enable the destination and click **Save Changes**. + +### Sync an Engage Audience + +To sync an Engage audience with your Listrak (Actions) destination: + +1. Each Engage audience to be synced to Listrak must only include email addresses subscribed to the list. To do this, add a condition to the Engage audience that ensures the custom trait for the list exists (eg. have a Custom Trait listrak_list_12345 exists, where 12345 is the list ID). +2. In Listrak, go to **Contacts > Profile Fields** and click **Create Field Group**. +3. Enter a name for the Profile Field Group (eg. `Engage Audiences`) and Click **Save**. +4. Enter a name for the audience for the **Field Name**. +5. Select **Check Box** for the **Data Type**. +6. Click the **Update** button. +7. Go to **Help & Support > API ID Information** and note the list ID and profile field ID. +8. In Segment, open the previously created Listrak destination. +9. In the **Mappings** tab, click **New Mapping** and select **Update Email Contact Profile Fields**. +10. Under **Select events to map and send**, select **Track** for the **Event Type**. +11. Click **Add Condition** and add this condition: **Event Name** is `Audience Entered`. +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). +13. Under **Select mappings**, enter the list ID and map the email address if `context.traits.email` is not desired. +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**. +15. Repeat steps 9 through 14 using `Audience Exited` instead of `Audience Entered` in step 11 and `off` instead of `on` in step 14. +16. **Enable** both mappings. +17. Go to the **Settings** tab for the destination and **Enable** the destination. Click **Save Changes**. +18. Select the Engage space and navigate to **Engage > Audiences**. Select the source audience to send to the Listrak destination. +19. Click **Add Destination** and select the Listrak Audience destination. +20. In the connection settings that appear on the right-hand side, ensure that the toggle to **Send Track** events is _enabled_, and the toggle to **Send Identify** events is _disabled_. +21. Click **Save**. +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”}. +23. Repeat steps 1 through 21, if you want to sync another audience. + +{% include components/actions-fields.html %} + +--- diff --git a/src/connections/destinations/catalog/actions-livelike-cloud/index.md b/src/connections/destinations/catalog/actions-livelike-cloud/index.md index ca952a26be..187f376cce 100644 --- a/src/connections/destinations/catalog/actions-livelike-cloud/index.md +++ b/src/connections/destinations/catalog/actions-livelike-cloud/index.md @@ -3,13 +3,13 @@ title: LiveLike Cloud Mode (Actions) Destination id: 63e42b47479274407b671071 hide-boilerplate: true hide-dossier: false -private: true -hidden: true ---- +private: false +hidden: false +--- {% include content/plan-grid.md name="actions" %} -[LiveLike](https://livelike.com/) is a technology company dedicated to empowering digital experiences that enable deeper fan engagement, increased retention rates, and new monetization opportunities. +[LiveLike](https://livelike.com/){:target="_blank”} is a technology company dedicated to empowering digital experiences that enable deeper fan engagement, increased retention rates, and new monetization opportunities. > info "" > The events transferred from Segment to your LiveLike application will appear under the [Actions](https://docs.livelike.com/docs/reward-actions){:target="_blank"} section. diff --git a/src/connections/destinations/catalog/actions-liveramp-audiences/index.md b/src/connections/destinations/catalog/actions-liveramp-audiences/index.md new file mode 100644 index 0000000000..a205f74327 --- /dev/null +++ b/src/connections/destinations/catalog/actions-liveramp-audiences/index.md @@ -0,0 +1,74 @@ +--- +title: LiveRamp Audiences Destination +hide-boilerplate: true +hide-dossier: false +id: 644ad6c6c4a87a3290450602 +beta: true +--- + +[LiveRamp](https://liveramp.com/){:target="_blank"} gives companies and their partners the power to connect, control, and activate data to transform customer experiences and generate more valuable business outcomes. Segment's integration with LiveRamp lets you push user audiences created in [Twilio Engage](https://www.twilio.com/en-us/engage){:target="_blank"} into your LiveRamp account to execute various marketing use cases. + +The LiveRamp Audiences destination allows users to connect their Engage Audiences to LiveRamp through their SFTP or a customer-managed S3 cloud storage bucket. Users will be able to configure their delivery preferences within Segment. + +The LiveRamp Audiences destination can be connected to **Twilio Engage sources only**. + +## Getting started + +### Set up your file drop + +#### SFTP + +1. Contact your LiveRamp representative to gain a set of [SFTP](https://docs.liveramp.com/connect/en/upload-a-file-via-liveramp-s-sftp.html){:target="_blank"} credentials. +2. Connect to the SFTP server using the client of your choice, and create a new folder under `/uploads` with the name of your audience. + +#### S3 + +1. Create a new S3 bucket. +2. Create a new IAM Role with `PutObject` access to the S3 bucket. +3. Create a new IAM User and assign them the role. +4. Generate a new Access Key pair for the user and note them down; you'll use it for the settings. + +### Connect LiveRamp Audiences + +1. Create and configure your Engage Audience. +2. Navigate to **Engage > Engage Settings > Destinations** and click **Add Destination**. +3. Select **LiveRamp Audiences**, select your Audience Space as the source, and name your destination. +4. On the **Mappings** tab, click **Add Mapping** and choose whether your will be using S3 or SFTP to upload the files. Within the mapping, configure which fields from your payload will be included in the files. +5. Enable the destination and configured mappings. +6. On the **Engage > Audiences > (your audience)** page, click **Add Destination** and select the destination just created. +7. In the settings that appear in the side panel, toggle the Send Track option on and do not change the Audience Entered/Audience Exited event names. Click Save Settings +8. File a [support case](https://docs.liveramp.com/connect/en/considerations-when-uploading-the-first-file-to-an-audience.html#creating-a-support-case){:target="_blank"} with the LiveRamp team to configure and enable ingestion. + +{% include components/actions-fields.html settings="false"%} + +## Limitations + +* Audience must have at least 25 unique members, otherwise the destination will fail and the data will not be synced. This means the Actions Mapping Event Tester does not work (only one test event can be configured). +* Audience sync happens once per day. On a 24-hour cadence, but can take up to 30 hours. +* Audience Sync is a full sync, including only users or accounts in the audience at the time of sync. +* Files are created per audience. +* After initial ingestion is complete, changing the mappings will cause the LiveRamp ingestion to start failing until ingestion setup is run again. +* Time to first sync can be up to 3 days, please be patient. + +## Trait Enrichment + +Use Trait Enrichment to access Segment profile traits when you sync Audiences to Destinations. With Trait Enrichment, you can use custom, SQL, computed, and predictive traits to enrich the data you map to your destinations. + +> info "Trait Enrichment in beta" +> Trait Enrichment is in beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. [Contact Segment](https://segment.com/help/contact/){:target="_blank"} with any feedback or questions. + +Trait Enrichment setup + +1. Confirm that **Send Track** is toggled on and select Customized Setup. Select **Add Trait**, select the traits you want to sync, and click **Save**. + + + +2. Update the **Identifier Data** Field in your destination **Audience Entered** Mapping (either SFTP or S3). +- To update a trait field mapping, click on the **Select event variable** section and in the dropdown search for `properties`, followed by your trait. For example, `properties.firstName`. If no matches are found, use `properties.TRAIT` as an event variable. + + + +For best results with Trait Enrichment, Segment recommends the following: + +- Use Trait Enrichment with new audiences. +- Use smaller audiences for real-time use cases, as data delivery is slower for large audiences. diff --git a/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-EngageSettings.png b/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-EngageSettings.png new file mode 100644 index 0000000000..e37b44e00a Binary files /dev/null and b/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-EngageSettings.png differ diff --git a/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-Mappings.png b/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-Mappings.png new file mode 100644 index 0000000000..ff43b2605e Binary files /dev/null and b/src/connections/destinations/catalog/actions-liveramp-audiences/traitEnrichment-Mappings.png differ diff --git a/src/connections/destinations/catalog/actions-logrocket/index.md b/src/connections/destinations/catalog/actions-logrocket/index.md index a110f71939..38bdb07775 100644 --- a/src/connections/destinations/catalog/actions-logrocket/index.md +++ b/src/connections/destinations/catalog/actions-logrocket/index.md @@ -11,14 +11,12 @@ id: 635ada35ce269dbe305203ff [LogRocket](https://www.logrocket.com/){:target="_blank"} combines session replay, error tracking, and product analytics – empowering software teams to create the ideal web and mobile product experience. With the Segment integration, your Segment user telemetry and events will be sent to LogRocket for enhanced analytics and filtering. -{% include content/ajs-upgrade.md %} - ## Getting started 1. From the Segment web app, click **Catalog**, then click **Destinations**. 2. Find the **LogRocket** destination item in the left navigation, and click it. 3. Click **Configure LogRocket**. 4. Select an existing Source to connect to LogRocket. -5. On the **Settings** tab, set your LogRocket [appID](https://app.logrocket.com/). +5. On the **Settings** tab, set your LogRocket [appID](https://app.logrocket.com/){:target="_blank”}. {% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-loops/index.md b/src/connections/destinations/catalog/actions-loops/index.md new file mode 100644 index 0000000000..95752b48e9 --- /dev/null +++ b/src/connections/destinations/catalog/actions-loops/index.md @@ -0,0 +1,69 @@ +--- +title: Loops (Actions) Destination +hide-boilerplate: true +hide-dossier: true +id: 63360a5fe290ca3fdfad4a68 +--- + +{% include content/plan-grid.md name="actions" %} + +[Loops](https://loops.so?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target:="_blank"} is a modern email platform for SaaS, a better way to send marketing and transactional email. + +You can use this Segment destination to create and update your Loops contacts and trigger email sending with events. + +Loops maintains this destination. For any issues with the destination, [contact their Support team](mailto:help@loops.so). + +## Getting started + +1. From the Segment web app, click **Catalog**, then click **Destinations**. +2. Search for “Loops (Actions)” in the Destinations Catalog, and select the destination. +3. Click **Configure Loops**. +4. Select an existing Source to connect to Loops and click **Next**. +5. On the Setup page, enter a name for your destination and click **Create destination**. +6. Open Loops and generate an API key from [Settings > API](https://app.loops.so/settings?page=api){:target="_blank"}. Click "Generate key" then click the "Copy to clipboard" icon. +7. Open the Segment app, go to the Settings page inside your Loops destination, and paste your API key. Then, click "Save Changes". + +## Create or update contacts + +You can create and update Loops contacts by using Segment's [Identify method](/docs/connections/spec/identify/), like this: + +```javascript +analytics.identify("test-user-a5h7xb", { + email: "adam@loops.so", + firstName: "Adam", + favoriteColor: "blue", + favoriteNumber: 42 +}); +``` + +If the email address or user ID do not exist in your contacts, a new contact will be created. If the email address or user ID already exists, the existing contact will be updated with the data sent in the Identify call. + +Go to the Mappings tab inside your Loops destination and click **New Mapping**. Select **Create or update a contact**. + +It is important that you set up the data mapping properly in step 3 of the "Create or update a contact" form. This is where you can select which data is sent on to Loops and into which fields. Loops provides an example default mapping in the form, but you should make sure that you set up the mapping to capture the correct data in the correct fields (you may have some [custom fields in Loops](https://loops.so/docs/add-users/properties){:target="_blank"} that the default mapping doesn't cover, for example). + +You can pass any custom fields that you're using in Loops inside "Custom Contact Attributes". + +Once you have completed the mapping you can send a test event. After you submit a test event, you can verify everything is set up correctly by looking for the contact on the [Audience](https://app.loops.so/audience){:target="_blank"} page in your Loops account. + +Loops has a full tutorial for creating and updating contacts [in the Loops docs](https://loops.so/docs/add-users/segment#create-or-update-contact){:target="_blank"}. + +## Sending events + +In Loops you can send emails [triggered by events](https://loops.so/docs/loop-builder/triggering-emails){:target="_blank"}. You can trigger these events from Segment by using the [Track method](/docs/connections/spec/track/), like this: + +```javascript +analytics.track("User Registered"); +``` + +When you make a Track call, Segment will pass this event data on to Loops, which can then send emails based on [email-sending triggers](https://loops.so/docs/loop-builder/loop-triggers){:target="_blank"} you've set up in your account. + +To set up event sending with Segment, go to the Mappings tab inside your Loops destination and click **New Mapping**. Select **Send Event**. + +In the next page, enter the name of the event you're tracking into the "Event Name" field (for example, "User Registered" from the example above). If you have not already created the contact in Loops, you need to include an email address in your mapping, as Loops requires a contact for each event. + +Now you are able to send a test event. You can verify that the event was triggered properly in your Loops account from the [Events](https://app.loops.so/settings?page=events){:target="_blank"} page. + +Read the tutorial for sending events [in the Loops docs](https://loops.so/docs/add-users/segment#send-event){:target="_blank"}. + +{% include components/actions-fields.html %} \ No newline at end of file diff --git a/src/connections/destinations/catalog/actions-magellan-ai/index.md b/src/connections/destinations/catalog/actions-magellan-ai/index.md new file mode 100644 index 0000000000..f5fcfe7219 --- /dev/null +++ b/src/connections/destinations/catalog/actions-magellan-ai/index.md @@ -0,0 +1,43 @@ +--- +title: Magellan AI (Actions) Destination +id: 661eca176680eee35d82c955 +beta: true +hidden: true +--- + +{% include content/plan-grid.md name="actions" %} + +[Magellan AI](https://www.magellan.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is the all-in-one platform for audio advertising intelligence, media planning, and measurement. + +This destination is maintained by Magellan AI. For any issues with the destination, [contact their Measurement team](mailto:measurement@magellan.ai). + +## Getting started + +1. From your Segment workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Magellan AI". +2. Select "Magellan AI" and click **Add Destination**. +3. Select an existing Source to connect to Magellan AI (Actions), give your destination a name and click **Create destination**. +4. Enter the campaign's **pixel token** in the destination settings in Segment. You can obtain this token either from the [Magellan AI pixel management dashboard](https://app.magellan.ai/navigator/measurement/pixels){:target="_blank"} or provided by your Magellan AI Measurement Success Manager. +5. Configure which actions you want to send to Magellan AI. + +(Optional) If you need Magellan AI to process GDPR deletion requests: +1. Contact your Magellan AI Measurement Success Manager to enable API access for your account. +2. Go to the [Magellan AI API access token page](https://app.magellan.ai/api_access_tokens){:target="_blank"} and generate a new API token. +3. Find and copy the new **API token**. +4. Enter the **API token** in the destination settings for your Magellan AI (Actions) destination. + +{% include components/actions-fields.html %} + +## Limitations + +* Magellan AI only supports Segment's Replay feature for mobile events. + +### Lead + +Magellan AI's `Lead` action is semantically closest to Segment's [B2B SaaS `Signed Up` event](/docs/connections/spec/b2b-saas/#signed-up) and uses it as the default Trigger. However, Magellan AI's API spec considers `Lead` an e-commerce event, requiring a value and a currency. You may: +* Configure your sources sending `Signed Up` events to include the additional e-commerce-style fields +* Consider mapping an alternative event to the `Lead` action, like `Promotion Clicked` or `Product Added to Wishlist`, depending on your use case +* Map `Signed Up` events to the `Lead` action, providing dummy values in the mapping like `0` for the value and `USD` for the currency + +### Install, Third-Party Event + +Magellan AI's API spec requires a user agent, but Segment's [Analytics-Swift](/docs/connections/sources/catalog/libraries/mobile/apple/) library does not provide user agent information in the event context. In order to use this action with Segment's Swift library, you can provide either a static user agent string or a placeholder value in the mapping. diff --git a/src/connections/destinations/catalog/actions-marketo-static-lists/index.md b/src/connections/destinations/catalog/actions-marketo-static-lists/index.md new file mode 100644 index 0000000000..688ae28f3e --- /dev/null +++ b/src/connections/destinations/catalog/actions-marketo-static-lists/index.md @@ -0,0 +1,99 @@ +--- +title: Marketo Static Lists (Actions) Destination +hide-boilerplate: true +strat: adobe +id: 65302a514ce4a2f0f14cd426 +--- +> info "Marketo Static Lists vs Marketo Static Lists (Actions) Destinations" +> +> Marketo Static Lists (Actions) is a rebuild of the classic destination that provides the following benefits: +> +> - **Streamlined setup process** - Marketo Static Lists (Actions) has a streamlined default setup process, making it faster to get started in a way that "just works". +> - **More control** - Actions-based destinations allow you to define the mapping between the data Segment receives from your sources, and the data Segment sends to Marketo. +> - **Default property mappings** - Default mappings from the Segment like event, timestamp, and more allows data to be mapped correctly without any setup required. + +## Overview + +The Marketo Static Lists (Actions) destination lets you sync users into Marketo as a **List**, allowing you to run email campaigns in Marketo without having to manually find and upload a refreshed csv of users. This documentation explains how to set up Marketo in Segment, and what to expect in your Marketo UI. + +## Details + +- **Supports Engage**: Yes +- **Supports RETL**: Yes +- **Engage Destination type**: List +- **Must create audience_name field before Engage can update those values?**: No. You don't need to create the _list_ in Marketo, however you do need to create the folder Segment will create the list in. +- **Audience appears as**: A list in the folder you created, in the Marketo Lead Database under Group Lists. +- **Destination rate limit**: 100 calls per 20 seconds, which is shared among all third-party API services +- **Lookback window allowed**: Yes +- **Client or Server-Side Connection**: Server-side + +{% include content/sync-frequency-note.md %} + +## Configuring Marketo Static Lists + +> success "Good to know:" +> To set up Marketo, you need Marketo administrator access. If you don't have that access, work with the administrator for your organization. + +### Step 1: Create an API-Only Marketo user + +In this step, you'll create an API-Only Marketo user with both Access API and Lead Database access. + +1. You can use an existing role with these permissions, or create a new role that has both Access API and Access Lead Database permissions. (Do this in Marketo by going to **Admin**→ **Users & Roles** → **Roles**). +2. Go to **Admin** → **Users & Roles** → **Users** → **Invite New User** and create a new **API Only user** with the role that has both Access API and Lead Database permissions. **Be sure to check the API Only box.** + +### Step 2: Create a Marketo Launchpoint Service + +1. Go to **Admin** → **Integration** → **LaunchPoint** → **New** +2. Create a new service. In the Service field, select `Custom`, and in the **API Only User** field, select the user you created in step 1. +3. Write down the **Client Id** and **Client Secret** for this service, as you will need it when configuring the destination settings. + +### Step 3: Create a Marketo Lead Database folder and get your Marketo Endpoint + +1. Go to your Marketo Lead Database, and create a new folder under Group Lists. After connecting, each Engage audience shows up as a list in this folder. + +2. Before you continue to the next step, in Marketo, go to **Admin → Web Services**, and copy or write down the REST API Endpoint. **Be sure to copy the REST endpoint and not the SOAP endpoint.** You'll need that in the next step. + +> warning "Warning:" +> Do not create a list in the folder for the audience. Segment creates the list for you! + +### Using Marketo Static Lists (Actions) destination with Engage + +1. From your Segment workspace, go to **Engage → Engage Settings → Destinations → Add Destination**, and then Search for Marketo Static Lists (Actions). +2. In the destination settings, enter the **Client Id**, **Client Secret**, **Endpoint**, and **Folder Name** from the LaunchPoint service and folder you created in Steps 2 and 3. For **Endpoint**, note the Endpoint from Step 3 above. +3. Select the toggle to enable the Marketo Static Lists (Actions) destination. +4. Navigate to the **Mappings** tab, click **Add Mapping**, and select **Add to List**. +6. Click **Save**, and make sure to enable the mapping. +7. On the **Mappings** tab, click **Add Mapping**, and select **Remove from List**. +8. Click **Save**, and make sure you enable the mapping. +9. Navigate to the Engage Audiences tab, and create a new audience. +10. Give your audience a name, some event and trait criteria, then click **Preview**. +11. Select **Marketo Static Lists** as a destination for the Audience. +12. In the settings that appear in the side panel, toggle the **Send Track** option on, and don't change the **Audience Entered/Audience Exited** event names. +13. Click **Save Settings**. + +### Using Marketo Static Lists (Actions) destination with RETL + +1. Navigate to your data warehouse, and add Marketo Static Lists (Actions) as a destination. +2. From your model, click **Add Mapping**, and select your Marketo Marketo Static Lists (Actions) destination, and the **Add to List** Action. +3. If you already have a list created in Marketo, fill in the List ID field. If you want Segment to create a list in Marketo, fill in the List name field. +4. Finish setting up the rest of the action. +5. Click **Save Mapping**. + +When you save the mapping, a list is created in Marketo. You can update the list the mapping syncs to at any time. + +> info "" +> Only users with an email address appear in the list in Marketo. Users with multiple email addresses as external ids appear in the list once for each email address. + +You can view the audience in Marketo by going to **Lead Database→ Group Lists→Name of folder you created in Step 3 → Audience name** + +{% include components/actions-fields.html %} + +## Troubleshooting + +#### Not seeing an audience in Marketo? +Check that you followed all of the set up steps. Wait six or more hours after setup for your audience to start appearing in Marketo. Check that you didn't create a list in the folder for the audience - Segment creates the list for you, and an existing one can conflict. Check that the audience members you expect have an email address on their profile. + +#### Audience size is smaller than expected +Only users in the audience who also have an email address are uploaded to the list. You may need to adjust your query to filter out users without an email so you can get a better estimate of how many users will appear on the list. In the example below, we added an AND condition where users have a Custom trait of `email` which `exists`. + +If a user has multiple email addresses, each address appears once in the Marketo list. diff --git a/src/connections/destinations/catalog/actions-mixpanel/index.md b/src/connections/destinations/catalog/actions-mixpanel/index.md index f5b5aa24ea..790c7073ca 100644 --- a/src/connections/destinations/catalog/actions-mixpanel/index.md +++ b/src/connections/destinations/catalog/actions-mixpanel/index.md @@ -36,7 +36,7 @@ Mixpanel (Actions) provides the following benefits over the classic Mixpanel des ### Connection Modes for Mixpanel (Actions) destination -The Mixpanel (Actions) destination does not offer a device-mode connection mode. If you're using one of Segment's new libraries ([Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](https://github.com/segmentio/analytics-swift) or [Kotlin](https://github.com/segmentio/analytics-kotlin)) with the Actions-framework version of the destination, you do not need the device-mode connection. +The Mixpanel (Actions) destination does not offer a device-mode connection mode. If you're using one of Segment's new libraries ([Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](https://github.com/segmentio/analytics-swift){:target="_blank”} or [Kotlin](https://github.com/segmentio/analytics-kotlin){:target="_blank”}) with the Actions-framework version of the destination, you do not need the device-mode connection. {% capture track_purchase_details %} @@ -107,14 +107,16 @@ The group id that Mixpanel will use is `12345`. {% capture identify_user_details %} > success "" -> The below special traits will be mapped to Mixpanel reserved properties automatically to fit Mixpanel's use cases. `traits.created` -> `$created`, `traits.email` -> `$email`, `traits.firstName` -> `$first_name`, `traits.lastName` -> `$last_name`, `traits.name` -> `$name`, `traits.username` -> `$username` and `traits.phone` -> `$phone`. +> Segment maps the userId set in the identify event to the distinct ID in Mixpanel. Segment also maps the following traits to Mixpanel reserved properties to fit Mixpanel's use cases: `traits.created` -> `$created`, `traits.email` -> `$email`, `traits.firstName` -> `$first_name`, `traits.lastName` -> `$last_name`, `traits.name` -> `$name`, `traits.username` -> `$username` and `traits.phone` -> `$phone`. {% endcapture %} {% include components/actions-fields.html content1=track_purchase_details section1="trackPurchase" content2=group_identify_user_details section2="groupIdentifyUser" content3=identify_user_details section3="identifyUser" %} -## Migration from Mixpanel Classic -{% include content/ajs-upgrade.md %} +> info "Anonymous ID format" +> [Mixpanel](https://developer.mixpanel.com/reference/create-identity#create-identity){:target="_blank"} requires that values it receives for the anonymous identifier (`anonymousId` in Segment) must be in the UUID v4 format. Analytics.js sends `anonymousId` in this format by default. If you manually send anonymous identifiers to Mixpanel, ensure they are in the correct format. + +## Migration from Mixpanel Classic Assuming you're already using Segment Cloud-mode, the Mixpanel (Actions) destination is expected to have no breaking changes when upgrading. With the exception of a few new properties added to your events in the new Actions destination, there should be no difference in the data received in Mixpanel when using either of the Mixpanel destinations. @@ -123,4 +125,22 @@ If you want to confirm, you can configure the new destination to point to a diff > info "" > Contact Mixpanel support if you find features missing from the Mixpanel (Actions) destination that were available in the classic Mixpanel destination. -{% include components/actions-map-table.html name="mixpanel" %} \ No newline at end of file +{% include components/actions-map-table.html name="mixpanel" %} + +## Troubleshooting + +### Track events are not attributed to Mixpanel Groups + +If the Mixpanel (Actions) destination uses $group_id as the group key, ensure that the mappings handling your `track` events have the field for **Group ID** mapped to a valid value. By default, this field maps to the event variable `context.groupId`. + +To send Track events with a custom Group Key, include the key as a property of Track events. For example: +```js +analytics.track('Example Event', { custom_group_key : 'group1' }); +``` +### Failed events due to timestamp + +If your integration is correct and you are still seeing failed events, review and verify that you are sending all date properties as UTC time format, due to Mixpanel timestamp format requirements. + +### Why is Boardman, Oregon appearing in my users' profile location field? + +If you are seeing traffic from Boardman or see Segment as the browser, you might be sending server side calls to your Mixpanel (Actions) destination. To correctly populate your users' profile location field, manually pass the IP information in the context object from the server. diff --git a/src/connections/destinations/catalog/actions-moengage/index.md b/src/connections/destinations/catalog/actions-moengage/index.md index 5a85e87e66..19b0dd1ae8 100644 --- a/src/connections/destinations/catalog/actions-moengage/index.md +++ b/src/connections/destinations/catalog/actions-moengage/index.md @@ -18,10 +18,6 @@ id: 620feaa207e70f6c6a765ff7 > info "" > This page is about the [Actions-framework](/docs/connections/destinations/actions/) MoEngage Segment destination. There's also a page about the [non-Actions MoEngage Destination](/docs/connections/destinations/catalog/moengage/). Both of these destinations receives data from Segment. - - -{% include content/ajs-upgrade.md %} - This destination is maintained by MoEngage. For any issues with the destination, [contact the MoEngage Support team](mailto:support@moengage.com). @@ -52,7 +48,7 @@ MoEngage (Actions) provides the following benefits over the MoEngage Classic des Name | The name of the Moengage destination such as MoEngage prod, MoEngage test. | App Id | Navigate to Settings > API > General on your MoEngage dashboard to access the App ID. | App Key | Navigate to Settings > API > General on your MoEngage dashboard to access the App Key. | - Endpoint Region | This is your MoEngage data center. [Read more](https://help.moengage.com/hc/en-us/articles/360057030512-Data-Centers-in-MoEngage). | + Endpoint Region | This is your MoEngage data center. [Read more](https://help.moengage.com/hc/en-us/articles/360057030512-Data-Centers-in-MoEngage){:target="_blank”}. | 7. Enable the toggle option to **Enable** the destination and click **Save changes**. @@ -83,8 +79,8 @@ If successful, the data starts flowing into your MoEngage account in 3-5 minutes -## Migration from the classic MoEngage destination + +## Migration from the classic MoEngage destination -{% include content/ajs-upgrade.md %} +Include any pertinent information here. --> diff --git a/src/connections/destinations/catalog/actions-moloco-rmp/index.md b/src/connections/destinations/catalog/actions-moloco-rmp/index.md new file mode 100644 index 0000000000..19fda5d9a0 --- /dev/null +++ b/src/connections/destinations/catalog/actions-moloco-rmp/index.md @@ -0,0 +1,143 @@ +--- +title: Moloco Commerce Media Destination +id: 65f05e455b125cddd886b793 +beta: true +--- + +[Moloco Commerce Media](https://www.moloco.com/products/moloco-retail-media-platform){:target="_blank”} (MCM) is a technology solution that empowers marketplaces and online retailers to build and scale a retail media business (for example, sponsored ads). Moloco’s solution helps platforms leverage and activate their first-party data to deliver highly relevant and performant ads, automate ad decision-making, and scale their ads business. + +The Moloco Commerce Media destination can send user events collected using the Segment SDK to Moloco’s platform for a simplified performance ads integration. + +This allows you to run performance advertising without having to build your own backend system to ingest and send user events data in realtime to Moloco. + +## Getting started + +### Prerequisites +Before you configure the Moloco Commerce Media destination, add a source to Segment and use the [Source Debugger](/docs/connections/sources/debugger/) to verify Segment is receiving events. + +Before you configure the Moloco Commerce Media destination, reach out to your Moloco representative about the following account information: +- Moloco Platform ID +- Moloco Event Service API key + +After you obtain that account information, you can move on to the Segment app. + +### Set up your Moloco destination +1. From the Segment web console, click **Catalog**. +2. On the Catalog page, search for “Moloco”, select it, and click **Add destination**. +3. Choose which of your sources to connect the destination to. +4. In the Moloco MCM destination settings page, fill the Platform ID and API key fields with your Moloco Platform ID and Event Service API key. +5. Select “APP" if your source endpoint is a mobile app, and "SITE" if it is a website. + +## Identify + +Moloco strongly recommends that you identify your logged-in users using Segment's [Identify method](/docs/connections/spec/identify/) and that you hash the user ID before sending it to Moloco. + +Please find an example Identify call below: + +```js +analytics.identify('361b1fdfbeaa9d64a13c033eb9f970dc6740f6bc', { + email: 'john.doe@example.com' +}); +``` + +Once a user is identified, each call to Segment's [Track method](/docs/connections/spec/track/) automatically records the user ID. +Users that are not logged in can be tracked using an [anonymousID](/docs/connections/spec/identify/#anonymous-id). Moloco Commerce Media does not use anonymousIDs for users that are not logged in. Segment recommends formatting your anonymousID in UUID format. + +> info" " +> If you hash the user ID before sending it to Moloco, ensure you reuse the same hashed ID when calling other Moloco APIs. + + +## Track + +If you’re not familiar with the Segment Spec, take a look to understand what the [Track method](/docs/connections/spec/track/) does. The mappings in the Moloco Commerce Media destination are built based on the Segment [Ecommerce Spec](/docs/connections/spec/ecommerce/v2/). + +Please find below an example call to track a product detail page (PDP) view event: + +```js +analytics.track("Product Viewed", { + product_id: "1193", + name: "Newage Uplift Eye Care Cream", + price: 19.99 + currency: "USD" + quantity: 1, + image_url: "https://www.example.com/image.png" +}); +``` + +## Page + +If you’re not familiar with the Segment Spec, take a look to understand what the [Page method](/docs/connections/spec/page/) does. + +Please find below an example call to page: + +```js +analytics.page(); +``` + +If you use Segment’s Web SDK, this call automatically collects the page information. Here’s an example of page information automatically collected using Segment’s Web SDK. + +```js + "page": { + "path": "/account", + "referrer": "", + "search": "", + "title": "Your Account", + "url": "https://www.example.com/account" + }, +``` + +However for iOS and Android, it won’t collect page information. + +Moloco Commercial Media requires the [page_id](https://mcm-docs.moloco.com/docs/51-user-event-data-specifications#page_view-event-type){:target="_blank”} attribute for a PAGE_VIEW event. Using the Web SDK, the page_id can be associated with the path attribute. However for iOS/Android, Moloco Commercial Media recommends using the Page Identifier Token field. + +The Page Identifier Token field accepts key:value pairs of strings that can identify the page. +Stringification Logic is: {key}:{value}s concatenated by ";" + +Moloco Commercial Media ignores the Page Identifier Token if page_id is passed, as page_id has a higher priority. + +Here’s an example of a Page Identifier Token that could be tracked in a mobile app. + +Say the input had the following schema: + +```js + ... + "event": "Product List Viewed", + "vertical": "fruit" + ... +``` + +and user chose the following mapping: + +```js + // "event" represents the name of the event + event: properties.event + // "vertical" represents which vertical the event happened on + vertical: properties.vertical + + // The combination of those two tokens can repsent + // "Which action happened on which vertical" +``` + +The tokens are stringified into the following: + +```js + "event:Product List Viewed;vertical:fruit" +``` + +The tokens are stringified in the format of the above example because they are key-value pairs concatenated by a semicolon (;). + +> info " " +> if you decide to use the Page Identifier Token in your mobile app, reuse the same Page Identifier Token in place of page_id when calling Moloco’s APIs. + +## Mappings + +In the Mappings tab, some fields are chosen by default if some common fields map to Moloco Event’s fields. If the mapped key does not exist in the input data, it won’t trigger an error. Instead, the mapping will not pass any value. + +If you are using **the default fields in a custom way**, please confirm that your mapping meets Moloco's requirements. + +Default Mappings are not hard rules. They can be modified to your convenience. + +{% include components/actions-fields.html %} +## Monitoring + +Once the mappings are configured correctly, you can verify the flow of events from your source to Moloco’s destination in the [Delivery Overview](/docs/connections/delivery-overview/) tab of your Moloco destination. If you correctly configured your destination, you should see a growing **Successful delivery** count. diff --git a/src/connections/destinations/catalog/actions-movable-ink/index.md b/src/connections/destinations/catalog/actions-movable-ink/index.md new file mode 100644 index 0000000000..572052cdc7 --- /dev/null +++ b/src/connections/destinations/catalog/actions-movable-ink/index.md @@ -0,0 +1,56 @@ +--- +title: Movable Ink (Actions) Destination +id: 6537b55db9e94b2e110c9cf9 +beta: true +--- + +[Movable Ink](https://movableink.com/){:target="_blank"} lets email marketers deliver jaw-dropping customer experiences. Movable Ink's cloud-based software activates any data to generate intelligent content at the moment of open. + +This destination enables you to send Segment event data which can be used to automatically generate personalized content at scale across email and mobile experiences. + +> info "" +> This destination is maintained by Movable Ink. For any issues with the destination, please reach out to your Movable Ink Client Experience team. + +## Pre-Requisites + +A Movable Ink Stories license is required to use this integration. Please reach out to your Movable Ink client experience team with any questions. + +You'll need to share sample event payloads with your Movable Ink Client Experience team before enabling the destination in Segment. Your Client Experience team will then work with a Solutions Architect to map the event within Movable Ink and share an endpoint URL, access key ID, and access secret. This event mapping in Movable Ink and API credentials are required for a successful response. + +### Find sample event payloads in Segment: + +To find sample event payloads in Segment: + +1. Navigate to **Connections > Sources** and click on the source you’d like to stream data from. +2. Select the **Debugger** tab. You'll see a list of incoming sample events. +3. Select the event you’re interested in, then select **Raw** to view a full sample payload. +4. Copy and paste this sample payload and share with your client experience team. + +Your client experience manager will then provide you with a Movable Ink endpoint URL, access Key ID, and access secret. + +## Getting started + +1. From the Segment web app, navigate to **Connections > Catalog**, then select **Destinations**. +2. Search for "Movable Ink (Actions)" and select it. +3. Click **Add Destination**. +4. Within the **Settings** tab of your destination, input your Movable Ink API credentials into the following fields: +- **Username**: paste your Movable Ink Access Key ID +- **Access Secret**: paste your Movable Ink Access Secret +- **Movable Ink URL**: paste your Movable Ink Endpoint URL + +## Select events and event properties to stream to Movable Ink + +"Send Entire Event" is the only action available with this destination. To configure this action: +1. Navigate to the **Mappings** section of your destination. +2. Select **Edit Mapping** and tailor the events you wish to send by adding or removing conditions that trigger this action. +3. Preview the data: +- Load a test event from the source or use a sample event for data preview. +4. Map specific fields (optional): +- Click **Test Mapping** to send a test event and identify any potential issues. +- Return to the Mappings overview page and enable your mapping. +6. Navigate to your integration’s **Settings** tab and activate the integration by toggling on **Enable Destination**. + +> info "" +> For any unexpected errors, contact your Movable Ink client experience team with the full sample payload. + +{% include components/actions-fields.html %} \ No newline at end of file diff --git a/src/connections/destinations/catalog/actions-optimizely-advanced-audience-targeting/index.md b/src/connections/destinations/catalog/actions-optimizely-advanced-audience-targeting/index.md new file mode 100644 index 0000000000..d6514f037d --- /dev/null +++ b/src/connections/destinations/catalog/actions-optimizely-advanced-audience-targeting/index.md @@ -0,0 +1,43 @@ +--- +title: Optimizely Advanced Audience Targeting Destination +id: 64edeb2bee24614fe52ede34 +beta: true +--- + +{% include content/plan-grid.md name="actions" %} + +[Optimizely Advanced Audience Targeting](https://optimizely.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target=”blank”} allows you to sync your Segment Engage audiences to Optimizely for targeting with Web Experimentation audiences, Feature Experimentation audiences, and CMS Visitor Groups. + +This destination is maintained by Optimizely. For any issues with the destination, [contact the Optimizely Support team](mailto:support@optimizely.com). + +## Getting started + +**Within your Optimizely Data Platform Account** + +1. Navigate to the **App Directory**. +2. Use autocomplete to find the **Twilio Segment** app. +3. Click into the app and click **INSTALL**. +4. Click **SETTINGS > GENERATE** and copy the resulting token to your clipboard. + +**Within your Twilio Segment Account** + +1. From the Segment web app, navigate to **Connections > Catalog** and select the **Destinations** tab of the catalog. +2. Select the Destinations Actions tab and search for **Optimizely Advanced Audience Targeting**. +3. Select the **Configure Optimizely Advanced Audience Targeting** tile. +4. Select your **Engage Space** as a source. Note that this destination only works when an Engage Space is configured as a Source. +5. Click **Confirm Source**. +6. Within the **Settings** tab paste your ODP token into the **API Key** field, select your region, enable the integration and click **Save Changes**. +7. Click into the **Mappings** section, then click **New Mapping**, then click on the **Sync Audience** tile. +8. In section 3 **Select Mappings** ensure the user identifier you are targeting with your Advanced Audience Targeting integration is mapped to the Optimizely User ID field. +9. Click **Save**. +10. Enable the Action by toggling the Status to **Enabled**. +11. Click back to the **Settings** tab and enable the destination by toggling the **Enable Destination** toggle to *On*. +12. Click **Save changes**. + +{% include components/actions-fields.html %} + +## Notes + +- Ensure the Advanced Audience Targeting integration is configured in your Optimizely Products so that you can access your connected audiences from Segment Engage. + +- If connecting your Segment Engage audiences to **Optimizely Web Experimentation** ensure the user id mapped to the Optimizely User ID in the Destination mappings area is an identifier available on the browser (client side). This allows Optimizely web to properly check audience membership for visitors included in connected Segment Engage audiences. diff --git a/src/connections/destinations/catalog/actions-optimizely-feature-experimentation-cloud/index.md b/src/connections/destinations/catalog/actions-optimizely-feature-experimentation-cloud/index.md new file mode 100644 index 0000000000..01ffec24f3 --- /dev/null +++ b/src/connections/destinations/catalog/actions-optimizely-feature-experimentation-cloud/index.md @@ -0,0 +1,61 @@ +--- +title: 'Optimizely Feature Experimentation (Actions) Destination' +id: 641d5acea88fa531b9068608 +hide-personas-partial: true +hide-boilerplate: false +hide-dossier: true +--- + +{% include content/plan-grid.md name="actions" %} + +[Optimizely Feature Experimentation](https://www.optimizely.com/products/experiment/feature-experimentation/){:target="_blank"} is a feature flagging and experimentation platform for websites, mobile apps, chatbots, APIs, smart devices and anything else with a network connection. + +With the Optimizely SDK you can deploy code behind feature flags, experiment with A/B tests and use percentage deliveries to roll out or roll back flags immediately. + +Segment’s Optimizely Feature Experimentation (Actions) destination supports tracking of conversion events. +Segment supports one action (event): trackEvent. [TrackEvent](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/track-event-javascript-node){:target="_blank"} sends user conversion events for active experiments. Segment sends data using Optimizely's [Event API](https://docs.developers.optimizely.com/experimentation-data/reference/post_events){:target="_blank"}. + +## Prerequisites + +Optimizely works differently than other Segment destinations: it requires that customers implement some Optimizely functionality native to make sure your experiment logic runs correctly. + +Segment maps `track` events to Optimizely's `track` method. You must implement all Optimizely decision-based methods, such as `activate` and `isFeatureEnabled`. Segment sends data using Optimizely's [Event API](https://docs.developers.optimizely.com/experimentation-data/reference/post_events){:target="_blank"}. +Segment's API does not include methods that correspond to decision-based methods. + +This requires that customers include a native Optimizely implementation before their Segment implementation on pages or in mobile apps where Optimizely experiments run. + +## Getting started + +Before connecting to the Optimizely Feature Experimentation destination, you must have a [Optimizely Feature Experimentation](https://www.optimizely.com/products/experiment/feature-experimentation/){:target="_blank"} account, Account ID and Datafile URL. + +To connect the Optimizely Feature Experimentation destination: + +1. From the Segment web app, click **Catalog**, then click **Destinations**. +2. Search for **Optimizely Feature Experimentation** in the Destinations Catalog, and select the destination. +3. Click **Configure Optimizely Feature Experimentation (Actions)** in the top-right corner of the screen. +4. Select the source that will send data to Optimizely Feature Experimentation and follow the steps to name your destination. +5. On the **Settings** tab, input your `datafile` URL and your Account Id. Toggle “Enable Destination” on and click **Save Changes**. +6. Navigate to the **Mappings** tab, click **New Mapping**, and select **Track Event**. +7. Under Select mappings, select the event key from the dropdown or input the event manually as the "event" and select the other mappings. Click **Save** and toggle to enable the mapping. + * **Note:** The conversion event will only be sent if the configured event key exactly matches the name of an active experiment metric set up in the Optimizely dashboard. + * **Note:** The current user should activate a running experiment with the associated metric before sending track events to Segment. + +### Track + +Upon invocation of a Segment `track` event, Segment maps the event to an Optimizely `track` event: +* If the Segment event name matches exactly the name of an active experiment `metric` set up in the Optimizely dashboard; +* If the experiment `metric` is associated with a running experiment; +* If the current user has been assigned a `userId` using Segment's `identify` method (for example, `analytics.identify('123')`); +* If the current user is activated in a running experiment with the associated `metric`. + +Segment also handles the following mapping: +* Segment maps `track` events to Optimizely `eventName`. +* Segment maps `track` event, `properties`, to Optimizely `eventTags`. +* Segment maps `track` event, `context.traits`, to Optimizely `attributes`. + +`revenue` values should be passed as a Segment `property`. The value should be an integer and represent the value in cents, so, for example, $1 should be represented by `100`. + +## GDPR Support +Segment supports deleting/suppressing users in Optimizely Feature Experimentation (Actions) using the [Segment app](/docs/privacy/user-deletion-and-suppression/). Before deleting/suppressing a user, create a [Personal Access Token](https://developers.optimizely.com/x/authentication/personal-token/){:target="_blank”} in Optimizely and provide it as the value of the Personal Access Token setting. + +{% include components/actions-fields.html settings="true"%} diff --git a/src/connections/destinations/catalog/actions-outfunnel/index.md b/src/connections/destinations/catalog/actions-outfunnel/index.md index 91d0546e9c..0198a5f3b8 100644 --- a/src/connections/destinations/catalog/actions-outfunnel/index.md +++ b/src/connections/destinations/catalog/actions-outfunnel/index.md @@ -3,21 +3,19 @@ title: Outfunnel Destination hide-boilerplate: true hide-dossier: true id: 63ff8bae963d5cb4fc79f097 -private: false -hidden: false +private: true +hidden: true --- {% include content/plan-grid.md name="actions" %} -[Outfunnel](https://outfunnel.com/product-led-sales-platform/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a product-led sales platform that syncs product usage insights to CRMs like Pipedrive so your salespeople can easily find product-qualified leads and close more revenue. +[Outfunnel](https://outfunnel.com/product-led-sales-platform/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a product-led sales platform that syncs product usage insights to CRMs like Pipedrive so your salespeople can easily find product-qualified leads and close more revenue. This destination is maintained by Outfunnel. For any issues with the destination, [contact their Support team](mailto:support@outfunnel.com). Outfunnel’s Segment integration is an [Actions-based Destination in cloud mode](/docs/connections/destinations/#connection-modes) that lets you send your frontend and backend events directly to Outfunnel. -{% include content/ajs-upgrade.md %} - {% include content/beta-note.md %} ## Benefits of Outfunnel diff --git a/src/connections/destinations/catalog/actions-pendo-web/index.md b/src/connections/destinations/catalog/actions-pendo-web/index.md new file mode 100644 index 0000000000..4ae5fd21e8 --- /dev/null +++ b/src/connections/destinations/catalog/actions-pendo-web/index.md @@ -0,0 +1,41 @@ +--- +title: Pendo Web (Actions) Destination +id: 6501a4325a8a629197cdd691 +beta: true +hide-boilerplate: true +hide-dossier: true +--- + +{% include content/plan-grid.md name="actions" %} + + +[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. + +Pendo maintains this destination. For issues with the Pendo Web (Actions) destination, please reach out to [Pendo's support team](https://support.pendo.io/hc/en-us/articles/360034163971-Get-help-with-Pendo-from-Technical-Support){:target="_blank"}. + +> success "" +> **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. + +## Benefits of Pendo Web (Actions) vs Pendo Classic + +Pendo Web (Actions) provides the following benefits over the classic Pendo destination: + +- **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. +- **Full region support**. Setup allows the destination to be configured for US, EU, US restricted, or Japan. +- **Supports CNAME for Pendo**. Works with subscriptions using Pendo's custom CNAME feature. + +## Getting started + +1. From the Segment web app, click **Catalog**, then click **Destinations**. +2. Find the Destinations Actions item in the left navigation, and click it. +3. Click **Pendo Web (Actions)**. +4. Click **Add destination ->**. +5. Select an existing Source to connect to Pendo Web (Actions). +6. In the destination settings, enter your Pendo API Key, which a Pendo Admin can find in the Pendo UI by going to **Settings** > [Subscription Settings](https://app.pendo.io/admin){:target="_blank"} > **Applications**, opening the relevant app, then locating the **API Key** value. +7. Select the correct region for your Pendo subscription. + +{% include components/actions-fields.html %} + +## Migration from the classic Pendo destination + +Remove the classic Pendo destination and Webhook destination from your Segment workspace before adding the Pendo Web (Actions) destination. diff --git a/src/connections/destinations/catalog/actions-pinterest-conversions-api/index.md b/src/connections/destinations/catalog/actions-pinterest-conversions-api/index.md new file mode 100644 index 0000000000..c1f4d90a65 --- /dev/null +++ b/src/connections/destinations/catalog/actions-pinterest-conversions-api/index.md @@ -0,0 +1,160 @@ +--- +title: Pinterest Conversions API +id: 63e42e512566ad7c7ca6ba9b +hide-personas-partial: true +hide-boilerplate: false +hide-dossier: true +private: false +hidden: false + +--- +The Pinterest Conversions API destination is a server-to-server integration with [The Pinterest API for Conversions](https://help.pinterest.com/en/business/article/the-pinterest-api-for-conversions){:target="_blank"} that allows advertisers to send conversions directly to Pinterest without requiring a Pinterest Tag. These conversions map to Pinterest campaigns for conversion reporting to improve conversion visibility. When you pass events to Pinterest, advertisers can use Pinterest's insights to evaluate an ad's effectiveness to improve content, targeting, and placement of future ads. + +Advertisers can send web, in-app, or offline conversions to Pinterest’s server to server endpoint in real-time. Events received in real time or within an hour of the event occurring are reported as web or app events. Events received outside of this window, as well as delayed batch events are considered as offline events. + +The API for Conversions helps Pinterest provide a more comprehensive view of your campaign performance. All advertisers who currently use the Pinterest Tag will benefit from using it in tandem with the API for Conversions. + +## Benefits of Pinterest Conversions API (Actions) + +The Pinterest Conversions API destination provides the following benefits: + +- **Fewer settings**. Data mapping for actions-based destinations happens during configuration, which eliminates the need for most settings. +- **Clearer mapping of data**. Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to the Pinterest Conversions API. +- **Prebuilt mappings**. Mappings for standard Pinterest Conversions API events, like `Add to Cart`, are prebuilt with the prescribed parameters and available for customization. +- **Support Deduplication**. Deduplication removes duplicates events which improves the accuracy of your conversions +- **Support for page calls**. Page calls can be sent to Pinterest as a standard Page View. +- **Support for multi-user arrays**. User data nested within arrays, like the `User Data` array in the Order Completed event, can be sent to Pinterest. +- **Data normalization**. Data is normalized before it's hashed to send to Pinterest Conversions. + +## Getting started + +Before connecting to the Pinterest Conversions destination, you must have a [Pinterest](https://ads.pinterest.com/login/){:target="_blank"} account and an Ad Account ID. + +To connect the Pinterest Conversions API Destination: + +1. From the Segment web app, navigate to **Connections > Catalog**. +2. Search for **Pinterest Conversions API** in the Destinations Catalog, and select the destination. +3. Click **Configure Pinterest Conversions API**. +4. Select the source that will send data to Pinterest Conversions API and follow the steps to name your destination. +5. On the **Basic Settings** page, configure the following fields: + - Destination Name + - [Ad Account ID](https://developers.pinterest.com/docs/conversions/conversions/#Find%20your%20%2Cad_account_id#Find%20your%20%2Cad_account_id#Find%20your%20%2Cad_account_id){:target="_blank”} + - [Conversions Token](https://developers.pinterest.com/docs/conversions/conversions/#Get%20the%20conversion%20token){:target="_blank”} +6. Navigate to the **Mappings** tab, there are already Prebuilt mapping like `Checkout,Search,Add to Cart` defined with prescribed parameter . All required ,recommended and optional fields are listed [here](https://developers.pinterest.com/docs/conversions/best/#Authenticating%20for%20the%20Conversion%20Tracking%20endpoint#The%20%2Cuser_data%2C%20and%20%2Ccustom_data%2C%20objects#Required%2C%20recommended%2C%20and%20optional%20fields#Required%2C%20recommended%2C%20and%20optional%20fields){:target="_blank”} +7. If you want to create **New Mapping**, and select **Report Conversions Event** ,configure and enable it. +8. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). +9. Enable the destination using the **Enable Destination** toggle switch and click **Save Changes**. + + +{% include components/actions-fields.html settings="true"%} + +> warning "" +> By default, all mappings send as `web` conversions. If you want to send events as mobile or offline conversions, update the Action Source in each mapping to be `app_android`, `app_ios`, `offline`. + +## FAQ & Troubleshooting + +### Deduplication with Pinterest Tag + +Pinterest cannot know if a conversion reported by the Tag and another reported by the API for Conversions are the same. + +Because Pinterest recommends using both the API for Conversions and the Pinterest Tag, deduplication is an essential part of the implementation process. It helps to avoid double-counting of a single event when it’s sent through multiple sources, such as the Pinterest Tag and the Pinterest API for Conversions. + +For example, if a user triggers an add to cart event and the tag reports the data using `123` as the event ID. Later, their web server reports the conversion to the API and uses `123` as the event ID. When Pinterest receives the events, Segment looks at the event IDs to confirm they correspond to the same event. + +By using deduplication advertisers can report conversions using both the tag and the API without having to worry about over-counting conversions. This will result in more conversions being attributed than either alone, because if the tag doesn’t match an event, but the API does (or vice versa), the event can still be linked. + +Advertisers should use deduplication for any events they expect to be reported by multiple sources across the API and the Pinterest Tag. + +Conversion Events must meet the following requirements to be considered for deduplication: + +1. The event has non-empty and non-null values for `event_id` and `event_name` +2. The `action_source` of the event is not `offline` (for example, events that occurred in the physical world, like in a local store) The `action_source` parameter is an enum that gives the source of the event – `app_android`, `app_ios`, `web`, or `offline`. +3. The duplicate events arrived within 24 hours of the time of receipt of the first unique event. + +> info "" +> Segment offers a client-side destination specifically designed for the Pinterest Tag. You can find detailed documentation and further information on how to implement this integration by following this [link](https://segment.com/catalog/integrations/pinterest-tag/){:target="_blank”}. + +### Events fail to send due to no App Name set + +App Name is a mandatory field for many of the Pinterest Conversion API destination's mappings. Segment's mobile libraries automatically collect and map the App Name to the correct field. However, Segment's web or server-based libraries do not automatically collect this field, which can cause mappings to fail. Segment recommends adding the App Name to the Segment event, or hardcoding a static string in the mapping as the App Name. + +## Limited Data Processing +Starting from Jan 1, 2023, Pinterest introduced the Limited Data Processing flag as per California Consumer Privacy Act (CCPA). With this flag set Pinterest will allow advertisers to comply with CCPA. + +Advertisers are responsible for complying with user opt-outs, as well as identifying the user’s state of residency when implementing the Limited Data Processing flag. + +Keep in mind that the Limited Data Processing flag could impact campaign performance and targeting use cases. Pinterest recommends using the Limited Data Processing flag on a per-user basis for best results. + +LDP relies on 3 fields and is enabled only when all 3 combinations are met, if one of them is not met then LDP is disabled / ignored. + +| Field Name | Field Description | Required Value for LDP | +| -------------- | ----------------------------------------------- | ---------------------- | +| `opt_out_type` | Opt Out Type based on User’s privacy preference | "LDP" | +| `st` | State of Residence | "CA" | +| `country` | Country of Residence | "US" | + + + +### PII Hashing + +Segment creates a SHA-256 hash of the following fields before sending to Pinterest: +- External ID +- Mobile Ad Identifier +- Email +- Phone +- Gender +- Date of Birth +- Last Name +- First Name +- City +- State +- Zip Code +- Country + +### User Data Parameters + +Segment automatically maps User Data fields to their corresponding parameters [as expected by the Conversions API](https://developers.pinterest.com/docs/conversions/best/#Authenticating%20for%20the%20Conversion%20Tracking%20endpoint#The%20%2Cuser_data%2C%20and%20%2Ccustom_data%2C%20objects#Required%2C%20recommended%2C%20and%20optional%20fields#Required%2C%20recommended%2C%20and%20optional%20fields#User_data%2C%20and%20%2Ccustom_data%2C%20objects){:target="_blank"} before sending to Pinterest Conversions: + +| User Data Field | Conversions API User Data Parameter | +| ----------------- | ----------------------------------- | +| External ID | `external_id` | +| Mobile Ad Id | `hashed_maids` | +| Client IP Address | `client_ip_address` | +| Client User Agent | `client_user_agent` | +| Email | `em` | +| Phone | `ph` | +| Gender | `ge` | +| Date of Birth | `db` | +| Last Name | `ln` | +| First Name | `fn` | +| City | `ct` | +| State | `st` | +| Zip Code | `zp` | +| Country | `country` | + +### Custom Data Parameters + +Segment automatically maps Custom Data fields (excluding `content_ids`, `contents`, `num_items`, `opt_out_type`) to their corresponding parameters [as expected by the Conversions API](https://developers.pinterest.com/docs/conversions/best/#Authenticating%20for%20the%20Conversion%20Tracking%20endpoint#The%20%2Cuser_data%2C%20and%20%2Ccustom_data%2C%20objects#Required%2C%20recommended%2C%20and%20optional%20fields#Required%2C%20recommended%2C%20and%20optional%20fields#User_data%2C%20and%20%2Ccustom_data%2C%20objects){:target="_blank"} before sending to Pinterest Conversions: + +| User Data Field | Conversions API Custom Data Parameter | +| --------------- | ------------------------------------- | +| Currency | `currency` | +| Value | `value` | +| Content IDs | `content_ids` | +| Contents | `contents` | +| Number of Items | `num_items` | +| Order ID | `order_id` | +| Search String | `search_string` | +| Opt Out Type | `opt_out_type` | + +### Server Event Parameter Requirements + +Pinterest requires the `action_source` server event parameter for all events sent to the Pinterest Conversions API. This parameter specifies where the conversions occur. + +### Verify Events in Pinterest Conversions Dashboard + +After you start sending events, you should start seeing them in dashboard. You can confirm that Pinterest received them: + +1. Go to the Events Overview. +2. Click on the Event History to see all the events sent to Pinterest conversions. + diff --git a/src/connections/destinations/catalog/actions-pipedrive/images/deal_match_fields.png b/src/connections/destinations/catalog/actions-pipedrive/images/deal_match_fields.png new file mode 100644 index 0000000000..b586a4330c Binary files /dev/null and b/src/connections/destinations/catalog/actions-pipedrive/images/deal_match_fields.png differ diff --git a/src/connections/destinations/catalog/actions-pipedrive/images/email_match_field.png b/src/connections/destinations/catalog/actions-pipedrive/images/email_match_field.png new file mode 100644 index 0000000000..5cd19d5173 Binary files /dev/null and b/src/connections/destinations/catalog/actions-pipedrive/images/email_match_field.png differ diff --git a/src/connections/destinations/catalog/actions-pipedrive/images/match_field.png b/src/connections/destinations/catalog/actions-pipedrive/images/match_field.png new file mode 100644 index 0000000000..dc6a9d22f3 Binary files /dev/null and b/src/connections/destinations/catalog/actions-pipedrive/images/match_field.png differ diff --git a/src/connections/destinations/catalog/actions-pipedrive/index.md b/src/connections/destinations/catalog/actions-pipedrive/index.md index 86e0033931..851366e810 100644 --- a/src/connections/destinations/catalog/actions-pipedrive/index.md +++ b/src/connections/destinations/catalog/actions-pipedrive/index.md @@ -3,15 +3,11 @@ title: Actions Pipedrive hide-boilerplate: true hide-dossier: true id: 5f7dd8191ad74f868ab1fc48 -private: true -hidden: true --- {% include content/plan-grid.md name="actions" %} -The Actions Pipedrive destination is an integration that allows customers to share events from Segment directly to Pipedrive. When you use Pipedrive with Segment, you don’t need to manually export and upload data to Pipedrive. Your customer data will remain up to date in real time and across all enabled integrations. Every tool you use to interact with leads and customers will land in Pipedrive, so you can always have a clear picture in front of you. - -{% include content/ajs-upgrade.md %} +The Actions Pipedrive destination allows customers to share Segment event data with Pipedrive. Segment events sent to Pipedrive will either create new Entities or update existing Entities in Pipedrive. ## Benefits of Actions Pipedrive @@ -22,21 +18,34 @@ Actions Pipedrive provides the following benefits: ## Getting started -1. From the Segment web app, click **Catalog**, then click **Destinations**. -2. Find the Destinations Actions item in the left navigation, and click it. -3. Click **Configure "Actions Pipedrive"**. -4. Select an existing Source to connect to "Actions Pipedrive". -5. When adding Pipedrive as a destination, you will be redirected to the basic settings page, where you need to enter the destination name as well as Pipedrive's domain and API token. -6. To complete the installation process, switch to advanced settings and enter your Pipedrive IDs. +1. Sign in to your Segment Workspace +2. Click to the **Catalog** tab. +3. Click on the **Destinations** tab. +2. Use the search field to find the 'Pipedrive' destination. Click on the **Actions Pipedrive** tile. +3. Click **Add Destination**. +4. Select a source to connect to and click the **Next** button. +5. Provide a name for your Pipedrive destination and click the **Create Destination** button. +6. On the Settings tab, provide values in the **Domain** and **API Token** settings fields, then click the **Save Changes** button. +7. Navigate to the **Mappings** tab to configure how Segment events will be mapped to Pipedrive Entities. By default, mappings to upsert to Pipedrive's Person, Organization and Activity Entities will already be enabled. You can configure new Mappings by clicking on the **New Mapping** button. +8. After you've configured and enabled your Mappings, click back to the **Settings** tab and enable the integration using the **Enable Destination** toggle. Segment should now start sending event data to Pipedrive. -To set up the Segment integration with your Pipedrive account: -1. Go to either your Marketplace menu within your settings or directly to Pipedrive's Marketplace. -2. Search for *Segment* and click on **Install now**. -3. A new window will pop up and prompt you to allow Segment to connect with Pipedrive. -4. Choose the Pipedrive account you wish to connect to, then, click **Allow and Install**. +## Inserting new Entities compared to updating existing Entities -Once the installation is successful, you'll be redirected to Segment to authenticate your account. +Segment uses the **Match value** field value as a key when creating or updating an Entity in Pipedrive. By default, the **Match value** will be mapped to the **id** field for the corresponding Entity. You can specify which Pipedrive field to use as a key using the **Match field** field. -{% include components/actions-fields.html %} +**Match field** fields are dynamic and will populate with data from your Pipedrive account. + + +In the following example, Segment is configured to create or update Person Entities using the email field. + + +## Associating Entities with other Entities +Entities such as the **Deal** Entity can be configured to be associated with other Entities in Pipedrive. In the example with the **Deal** mapping below the following will happen: +1. A **Person** Entity with an email address matching **properties.email** will be associated with the **Deal** Entity being created or updated. +2. An **Organization** Entity with an ID matching **properties.org_id** will be assocated with the **Deal** Entity being created or updated. + + + +{% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-podscribe/index.md b/src/connections/destinations/catalog/actions-podscribe/index.md new file mode 100644 index 0000000000..48e2309f5e --- /dev/null +++ b/src/connections/destinations/catalog/actions-podscribe/index.md @@ -0,0 +1,95 @@ +--- +title: Podscribe (Actions) Destination +id: 643fdecd5675b7a6780d0d67 +--- + +[Podscribe](https://podscribe.com/){:target="\_blank”} measures the effectiveness of podcast advertising. Through integrations with podcast hosting providers, matches downloads with on-site actions, providing advertisers household-level attribution. + +{% include content/beta-note.md %} + +## Getting started + +1. From the Segment web app, navigate to **Connections > Catalog**. +2. Search for "Podscribe", select it, and choose which of your sources to connect the destination to. + +Once you start sending data to the Podscribe's Destination it will take up to 20 minutes to appear in the Podscribe postbacks page. + +{% include components/actions-fields.html %} + +## Page + +If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like: + +```js +analytics.page(); +``` + +Page calls will be sent to Podscribe as a View event. + +Podscribe is an attribution platform, and as such, Podscribe needs more context about the visitor than just a User ID. Analytics.js [automatically collects context fields](/docs/connections/spec/common/#context-fields-automatically-collected). Podscribe requires certain context fields and properties for Page calls. Below is an example of a raw JSON payload that contains the minimum requirements. + +```js +{ + "type": "page", + "context": { + "ip": "111.111.111.111", + "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko Chrome/118.0.0.0 Safari/537.36" + }, + "properties": { + "referrer": "", + "url": "https://url.com" + }, + "timestamp": "2023-11-05T01:00:00.000Z", + "userId": "3212" +} +``` + +For Page events Podscribe requires: +- A `context` object that contains a `userAgent` and an `ip` field +- A `properties` object that contains a `referrer` and a `url` field + +You'll see these in the Page event's raw JSON payload above. + +The `context` and `properties` objects are required, along with the fields in them. If you're using Segment server-side you must send these attributes. + +## Track + +If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like: + +```js +analytics.track("Order Completed", { + order_id: "50314b8e9bcf000000000000", + total: 27.5, + coupon: "hasbros", + currency: "USD", +}); +``` + +Track calls will be mapped to Podscribe events. Podscribe supports the following from the Segment Spec: + +- [Signed Up](/docs/connections/spec/b2b-saas/#signed-up) as `signup` +- [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) as `purchase` + +For Track events, Podscribe requires: +- A `context` object that contains a `userAgent` +- An `ip` Podscribe also requires a `page` object that contains a `referrer` and a `url` field + +Analytics.js [automatically collects context fields](/docs/connections/spec/common/#context-fields-automatically-collected). Podscribe requires certain context fields for Track calls. Below is an example of a raw JSON payload that contains the minimum requirements. + +```js +{ + "type": "track", + "context": { + "ip": "1.2.3.4", + "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko Chrome/118.0.0.0 Safari/537.36" + "page": { + "url": "https://url.com", + "referrer": "" + } + }, + "event": "Test Event Name", + "userId": "test-user-xip99", + "timestamp": "2023-11-05T01:00:00.000Z", + "properties": {} +} +``` diff --git a/src/connections/destinations/catalog/actions-pushwoosh/index.md b/src/connections/destinations/catalog/actions-pushwoosh/index.md new file mode 100644 index 0000000000..8ea86c48ee --- /dev/null +++ b/src/connections/destinations/catalog/actions-pushwoosh/index.md @@ -0,0 +1,31 @@ +--- +title: Pushwoosh (Actions) Destination +id: 64e72af1eabf77368b877a51 +beta: true +--- + +{% include content/plan-grid.md name="actions" %} + +[Pushwoosh](https://pushwoosh.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a customer engagement platform that lets you create personalized messaging campaigns combining multiple channels, like push notifications, in-app messages, emails, and SMS. + +Pushwoosh maintains this destination. For any issues with the destination, [contact the Pushwoosh support team](mailto:help@pushwoosh.com){:target="_blank"}. + +## Getting started + +### Pushwoosh SDK integration + +- If you configured Segment to receive push tokens, you don't need to integrate the Pushwoosh SDK into your app. +- If your Segment implementation doesn't receive push tokens, integrate the Pushwoosh SDK into your app before setting up the Pushwoosh integration. + +### Segment configuration + +1. From the Segment web app, navigate to **Connections > Destinations**, and click **Add Destination**. +2. Search for **Pushwoosh** and select it as the destination. +3. Choose the sources you want to connect the Pushwoosh destination to. +4. Open the destination settings. +5. Enter your [**Pushwoosh API key**](https://docs.pushwoosh.com/platform-docs/api-reference/api-access-token/){:target="_blank"} and **application code**, which you can find below the project name in Pushwoosh. Verify that the **Enable Destination** switch is toggled on, then click **Save Changes**. +6. Go to the **Mappings** tab and verify that the **Create or Update User Profile** and **Track Events options** are enabled. + +Once you've configured the integration, Pushwoosh will receive events and user attributes from Segment. + +{% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-qualtrics/index.md b/src/connections/destinations/catalog/actions-qualtrics/index.md index 33d0b071b8..3b14967b9a 100644 --- a/src/connections/destinations/catalog/actions-qualtrics/index.md +++ b/src/connections/destinations/catalog/actions-qualtrics/index.md @@ -11,11 +11,7 @@ id: 62e17e6f687e4a3d32d0f875 -[Qualtrics](https://qualtrics.com) is an Experience Management platform that allows companies to design and improve customer and employee experiences through listening, analysis and action. Power richer Qualtrics insights or perform action based on your event data using the Qualtrics destination - - - -{% include content/ajs-upgrade.md %} +[Qualtrics](https://qualtrics.com){:target="_blank”} is an Experience Management platform that allows companies to design and improve customer and employee experiences through listening, analysis and action. Power richer Qualtrics insights or perform action based on your event data using the Qualtrics destination @@ -28,13 +24,18 @@ Qualtrics (Actions) provides the following benefits: +### Limitations +The Qualtrics destination is only available to customers on a Business Tier plan with Segment. + +To link your Qualtrics destination in Segment to your Qualtrics workspace, [Qualtrics](https://www.qualtrics.com/support/integrations/twilio-segment/twilio-segment-task/){:target="_blank"} requires a [Segment Token](https://app.segment.com/goto-my-workspace/settings/access-management/tokens){:target="_blank"} that can only be generated by Business Tier customers who have access to the [Public API](https://segment.com/docs/api/public-api/){:target="_blank"}. + ## Getting started 1. From the Segment web app, click **Catalog**, then click **Destinations**. 2. Find the Destinations Actions item in the left navigation, and click it. 3. Click **Configure Qualtrics**. 4. Select an existing Source to connect to Qualtrics (Actions). -5. To authenticate, enter your API key & Datacenter ID. To locate your API key & Datacenter ID, follow in the instructions found [here](https://api.qualtrics.com/ZG9jOjg3NjYzNQ-finding-your-qualtrics-i-ds) +5. To authenticate, enter your API key & Datacenter ID. To locate your API key & Datacenter ID, follow in the instructions found [here](https://api.qualtrics.com/ZG9jOjg3NjYzNQ-finding-your-qualtrics-i-ds){:target="_blank”}. diff --git a/src/connections/destinations/catalog/actions-rehook/index.md b/src/connections/destinations/catalog/actions-rehook/index.md new file mode 100644 index 0000000000..3f7a2a8c14 --- /dev/null +++ b/src/connections/destinations/catalog/actions-rehook/index.md @@ -0,0 +1,101 @@ +--- +title: Rehook Destination +id: 64c02312ff0ce798cc8d1a7e +--- + +{% include content/plan-grid.md name="actions" %} + +[Rehook](https://rehook.ai/){:target="_blank"} is a powerful and dedicated user-incentivization solution that enables businesses to reward and engage users without depending on tech teams. With an elegant and easy-to-use interface, Rehook is designed to help you run user-promotion campaigns that are flexible, customizable and scalable. + +This destination is maintained by Rehook. For any issues with the destination, [contact the Rehook Support team](mailto:services@rehook.ai). + + +## Getting started + +1. From the Destinations catalog page in the Segment App, click **Add Destination**. +2. Search for **Rehook** in the Destinations Catalog, and select the **Rehook** destination. +3. Select which Source should send data to the Rehook destination. +4. Open the [Rehook Dashboard](https://dashboard.rehook.ai/){:target="_blank"} and navigate to **Settings > API Keys & Secret Key**. Copy your key. +5. Open the Segment app and paste the **API Key & Secret Key** in the Rehook destination settings page. + + +## Supported methods + +Rehook's destination is designed to support the following [Segment Spec](/docs/connections/spec) methods. Because this is an Actions Destination, you can also map other Segment methods. + +### Identify + +If you're not familiar with the Segment Spec, take a moment to understand what the [Identify method](/docs/connections/spec/identify/) does. +An example call looks like this: + +#### Example 1: +```js +analytics.identify('userId12345', { + firstName: 'Bob', + lastName: 'Dole', + email: 'bob.dole@example.com', + company: 'Initech', + employees: 234 +}); +``` + +#### Example 2: +```js +analytics.identify('userId12345', { + firstName: 'Bob', + lastName: 'Dole', + email: 'bob.dole@example.com', + company: 'Initech', + employees: 234, + referral_code: "ERTYUS" +}); +``` + +Every time you make an Identify call with an included `userId`: + +1. Rehook verifies that the `userId` exists. +2. If the `userId` does not exist, Rehook adds the user as a Customer to the Rehook database and matches user properties with the Segment `traits` sent in the Identify call payload. +3. If the `userId` exists, Rehook updates the user properties for the Customer against the Segment `traits` sent in the Identify call payload. +4. If `referral_code` is unique, Rehook updates the user properties in its database. + +All of the [traits](/docs/connections/spec/identify#traits) recognized by Segment are translated and matched with the Rehook Customer user properties. These fields are automatically created or mapped for a Customer in Rehook and are available for personalization and advanced segmentation. + +> info "How Rehook handles incoming userId and referral_code in Identify calls:" +> * The `userId` field is required. Rehook drops Identify calls without a userId. +> * If a call is made with `anonymousID`, Rehook drops the Identify call. +> * If `referral_code` matches with another `userId`, Rehook drops the Identify call. + +### Track + +If you're not familiar with the Segment Spec, take a moment to understand what the [Track method](/docs/connections/spec/track/) does. + +An example call looks like this: + +#### Example 1: +```js +analytics.track('Product Viewed', { + userId: "userId12345", + product_id: '507f1f779439011', + name: 'Monopoly: 3rd Edition', + price: 18.99, + url: 'https://www.example.com/product/path', + image_url: 'https://www.example.com/product/path.jpg' +}); +``` + +#### Example 2: +```js +analytics.track('signup', { + userId: "userId12345", + referral_code: 'ERTYUS' +}); +``` + +Segment sends Track calls to Rehook as a Custom Event. When you make a Track call, Segment sends the event to Rehook with the event name and all properties that you specified. + +> info "How Rehook handles incoming userId and referral_code in Track calls:" +> * The `userId` field is required. Rehook drops Track calls without a `userId`. +> * If a call is made with `anonymousId`, Rehook drops the Track call. +> * The `referral_code` field is required if event name is set as a conversion event in Rehook. + +{% include components/actions-fields.html %} \ No newline at end of file diff --git a/src/connections/destinations/catalog/actions-revx/index.md b/src/connections/destinations/catalog/actions-revx/index.md new file mode 100644 index 0000000000..43a60ed476 --- /dev/null +++ b/src/connections/destinations/catalog/actions-revx/index.md @@ -0,0 +1,22 @@ +--- +title: RevX Cloud (Actions) Destination +id: 6464ef424ac5c5f47f5f3968 +beta: true +--- + +{% include content/plan-grid.md name="actions" %} + +[RevX Cloud (Actions)](https://revx.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} helps app marketers achieve their growth objectives by simplifying programmatic advertising for them. With RevX, your reach extends to over 90% of app users globally, encompassing more than 1 million mobile apps. Leverage audience intelligence to achieve highly precise targeting, accompanied by personalized messaging. Employ advanced AI-driven audience segmentation to identify high-intent players, while optimizing creatives to amplify performance to new heights. + +This destination is maintained by RevX. For any issues with the destination, [contact their support team](mailto:tse@revx.io). + +## Getting started + +1. From the Segment web app, click **Catalog**, then click **Destinations**. +2. Find the Destinations Actions item in the left navigation, and click it. +3. Click **Configure RevX Cloud (Actions)**. +4. Select an existing Source to connect to RevX Cloud (Actions). +5. Add Revx Client ID as provided by the tse team. + +{% include components/actions-fields.html %} + diff --git a/src/connections/destinations/catalog/actions-ripe-cloud/index.md b/src/connections/destinations/catalog/actions-ripe-cloud/index.md index dbaa6ace60..fa55442e0f 100644 --- a/src/connections/destinations/catalog/actions-ripe-cloud/index.md +++ b/src/connections/destinations/catalog/actions-ripe-cloud/index.md @@ -1,37 +1,88 @@ --- -title: Ripe Cloud (Actions) Destination +title: Ripe Cloud Mode (Actions) Destination hide-boilerplate: true hide-dossier: true id: 63cade592992cf7052ce2e3e --- -[Ripe](https://www.getripe.com/){:target="_blank"} is a product-led sales -platform that empowers you to unlock revenue pipeline with product data. By identifying and showing which prospects to focus efforts on, you can convert leads into meetings inside your product. +[Ripe](https://www.getripe.com/){:target="_blank"} is a sales conversion tool that enables B2B revenue teams to surface and meet their best leads at the best possible time - when they are using your product. -This destination enables you to send product data to Ripe. Sales teams can identify who decision-makers and product champions are by understanding what properties they have and what events they have triggered. The Ripe destination is built as an alternative to directly adding Ripe’s SDK script to your app or site. +The Ripe Segment integration is an [Actions Destination in cloud mode](/docs/connections/destinations/#connection-modes) that lets you send your product events data to Ripe. -The Ripe Segment integration is an [Actions-based Destination in cloud mode](/docs/connections/destinations/#connection-modes) that lets you send your backend events directly to Ripe. +Ripe maintains this destination. For any issues with the destination, [contact the Ripe team](mailto:support@getripe.com). -{% include content/ajs-upgrade.md %} +> success "" +> Set up a free account with Ripe by visiting their [website](https://www.getripe.com/){:target="_blank"}. -## Benefits of Ripe +## Getting Started -Ripe provides the following benefits: +> warning "Ripe Cloud Mode (Actions) destination requires events from an Analytics.js source" +> Ripe Cloud Mode is a way to send your backend events to Ripe and should be used in tandem with the client-side [Ripe Destination](/docs/connections/destinations/catalog/actions-ripe-web/). Without a Ripe Web Mode (Actions) destination receiving information from an Analytics.js source, you will not be able to interact with leads in the Ripe app. -- **Be relevant**. The Ripe destination understands key events in Segment to identify relevant leads, and shows its widget selectively to them. -- **Quick integration**. Using the Ripe destination is the fastest way to start combining key product events with sales data and start targeting ripe leads. -- **More control**. You can customize the conditions under which the events are sent to Ripe. +1. From the Destinations catalog page in the Segment App, click Add Destination. +2. Search for "Ripe Cloud Mode (Actions)" in the Destinations Catalog, and select the "Ripe Cloud Mode (Actions)" destination. +3. Choose which Source should send data to the "Ripe" destination. +4. Go to Ripe integrations page (or onboarding page) and click on the "Segment" integration. +5. Copy the "Segment API key". +6. Enter the "Segment API Key" in the "Ripe Cloud Mode" destination settings in Segment. -## Getting started +## Supported Methods -> info "" -> Before you begin, create an API key in Ripe which you'll use to configure the integration. +Ripe supports all the following methods out of the box. -1. From the Segment web app, navigate to **Connections > Catalog**, then click the **Destinations** tab at the top of the catalog. -2. Search for *Ripe Cloud Mode (Actions)* in the left navigation, and click it. -3. Click **Configure Ripe Cloud Mode (Actions)**. -4. Select an existing Source to connect to Ripe (Actions). -5. Enter your Ripe API key in the API key field. +### Identify + +Take a look at the [Identify method documentation](/docs/connections/spec/identify/) to learn about what it does. An example call would look like this: + +```js +analytics.identify('userId123', { + email: 'steve@apple.com', + firstName: 'Steve', + lastName: 'Jobs' +}); +``` + +Segment sends Identify calls to Ripe as `identify` events. Ripe displays these events as `Users` by default. `Identify` event data is augmented with traits. It's important to include email as a trait, as soon as it is known. Ripe will use email to populate User views by default. Ripe fully supports [Segment's Identify Spec](https://segment.com/docs/connections/spec/identify/#traits), and recommend using the standardized names for the reserved traits covered there. + + +### Track + +Take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like: + +```js +analytics.track('Clicked Book a Demo Button') +``` + +Segment sends Track calls to Ripe as `track` events. Track events should be flattened whenever possible. For example, rather than `Button Click` as a track event with `Book a Demo` as a property, use `Clicked Book a Demo Button`. Product Events can be filtered and grouped by `userId` or `groupId`. When firing track calls from a backend source you should always include the `userId` to ensure it can be attributed back to the correct user. + + +### Page + +Take a look at the [Page method documentation](https://segment.com/docs/connections/spec/page/) to learn about what it does. An example call would look like this: + +```js +analytics.page() +``` + +Segment sends Page calls to Ripe as a `pageview` event. Ripe displays these events as Page views by default. + + +### Group + +Take a look at the [Group method documentation](https://segment.com/docs/connections/spec/group/) to learn about what it does. An example call would look like this: + +```js +analytics.group("0e8c78ea9d97a7b8185e8632", { + name: "Apple Inc.", + industry: "Technology", + employees: 164000, + plan: "enterprise", + "total billed": 1000000, + website: "apple.com" +}); +``` + +Segment sends Group calls to Ripe as a `group` event. Group events can be augmented with group traits. Ripe displays these events as Workspaces by default. Including a name and a website (domain) as a trait is recommended, as Ripe will use the traits to populate Workspace views by default. {% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-ripe-web/index.md b/src/connections/destinations/catalog/actions-ripe-web/index.md index 055d34c5bf..b239f9243d 100644 --- a/src/connections/destinations/catalog/actions-ripe-web/index.md +++ b/src/connections/destinations/catalog/actions-ripe-web/index.md @@ -1,114 +1,84 @@ --- -title: Ripe Web (Actions) Destination +title: Ripe Device Mode (Actions) Destination hide-boilerplate: true hide-dossier: true id: 63913b2bf906ea939f153851 -redirect_from: '/connections/destinations/catalog/actions-ripe/' --- -[Ripe](https://www.getripe.com/){:target="_blank"} is a product-led sales platform that empowers you to unlock revenue pipeline with product data. By identifying and showing which prospects to focus efforts on, you can convert leads into meetings inside your product. +[Ripe](https://www.getripe.com/){:target="_blank"} is a sales conversion tool that enables B2B revenue teams to surface and meet their best leads at the best possible time - when they are using your product. -This destination enables you to send product data to Ripe. Sales teams can identify decision-makers and product champions by understanding what properties they have and what events they have triggered. The Ripe destination is built as an alternative to directly adding Ripe’s SDK script to your app or site. +The Ripe Segment integration is an [Actions-based Destination in web mode](https://segment.com/docs/connections/destinations/#connection-modes) that lets you send your product events data to Ripe. -The Ripe Segment integration is an [Actions-based Destination in device mode](/docs/connections/destinations/#connection-modes) that loads and configures Ripe’s SDK script for you. If you’re already using Segment’s Analytics.js for identifying and tracking your users, either directly or through Segment source integrations that you’ve installed, you can configure Segment to send this data directly to Ripe. +Ripe maintains this destination. For any issues with the destination, [contact the Ripe team](mailto:support@getripe.com). -{% include content/ajs-upgrade.md %} +> success "" +> Set up a free account with Ripe by visiting their [website](https://www.getripe.com/){:target="_blank"}. -## Benefits of Ripe +## Getting Started -Ripe provides the following benefits: +1. From the Destinations catalog page in the Segment App, click Add Destination. +2. Search for "Ripe Device Mode (Actions)" in the Destinations Catalog, and select the "Ripe Device Mode (Actions)" destination. +3. Choose which Source should send data to the "Ripe Device Mode (Actions)" destination. +4. Go to Ripe integrations page (or onboarding) and click on the "Segment" integration. +5. Copy the "Segment API key". +6. Enter the "Segment API Key" in the "Ripe" destination settings in Segment. -- **Be relevant**. The Ripe destination understands key events in Segment to identify relevant leads, and shows its widget selectively to them. -- **Quick integration**. Using the Ripe destination is the fastest way to start combining key product events with sales data and start targeting ripe leads. -- **More control**. You can customize the conditions under which the events are sent to Ripe. +## Supported Methods -## Getting started - -> info "" -> Before you begin, create an API key in Ripe that you'll use to configure the integration. - - -1. From the Segment web app, navigate to **Connections > Catalog**, then click the **Destinations** tab at the top of the catalog. -2. Search for *Ripe Device Mode (Actions)* in the left navigation, and click it. -3. Click **Configure Ripe Device Mode (Actions)**. -4. Select an existing Source to connect to Ripe (Actions). -5. Enter your Ripe API key in the API key field. - -{% include components/actions-fields.html %} - -{% comment %} -## Ripe SDK +Ripe supports all the following methods out of the box. ### Identify -When you have a unique identifier for a user, preferably an identifier from your database, call this method. For example, when a user logs in or updates their email. If you don't provide a `user_id` is not provided an automatically generated `anonymous_id` will be used. - -If you aren't familiar with the Segment Spec, take a look at -the [Identify method documentation](/docs/connections/spec/identify/) to learn -about what it does. An example call would look like: +Take a look at the [Identify method documentation](/docs/connections/spec/identify/) to learn about what it does. An example call would look like this: ```js analytics.identify('userId123', { - email: 'john.doe@example.com' + email: 'steve@apple.com', + firstName: 'Steve', + lastName: 'Jobs' }); ``` -Segment sends Identify calls to Ripe as an `identify` event. +Segment sends Identify calls to Ripe as `identify` events. Ripe displays these events as `Users` by default. `Identify` event data is augmented with traits. It's important to include email as a trait, as soon as it is known. Ripe will use email to populate User views by default. We fully support the [Segment's Identify Spec](https://segment.com/docs/connections/spec/identify/#traits), and we recommend using the standardized names for the reserved traits covered there. -### Track -Use `track` calls to track what actions your user perform along with properties -related to the `track` call. +### Track -If you aren't familiar with the Segment Spec, take a look at -the [Track method documentation](/docs/connections/spec/track/) to learn about -what it does. An example call would look like: +Take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like: ```js -analytics.track('Login Button Clicked') +analytics.track('Clicked Book a Demo Button') ``` -Segment sends Track calls to Ripe as a `track` event. +Segment sends Track calls to Ripe as `track` events. Track events should be flattened whenever possible. For example, rather than `Button Click` as a track event with `Book a Demo` as a property, use `Clicked Book a Demo Button`. Product Events can be filtered and grouped by `userId` or `groupId`. Both of these will be appended automatically if they have been fired prior to the track call for web/client-side events. ----> Add comment on fast track property here? -### Group +### Page -If you aren't familiar with the Segment Spec, take a look at -the [Group method documentation](/docs/connections/spec/group/) to learn about -what it does. An example call would look like: +Take a look at the [Page method documentation](https://segment.com/docs/connections/spec/page/) to learn about what it does. An example call would look like this: ```js -analytics.group("0e8c78ea9d97a7b8185e8632", { - name: "Initech", - industry: "Technology", - employees: 329, - plan: "enterprise", - "total billed": 830 -}); +analytics.page() ``` -Group calls from Segment update `Companies` in Ripe. Each `Company` is -associated with a distinct `group_id`. +Segment sends Page calls to Ripe as a `pageview` event. Ripe displays these events as Page views by default. -### Page -Use page calls to track what pages your users sees. This is typically called on -each page load in a traditional web page and on route changes in -SPA-applications. +### Group -If you aren't familiar with the Segment Spec, take a look at -the [Page method documentation](/docs/connections/spec/page/) to learn about -what it does. An example call would look like: +Take a look at the [Group method documentation](https://segment.com/docs/connections/spec/group/) to learn about what it does. An example call would look like this: ```js -analytics.page('Home') +analytics.group("0e8c78ea9d97a7b8185e8632", { + name: "Apple Inc.", + industry: "Technology", + employees: 164000, + plan: "enterprise", + "total billed": 1000000, + website: "apple.com" +}); ``` -Segment sends Page calls to Ripe as a `pageview` event. +Segment sends Group calls to Ripe as a `group` event. Group events can be augmented with group traits. Ripe displays these events as Workspaces by default. Including a name and a website (domain) as a trait is recommended, as Ripe will use the traits to populate Workspace views by default. -### Segment session - -Ripe will use the `userId`, `anonymous` and `groupId` set in Segment and the Ripe SDK keeps track of the current ids. - -{% endcomment %} +{% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-rupt/index.md b/src/connections/destinations/catalog/actions-rupt/index.md new file mode 100644 index 0000000000..bfcde02af8 --- /dev/null +++ b/src/connections/destinations/catalog/actions-rupt/index.md @@ -0,0 +1,32 @@ +--- +title: Rupt (Actions) Destination +hide-boilerplate: true +hide-dossier: true +beta: true +id: 6501a5225aa338d11164cc0f +--- + +{% include content/plan-grid.md name="actions" %} + +[Rupt](https://rupt.dev?utm_source=segment.com&utm_medium=docs&utm_campaign=partners){:target="_blank"} helps customers monitor and monetize account sharing. + +## Benefits of Rupt (Actions) + +Rupt (Actions) provides the following benefits: + +- **Account sharing detection**. Find out exactly which accounts are being shared and how many people are sharing them. +- **Convert & monetize account sharers**. Prebuilt UI to convert account sharers into paying customers. +- **Track account sharing revenue**. Track revenue from account sharing conversions. + +## Getting started + +1. From the Segment web app, click **Catalog**, then click **Destinations**. +2. Search for *Rupt (Actions)* and select it. +3. Click **Configure Rupt (Actions)**. +4. Select an existing Source to connect to Rupt (Actions). +5. Copy your **API key Client ID** from the [Rupt dashboard](https://dashboard.rupt.dev?utm_source=segment.com&utm_medium=docs&utm_campaign=partners){:target="_blank"}. +6. Add your API key to the Rupt (Actions) settings in Segment. + +{% include components/actions-fields.html %} + +To learn more about how Rupt works, see: [How account sharing prevention works](https://www.rupt.dev/docs/how-account-sharing-prevention-works?utm_source=segment.com&utm_medium=docs&utm_campaign=partners){:target="_blank"}. diff --git a/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md b/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md index 061e10c91a..3d34244d78 100644 --- a/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md +++ b/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md @@ -58,7 +58,11 @@ Once you save the API integration and add permissions, you will see a Summary pa {% include components/actions-fields.html settings="true"%} -## FAQ & Troubleshooting +> info "" +> Note that **send contact to data extension** handles a pre-defined structure of contacts being filled into a data extension, whereas **send event to data extension action** customizes event data extensions. +> For example, `contactKey` is the fixed Primary Key that is available when you use **send contact to data extension** action, which you also have to create as a Primary Key in SFMC. However, the Primary Key can be set as per Segment's requirements using **send event to data extension**. + +## FAQ and troubleshooting ### Batching Data to SFMC @@ -71,7 +75,7 @@ The batch feature is only compatible with the "Send Contact to Data Extension" a ### Data Extensions & API Events -To use the SFMC Journey Builder to send marketing campaigns to your users, you need to have data about those users in SFMC. The most common way to send data to SFMC is to send Segment data to an SFMC data extension. Data extensions are tables that contain your data. When you send a contact or event to a data extension, it appear will appear as a "row" in your data extension. Any metadata about the particular contact or event are considered attributes and will appear as a "column" in your data extension. +To use the SFMC Journey Builder to send marketing campaigns to your users, you need to have data about those users in SFMC. The most common way to send data to SFMC is to send Segment data to an SFMC data extension. Data extensions are tables that contain your data. When you send a contact or event to a data extension, it will appear as a "row" in your data extension. Any metadata about the particular contact or event are considered attributes and will appear as a "column" in your data extension. Data extensions and attributes must be created **before** sending data. You can create a data extension in your SFMC account by navigating to **Audience Builder > Contact Builder > Data Extensions > Create**. Segment recommends creating a single data extension to store all contact data, and individual data extensions for each event type you plan to send. Once a data extension is created, you can add attributes for any traits or properties you plan to send. You must include at least one Primary Key attribute that will be used to uniquely identify each row. @@ -85,7 +89,7 @@ API events are another way to send your Segment events to SFMC. API events can t To send an Engage audience to SFMC: 1. Create an attribute in the SFMC data extension that stores your contact data. The attribute should be a boolean data type to store whether or not a user entered the audience. You can name this attribute anything. 2. Set up the Salesforce Marketing Cloud (Actions) destination using the instructions [above](#connect-the-salesforce-marketing-cloud-actions-destination) and connect it to your Engage source. -3. Create a "Send Contact to Data Extension" action in order to map the SFMC attribute to the Engage audience key. The Engage audience key can be found in **Engage > Audiences > Select your audience > Settings > Audience key**. In the Contact Fields mapping, input the name of the attribute you created in SFMC on the left-hand side. On the right-hand side, search for an event variable of `traits.[your-audience-key]` and select "No matches found. Use "traits.[your-audience-key]" as an event variable". +3. Create a "Send Contact to Data Extension" action in order to map the SFMC attribute to the Engage audience key. The Engage audience key can be found in **Engage > Audiences > Select your audience > Settings > Audience key**. In the Contact Fields mapping, input the name of the attribute you created in SFMC on the right-hand side. On the left-hand side, search for an event variable of `traits.[your-audience-key]` and select "No matches found. Use "traits.[your-audience-key]" as an event variable". 4. Navigate back to your Engage audience and connect the Salesforce Marketing Cloud (Actions) destination to the audience. Keep "Send Identify" toggled on and save. When you add an Engage audience to SFMC, the first sync contains all the users in that audience. Users are added as rows in your data extension with the attribute you created set to `true` to indicate audience membership. If a user leaves that audience, the attribute value is automatically updated to `false`, but the user is not removed from the data extension. This allows you to see all users who have ever been in the audience, and then optionally create a [filtered data extension](https://help.salesforce.com/s/articleView?id=sf.mc_es_create_filtered_de.htm&type=5){:target="_blank"} if you want a subset of users. @@ -93,5 +97,5 @@ When you add an Engage audience to SFMC, the first sync contains all the users i To send an Engage computed trait to SFMC: 1. Create an attribute in the SFMC data extension that stores your contact data. Choose the data type matching the type of computed trait you plan to send; for example, text for traits which produce string values, number or decimal for traits which produce numeric values. You can name this attribute anything. 2. Set up the Salesforce Marketing Cloud (Actions) destination using the instructions [above](#connect-the-salesforce-marketing-cloud-actions-destination) and connect it to your Engage source. -3. Create a "Send Contact to Data Extension" action in order to map the SFMC attribute to the Engage trait key. The Engage trait key can be found in **Engage > Audiences > Computed Traits > Choose your computed trait > Settings > Trait key**. In the Contact Fields mapping, input the name of the attribute you created in SFMC on the left-hand side. On the right-hand side, search for an event variable of `traits.[your-trait-key]` and select "No matches found. Use "traits.[your-trait-key]" as an event variable". +3. Create a "Send Contact to Data Extension" action in order to map the SFMC attribute to the Engage trait key. The Engage trait key can be found in **Engage > Audiences > Computed Traits > Choose your computed trait > Settings > Trait key**. In the Contact Fields mapping, input the name of the attribute you created in SFMC on the right-hand side. On the left-hand side, search for an event variable of `traits.[your-trait-key]` and select "No matches found. Use "traits.[your-trait-key]" as an event variable". 4. Navigate back to your Engage computed trait and connect the Salesforce Marketing Cloud (Actions) destination to the computed trait. Keep "Send Identify" toggled on and save. diff --git a/src/connections/destinations/catalog/actions-salesforce/index.md b/src/connections/destinations/catalog/actions-salesforce/index.md index faa0750eef..80d03237bb 100644 --- a/src/connections/destinations/catalog/actions-salesforce/index.md +++ b/src/connections/destinations/catalog/actions-salesforce/index.md @@ -81,7 +81,6 @@ If you have more than one Salesforce instance connected to Segment, repeat these Keep the following in mind as you begin to use Salesforce (Actions): - Salesforce (Actions) supports batching. The workspace owner can edit the enabled-batching field manually for any of the mappings. This setting is disabled by default. -- Salesforce (Actions) doesn’t support Delete CRUD operations on Custom Object. Custom Objects with CRUD the operation set to `delete` are not migrated. - Sending Identify events to Salesforce (Classic) results in a create or update operation for Leads, and maps properties from `event.traits` Salesforce (Actions) does not support this behavior. By default, the automatic migration maps only a subset of the most used Lead properties as mentioned below. The workspace owner must map any additional Salesforce properties or Custom properties manually. Review the tables below to see how settings from Salesforce (Classic) were migrated to Salesforce (Actions). @@ -117,7 +116,7 @@ Review the tables below to see how settings from Salesforce (Classic) were migra ## FAQ ### How do I enable a sandbox instance? -To send data to a Salesforce sandbox instance, navigate to **Settings > Advanced Settings**, toggle on the "Sandbox Instance" setting, and authenticate. If you are already authenticated, please disconnect and reconnect with your sandbox username. +To send data to a Salesforce sandbox instance, navigate to **Settings > Advanced Settings**, toggle on the "Sandbox Instance" setting, save the setting and then authenticate. If you are already authenticated, please disconnect and reconnect with your sandbox username. Your Salesforce sandbox username appends the sandbox name to your Salesforce production username. For example, if a username for a production org is `user@acme.com` and the sandbox is named `test`, the username to log in to the sandbox is `user@acme.com.test`. @@ -155,7 +154,12 @@ When using the `create` operation, it's possible for duplicate records to be cre Please note this is only a concern when using the `create` operation. You can use the `upsert` operation instead to avoid duplicates if `upsert` meets your needs. ### How does Salesforce Bulk API work? -When **Use Salesforce Bulk API** is enabled for your mapping, events are sent to [Salesforce’s Bulk API 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm){:target="_blank"} rather than their streaming REST API. If enabled, Segment will collect events into batches of 1000 before sending to Salesforce. Bulk support can be used for the `upsert` or `update` operations only. +When **Use Salesforce Bulk API** is enabled for your mapping, events are sent to [Salesforce’s Bulk API 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm){:target="_blank"} rather than their streaming REST API. If enabled, Segment will collect events into batches of up to 1000 before sending to Salesforce. Bulk support can be used for the `upsert` or `update` operations only. For bulk `update`, if a record in a batch is missing a Bulk Update Record ID, Segment will still send it to Salesforce. Salesforce will reject the individual record because it will be unable to find a record to update. Other records in the batch that are valid will still be processed. Please note that Segment's Event Delivery tab will show the entire batch as successful as Segment cannot currently break down Event Delivery stats into individual failed/passed events. +### Which fields are supposed to map to Salesforce’s required fields for "Bulk Update Record ID" and "Bulk Upsert External ID"? + +For "Bulk Update Record ID", see [Salesforce’s help documentation](https://help.salesforce.com/s/articleView?id=000385008&type=1){:target="_blank"}. +For "Bulk Upsert External ID", see[Salesforce’s help documentation](https://help.salesforce.com/s/articleView?id=000383278&type=1){:target="_blank"}. + diff --git a/src/connections/destinations/catalog/actions-saleswings/index.md b/src/connections/destinations/catalog/actions-saleswings/index.md index 24016bda60..df0cf88dcf 100644 --- a/src/connections/destinations/catalog/actions-saleswings/index.md +++ b/src/connections/destinations/catalog/actions-saleswings/index.md @@ -2,10 +2,11 @@ title: SalesWings (Actions) Destinaton hide-boilerplate: true hide-dossier: true -private: true +private: false id: 63d17a1e6ab3e62212278cd0 ---- +hidden: false +--- {% include content/plan-grid.md name="actions" %} [SalesWings](https://www.saleswingsapp.com/){:target="_blank"} is a lead scoring platform that offers a user-friendly, no-code solution to identify your leads' true interests. The SalesWings Destination enables using the data collected in Segment to identify, tag and prioritize your leads in SalesWings for your Marketing and Sales teams. diff --git a/src/connections/destinations/catalog/actions-schematic/index.md b/src/connections/destinations/catalog/actions-schematic/index.md new file mode 100644 index 0000000000..8c45c9ad8f --- /dev/null +++ b/src/connections/destinations/catalog/actions-schematic/index.md @@ -0,0 +1,28 @@ +--- +title: Schematic (Actions) Destination +beta: true +id: 65b8e9eca1b5903a031c6378 +--- + +{% include content/plan-grid.md name="actions" %} + +[Schematic](https://schematichq.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} enables you to launch, package, meter, and monitor features with ease, so you can manage it all in one place as your business grows. + +Segment is the easiest way to send events from your application to Schematic. If you already have Segment up and running in your application, Schematic recommends this approach so you don't have to implement any additional code. + +Schematic maintains this destination. For any issues with the destination, [contact the Schematic Support team](mailto:hi@schematichq.com). + +## Getting started + +1. From your Segment web app, navigate to **Connections > Catalog > Destinations**. +2. Search for *Schematic*, select the Schematic destination, and click **Add destination**. +3. Select the source that will send data to Schematic, give your destination a name, then click **Create destination**. +4. On the destination's Settings tab, input your Schematic API Key. To generate an API key, navigate to your Schematic workspace settings under **Settings > API Keys**. + +Once you've connected Schematic to Segment, you can configure how you want to send data to Schematic in the Schematic destination's **Mappings** tab. + +{% include components/actions-fields.html %} + +## Additional Context + +Schematic only accepts Track event names that contain alphanumeric characters, dashes, and underscores. If Segment event names have other characters, like spaces, the Schematic destination automatically snake_cases the event name before passing to Schematic. Segment passes the raw event name as an event trait. \ No newline at end of file diff --git a/src/connections/destinations/catalog/actions-screeb-web/index.md b/src/connections/destinations/catalog/actions-screeb-web/index.md new file mode 100644 index 0000000000..e32e60f73c --- /dev/null +++ b/src/connections/destinations/catalog/actions-screeb-web/index.md @@ -0,0 +1,24 @@ +--- +title: Screeb Web (Actions) Destination +id: 64820d8030d09e775fbac372 +beta: true +--- + +{% include content/plan-grid.md name="actions" %} + +[Screeb](https://screeb.app/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} + provides self-serve predictive analytics for growth marketers, using machine learning to automate audience insights and recommendations. + +Screeb maintains this destination. For any issues with the destination, consult [Screeb's documentation](https://github.com/ScreebApp/developers/wiki){:target="_blank"} or [contact their support team](mailto:support@screeb.app). + +## Getting started + +1. From the Segment web app, click **Catalog**, then click **Destinations**. +2. Find the Destinations Actions item in the left navigation, and click it. +3. Click **Configure Screeb Web (Actions)**. +4. Select an existing Source to connect to **Screeb Web (Actions)**. +5. Find your Website ID on [Screeb > Settings > Install Screeb > Web App](https://admin.screeb.app/org/last/settings/install?from=segment){:target="_blank"} +6. In the destination configuration, input the Website ID. +7. Enable the destination. + +{% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-segment-profiles/index.md b/src/connections/destinations/catalog/actions-segment-profiles/index.md index 05385bf2f8..fa32f0694a 100644 --- a/src/connections/destinations/catalog/actions-segment-profiles/index.md +++ b/src/connections/destinations/catalog/actions-segment-profiles/index.md @@ -15,16 +15,12 @@ The Segment Profiles destination allows you to send your warehouse data back to To use this destination, you must have an active Segment Profile space. If you have not yet created a Segment Profile space, please follow the steps in the [Profiles Onboarding Guide](/docs/profiles/quickstart/). -### Create a Public API token - -To enable the Segment Profiles destination to send data to an existing Profile space, provide an authentication token for the Segment Public API. See [Segment's Public API documentation](https://docs.segmentapis.com/tag/Getting-Started#section/Get-an-API-token){:target="_blank"} for information on how to create a token. The token must include Source Admin permissions. You will need this token in the below steps. - ### Connect and configure the Segment Profiles destination 1. From the Segment web app, navigate to **Reverse ETL > Destinations**. 2. Click **Add Destination**. 3. Select the Segment Profiles destination, click **Next**, and select the warehouse source that will send data to the Segment Profiles destination. If you have not set up a warehouse source, follow the steps in the Reverse ETL documentation on [Getting started](/docs/reverse-etl/#getting-started). -4. On the **Settings** tab, name your destination, input the Public API token created above, select an endpoint region, and click **Save Changes**. It is recommended to configure and enable all mappings before enabling the Segment Profiles destination. +4. On the **Settings** tab, name your destination, select an endpoint region, and click **Save Changes**. It is recommended to configure and enable all mappings before enabling the Segment Profiles destination. 5. On the **Mappings** tab, click **Add Mapping**. Select a data model and the API call type you want to map. Identify calls will create and update user profiles and Group calls will create and update account profiles. Fill in the fields on screen to create the desired mappings, and click **Create Mapping** to complete the configuration. Repeat this step to configure multiple mappings. 6. Enable the configured mapping(s). 7. On the **Settings** tab, click the **Enable Destination** toggle, and then click **Save Changes** to enable the Segment Profiles destination. @@ -35,3 +31,13 @@ To enable the Segment Profiles destination to send data to an existing Profile s ### API Calls and MTUs The Segment Profiles destination is not subject to API call or MTU costs. Any users or accounts created and updated by the Segment Profiles destination will not count towards your API call or MTU usage. + +### Succesful syncs but no changes on profiles +Make sure that the Endpoint Region setting matches the region of your workspace. If the region is correct and you don't see any profile changes, [contact Segment](https://segment.com/help/contact/){:target="_blank"}. + +### Test Mapping +The **Test Mapping** feature on the Mapping page does not send events to Profiles. It will only validate the mappings and confirm that the event will be accepted by the Tracking API. To send and validate the event in profile, please run a RETL sync. + +### Can I view samples of events received in Engage by the Segment Profiles Destination? + +Records sent to the Segment Profiles Destination are managed through a Unify Spaces' Profile Sources. Samples of these events may be reviewed in a [Profile Source Debugger](https://segment.com/docs/unify/debugger/). For a more comprehensive analysis of the events received in Unify & Engage, consider utilizing [Profiles Sync](https://segment.com/docs/unify/profiles-sync/overview/) connected to your Data Warehouse. diff --git a/src/connections/destinations/catalog/actions-segment/index.md b/src/connections/destinations/catalog/actions-segment/index.md index d4decadd8d..da70dd5eeb 100644 --- a/src/connections/destinations/catalog/actions-segment/index.md +++ b/src/connections/destinations/catalog/actions-segment/index.md @@ -32,3 +32,6 @@ The Segment Connections destination enables you to mold data extracted from your ### API Calls and MTUs The Segment Connections destination sends data to Segment's Tracking API, which has cost implications. New users will count as new MTUs and each call will count as an API call. For information on how Segment calculates MTUs and API calls, please see [MTUs, Throughput and Billing](/docs/guides/usage-and-billing/mtus-and-throughput/). + +### Test Mapping +The **Test Mapping** feature on the Mapping page does not send events to the Tracking API. It only validates the mappings and confirms that the event will be accepted by the Tracking API. To send and validate the event in your source, run a RETL sync. \ No newline at end of file diff --git a/src/connections/destinations/catalog/actions-sendgrid/index.md b/src/connections/destinations/catalog/actions-sendgrid/index.md index 25877e2117..e2653709f2 100644 --- a/src/connections/destinations/catalog/actions-sendgrid/index.md +++ b/src/connections/destinations/catalog/actions-sendgrid/index.md @@ -8,9 +8,7 @@ id: 631a6f32946dd8197e9cab66 --- -{% include content/ajs-upgrade.md %} - -[SendGrid Marketing Campaigns](https://sendgrid.com/solutions/email-marketing/) provides email marketing automation for businesses. With Segment you can add contacts and lists to SendGrid Marketing Campaigns. +[SendGrid Marketing Campaigns](https://sendgrid.com/solutions/email-marketing/){:target="_blank”} provides email marketing automation for businesses. With Segment you can add contacts and lists to SendGrid Marketing Campaigns. ## Getting started diff --git a/src/connections/destinations/catalog/actions-slack/index.md b/src/connections/destinations/catalog/actions-slack/index.md index f25e1063ef..aeea0d094a 100644 --- a/src/connections/destinations/catalog/actions-slack/index.md +++ b/src/connections/destinations/catalog/actions-slack/index.md @@ -7,7 +7,7 @@ redirect_from: - '/connections/destinations/catalog/vendor-slack' versions: - name: Slack (Classic) - link: /docs/connections/destinations/slack + link: /docs/connections/destinations/catalog/slack/ --- {% include content/plan-grid.md name="actions" %} @@ -30,21 +30,19 @@ Slack (Actions) provides the following benefits over the classic Slack destinati 3. Click **Configure Actions Slack**. 4. Select an existing Source to connect to Slack (Actions). 5. Click Customized Setup to start from a blank mapping. +6. In your Slack workspace, create a new [Incoming Webhook URL](https://my.slack.com/services/new/incoming-webhook/){:target="_blank"} and select the Slack channel associated with your account that you'd like to send messages to. The Slack channel you select will be the default channel that receives message events. Paste the Incoming Webhook URL you created into each of your Slack Destination's Actions under the field labeled `Webhook URL*`. ## Important differences from the classic Slack destination -- The classic Slack destination formats messages using the handlebars syntax. Slack (Actions) follows [Slack's formatting syntax](https://api.slack.com/reference/surfaces/formatting){:target="_blank"}. +- The classic Slack destination formats messages using the handlebars syntax. Slack (Actions) follows [Slack's formatting syntax](https://api.slack.com/reference/surfaces/formatting){:target="_blank"}. {% include components/actions-fields.html %} ## Migration from the classic Slack destination -{% include content/ajs-upgrade.md %} - - Follow the table below to map your existing Slack destination configuration to Slack (Actions). > warning "" > Slack (Actions) uses [Slack's formatting syntax](https://api.slack.com/reference/surfaces/formatting){:target="_blank"}. This requires that you manually re-enter any messages from Slack Classic, and pick event data from the event variable picker. The handlebars syntax from Slack Classic is not compatible. -{% include components/actions-map-table.html name="slack" %} \ No newline at end of file +{% include components/actions-map-table.html name="slack" %} diff --git a/src/connections/destinations/catalog/actions-snap-conversions/index.md b/src/connections/destinations/catalog/actions-snap-conversions/index.md index edd266b40a..0ef7f67187 100644 --- a/src/connections/destinations/catalog/actions-snap-conversions/index.md +++ b/src/connections/destinations/catalog/actions-snap-conversions/index.md @@ -36,6 +36,12 @@ The Snapchat Conversions API destination provides the following benefits: ## FAQ and Troubleshooting +### Invalid token error +If you're experiencing 400 Bad Requests errors related to an invalid token, follow [these instructions](/docs/connections/destinations/catalog/actions-snap-conversions/#getting-started) to reauthorize your account: +- On the **Settings** tab, authenticate with Snap using OAuth. +- Click **Connect to Snapchat Conversions API**. +- Follow the prompts to authenticate using OAuth with a Snapchat login. Use a Snapchat login that is a member of the Snapchat Ads account you want to connect. + ### Deduplication with the Snap Pixel or App Ads Kit (SDK) There are many ways to send conversion data to Snap, including through the Snap Pixel, App Ads Kit or Conversions API. Snap recommends sending redundant data across sources to ensure the best optimization, targeting, and measurement capabilities. The Client Deduplication ID, Transaction ID, and Mobile Ad Identifier are used by Snap to deduplicate events across sources. Please see below for guidance on when to use each field for deduplication. - **Web**: Snap Conversions API and PixeI @@ -51,7 +57,7 @@ There are many ways to send conversion data to Snap, including through the Snap The Client Deduplication ID allows for a 48-hour deduplication window. The Transaction ID is only eligible for `PURCHASE` events and allows for a 30-day deduplication window. See Snapchat’s [Marketing API documentation](https://marketingapi.snapchat.com/docs/conversion.html#deduplication){:target="_blank"} and [Business Help Center](https://businesshelp.snapchat.com/s/article/event-deduplication?language=en_US){:target="_blank"} for more information. > info "" -> Segment does not have client-side destinations for the Snap Pixel or Snap App Ads Kit (SDK). If you choose to integrate client-side, these must be implemented natively. See Snapchat’s [Install Snap Pixel](https://businesshelp.snapchat.com/s/article/pixel-website-install?language=en_US){:target="_blank"} and [App Ads Kit](https://businesshelp.snapchat.com/s/article/app-ads-kit?language=en_US){:target="_blank"} for implementation details. +> Segment does not have client-side destinations for the Snap Pixel or Snap App Ads Kit (SDK). If you choose to integrate client-side, these must be implemented natively. See Snapchat’s [Install Snap Pixel](https://businesshelp.snapchat.com/s/article/pixel-website-install?language=en_US){:target="_blank"} and [App Ads Kit](https://businesshelp.snapchat.com/s/topic/0TO0y000000YmidGAC/app-ads-kit?language=en_US){:target="_blank"} for implementation details. ### Latency It may take up to 1-hour for events to appear in the Snapchat [Events Manager](https://businesshelp.snapchat.com/s/article/events-manager?language=en_US){:target="_blank"}. @@ -62,7 +68,15 @@ If you want to send a Snap Event Type that Segment doesn’t have a prebuilt map 2. Set up your Event Trigger criteria for trial starts. 3. Input a literal string of “START_TRIAL” as the Event Type. -The Snapchat Conversions API only supports sending Event Types that are in the [predefined `event_type` list](https://marketingapi.snapchat.com/docs/conversion.html#conversion-parameters){:target="_blank"}. This includes custom events. You must use `CUSTOM_EVENT_1`, `CUSTOM_EVENT_2`, `CUSTOM_EVENT_3`, `CUSTOM_EVENT_4`, or `CUSTOM_EVENT_5` as the Event Type. Events sent with an invalid event type will fail with an `Unrecognized event type` error. +The Snapchat Conversions API only supports sending Event Types that are in the [predefined `event_type` list](https://marketingapi.snapchat.com/docs/conversion.html#conversion-parameters){:target="_blank"}. This includes custom events. You must use `CUSTOM_EVENT_1`, `CUSTOM_EVENT_2`, `CUSTOM_EVENT_3`, `CUSTOM_EVENT_4`, or `CUSTOM_EVENT_5` as the Event Type. Events sent with an invalid event type will fail with an `Unrecognized event type` error. + +### Single or multiple products or items +It's possible to send details of either single or multiple products/items in a single conversion event. +- **Single product/item**: Use the "Item ID", "Item Category" and "Brand" fields. +- **Multiple products/items**: Use the "Products" field which accepts an array of products / items. + +### Specifying the total value of a purchase +The "Price" field should be used when specifying the total value of a purchase, and should contain a numeric value only. e.g. 99.5. ### Required parameters and hashing To match visitor events with Snapchat ads, Snap requires that one or a combination of the following parameters are sent to the Conversions API: diff --git a/src/connections/destinations/catalog/actions-sprig-web/index.md b/src/connections/destinations/catalog/actions-sprig-web/index.md index 76be4c9337..4d8f507dce 100644 --- a/src/connections/destinations/catalog/actions-sprig-web/index.md +++ b/src/connections/destinations/catalog/actions-sprig-web/index.md @@ -12,7 +12,7 @@ hidden: true [Sprig (formerly UserLeap)](https://sprig.com/?&utm_source=segmentio&utm_medium=docs_actions&utm_campaign=integration){:target="_blank"} is an in-context user research platform that makes it fast and effortless for product teams to learn from their actual customers in real-time, through microsurveys, concept tests, and video questions. -Sprig maintains this destination. For any issues with the destination, consult [Sprig's documentation](https://docs.sprig.com/docs/segment-web) or contact [support@sprig.com](mailto:support@sprig.com). +Sprig maintains this destination. For any issues with the destination, consult [Sprig's documentation](https://docs.sprig.com/docs/segment-web){:target="_blank”} or contact [support@sprig.com](mailto:support@sprig.com). diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/copy-pixel-id.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/copy-pixel-id.png new file mode 100644 index 0000000000..5779b94896 Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/copy-pixel-id.png differ diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/email-event-rule.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/email-event-rule.png new file mode 100644 index 0000000000..6c108a7fbb Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/email-event-rule.png differ diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/install-pixel-link.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/install-pixel-link.png new file mode 100644 index 0000000000..10dda554bd Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/install-pixel-link.png differ diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/order-completed-event-rule.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/order-completed-event-rule.png new file mode 100644 index 0000000000..d850eceeb0 Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/order-completed-event-rule.png differ diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/snowflake-mappings.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/snowflake-mappings.png new file mode 100644 index 0000000000..7ab6cc4a6d Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/snowflake-mappings.png differ diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/images/user-registered-event-rule.png b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/user-registered-event-rule.png new file mode 100644 index 0000000000..a4f493cfad Binary files /dev/null and b/src/connections/destinations/catalog/actions-stackadapt-cloud/images/user-registered-event-rule.png differ diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/index.md b/src/connections/destinations/catalog/actions-stackadapt-cloud/index.md new file mode 100644 index 0000000000..d0d132e18e --- /dev/null +++ b/src/connections/destinations/catalog/actions-stackadapt-cloud/index.md @@ -0,0 +1,172 @@ +--- +title: StackAdapt Destination +hide-boilerplate: true +hide-dossier: true +beta: true +id: 61d8859be4f795335d5c677c +hidden: true +redirect_from: '/connections/destinations/catalog/actions-stackadapt/' +--- + +{% include content/plan-grid.md name="actions" %} + +By setting up StackAdapt as a Segment destination, your Segment events will be forwarded to [StackAdapt](https://www.stackadapt.com/){:target="_blank"}. This allows you to generate retargeting and lookalike audiences, track conversions, and measure return on ad spend using your Segment events - bypassing the need to install the StackAdapt pixel on your website and write code to send events to StackAdapt. + +This destination is maintained by StackAdapt. For any issues with the destination, please [submit a ticket to StackAdapt's support team](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="_blank"}. + + +## Getting started + +### Getting your StackAdapt Universal Pixel ID + +1. Log in to your StackAdapt account and navigate to the Pixels page. +2. Above the list of pixels, click **Install StackAdapt Pixel**. + +  + +3. In the instructions that appear, copy the universal pixel ID from the code snippet. Below is an example of a code snippet where the universal pixel ID is `sqQHa3Ob1hFi__2EcYYVZg1`. + + + +### Setting up the StackAdapt destination in Segment + +1. From the Segment web app, navigate to **Connections > Catalog > Destinations**. +2. Search for and select the "StackAdapt" destination. +3. Click **Add Destination**. +4. Select an existing source to connect to the StackAdapt destination. +5. Give the destination a name. +6. On the Settings screen, provide your StackAdapt Universal Pixel ID. This can be found on the Pixels page in StackAdapt as described above. +7. Toggle on the destination using the **Enable Destination** toggle. +8. Click **Save Change**. + +### StackAdapt Pixel setup + +Segment events that are forwarded to StackAdapt can be used to track ad conversions, and to generate retargeting and lookalike audiences. Please review the StackAdapt documentation for the general setup of these if you are not already familiar: + +- [Creating Conversion Events](https://support.stackadapt.com/hc/en-us/articles/360005859214-Creating-Conversion-Events){:target="_blank"} +- [Creating Retargeting Audiences](https://support.stackadapt.com/hc/en-us/articles/360005939153-Creating-Retargeting-Audiences){:target="_blank"} +- [How to Generate and Target a Lookalike Audience](https://support.stackadapt.com/hc/en-us/articles/360023738733-How-to-Generate-and-Target-a-Lookalike-Audience){:target="_blank"} + +Setup of conversion events, retargeting audiences, and lookalike audiences that fire on Segment events is largely the same as the setup in the StackAdapt documentation, with a few caveats: + +1. You **must** select "Universal Pixel" as the pixel type. This is because the StackAdapt destination in Segment uses your Universal Pixel ID to send events to StackAdapt. +2. There is no need to install the StackAdapt pixel on your website as instructed in the "Installation" step, since Segment will forward events to StackAdapt that would normally be tracked by the StackAdapt pixel. +3. If you choose to set up event rules, you will need to ensure that you use the event keys supported by the the StackAdapt destination as described below. + +### Event rules + +The StackAdapt Segment destination sends an `action` event key which by default is mapped to the Segment event name. Creating rules on this `action` key should be sufficient for most simple event rule use cases. For example, if you fire a Segment event when a user fills out a registration form on your website and want to track this as a conversion event in StackAdapt, you can create a rule in StackAdapt that matches the `action` key with the Segment event name. + +A Segment event fired with the code `analytics.track("User Registered")` can be tracked as a conversion event with an event rule that matches an `action` of `User Registered` as shown below: + + + +#### Ecommerce events + +The StackAdapt destination also supports forwarding ecommerce fields for the purpose of creating event rules that match ecommerce events, with default mappings to properties specified in the [Segment V2 Ecommerce Event Spec](/docs/connections/spec/ecommerce/v2/) as described in the below table: + +| Segment Ecommerce Event Property | StackAdapt Event Key | +|----------------------------------|----------------------| +| `order_id` | `order_id` | +| `revenue` | `revenue` | +| `product_id` | `product_id` | +| `category` | `product_category` | +| `name` | `product_name` | +| `price` | `product_price` | +| `quantity` | `product_quantity` | + +For events that can involve multiple products, such as checkout events, StackAdapt forwards a JSON array of product objects with a `products` key and fields that map by default to following Segment product array fields: + +| Segment Ecommerce Event Property | StackAdapt Product Object Key | +|----------------------------------|-------------------------------| +| `products.$.product_id` | `product_id` | +| `products.$.category` | `product_category` | +| `products.$.name` | `product_name` | +| `products.$.price` | `product_price` | +| `products.$.quantity` | `product_quantity` | + +For example, to create a conversion event when an order is completed with a revenue value greater than 10, you could set up an event rule matching an `action` value of `Order Completed` and a `revenue` value greater than 10 as shown below: + + + +This rule would match a Segment event fired with code such as: + +```javascript +analytics.track('Order Completed', { + order_id: '50314b8e9bcf000000000000', + revenue: 11.5 + products: [ + { + product_id: '507f1f77bcf86cd799439011', + name: 'Monopoly: 3rd Edition', + price: 11.5, + quantity: 1, + category: 'Games' + } + ] +}); +``` + +#### Trait Fields + +Although trait fields are not frequently used in event rules, the StackAdapt destination forwards them and they can be used if desired. + +| Segment Trait Property | StackAdapt Event Key | +|------------------------|----------------------| +| `traits.email` | `email` | +| `traits.first_name` | `first_name` | +| `traits.last_name` | `last_name` | +| `traits.phone` | `phone` | + +For example, to create a conversion event when a user with the domain `example.com` completes an order, you could set up an event rule matching an `action` value of `Order Completed` and an `email` containing `@example.com` as shown below: + + + +This rule would match a Segment event fired with code such as: + +```javascript +analytics.track('Order Completed', { + order_id: '50314b8e9bcf000000000000', + traits: { + email: 'john.smith@example.com', + first_name: 'John', + last_name: 'Smith', + phone: '+180055501000' + } +}); +``` + +### URL rules + +If you are using URL rules, these will be matched whenever Segment sends an event to StackAdapt with a `url` matching the URL rule. This should be accomplished by the page event Segment automatically fires when a page is viewed, so setup of URL rules should be identical to setting up URL rules with the StackAdapt pixel. + +### Conversion Tracking with Backend Events + +When you send events to Segment from your backend, which are forwarded to StackAdapt using Segment's backend SDKs, the user agent and IP address of the user who originated the event must be included in the event context for conversions to be tracked. StackAdapt uses the user agent and IP address to attribute the conversion to the correct event to a user who has interacted with your ads. Examples of how to do this can be found in the documentation for Segment's SDKs. For example, for the [Python SDK](/docs/connections/sources/catalog/libraries/server/python/#override-context-value) this can be done as follows: + +```python +analytics.track('user_id', 'Order Completed', context={ + 'ip': '203.0.113.1', + 'userAgent': 'Mozilla/5.0 (Linux; U; Android 4.1.1; en-gb; Build/KLP) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Safari/534.30' +}) +``` + +This is necessary when using backend SDKs but not for events sent from the frontend with `analytics.js`, because `analytics.js` automatically includes the user-agent and IP address in the event context. + +### Conversion Tracking with Reverse ETL + +When sending past events to StackAdapt using a Reverse ETL tool, the user agent, IP address, event type, and either the page URL (for conversion trackers with URL rules), or the fields the event rules match on, must be included in your mappings. For example, the below mapping for a Snowflake source can be used to match a conversion tracker with an event rule that matches an `action` of `User Registered`: + + + +Rows forwarded to StackAdapt with this mapping will be matched by the `User Registered` event rule shown below: + + + +When forwarding past events using Reverse ETL, only users who have interacted with an ad from an associated campaign within the conversion tracker's configured view-through expiry window (for impressions) or click-through expiry window (for clicks) will count as conversions. These windows can be set to up to 180 days in the conversion tracker configuration. + +{% include components/actions-fields.html %} + +## Data and privacy + +Review [StackAdapt's Data Processing Agreement](https://www.stackadapt.com/data-processing-agreement){:target="_blank"} to learn more about StackAdapt's privacy and data terms. diff --git a/src/connections/destinations/catalog/actions-surveysparrow/index.md b/src/connections/destinations/catalog/actions-surveysparrow/index.md new file mode 100644 index 0000000000..73f2ca53c4 --- /dev/null +++ b/src/connections/destinations/catalog/actions-surveysparrow/index.md @@ -0,0 +1,22 @@ +--- +title: SurveySparrow (Actions) Destination +hidden: true +beta: true +--- +{% include content/plan-grid.md name="actions" %} + +[SurveySparrow](https://surveysparrow.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is an end-to-end omnichannel experience management platform that bundles Customer Experience and Employee Experience tools such as NPS, Offline, Chat, Classic, and 360 Surveys which are mobile-first, highly engaging, and user-friendly. + +This destination is maintained by SurveySparrow. For any issues with the destination, [contact their Support team](mailto:support@surveysparrow.com). + +## Getting started + +1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for "SurveySparrow" +2. Select SurveySparrow and click **Add Destination** +3. Select an existing Source to connect to SurveySparrow (Actions). +4. Log in to your [SurveySparrow](https://app.surveysparrow.com/) account, then navigate to **Settings > Apps and Integrations > Create a Custom app**. +5. Fill in the details for the custom app and choose **Select all** under Scope. Later, you can remove any scopes that are not required. +6. Click **Save** and copy the **Access Token**. +7. Enter the **Access Token** in the SurveySparrow destination settings in Segment. + +{% include components/actions-fields.html %} \ No newline at end of file diff --git a/src/connections/destinations/catalog/actions-survicate/index.md b/src/connections/destinations/catalog/actions-survicate/index.md new file mode 100644 index 0000000000..3ccd0f53e6 --- /dev/null +++ b/src/connections/destinations/catalog/actions-survicate/index.md @@ -0,0 +1,132 @@ +--- +rewrite: true +title: Survicate (Actions) Destination +id: 65a6ac19ea6d3ced628be00b +--- +[Survicate](https://survicate.com/integrations/segment-survey/?utm_source=segment&utm_medium=referral){:target="_blank”} is a complete toolkit for customer feedback. + +This destination is maintained by Survicate. For any issues with the destination, [contact the Survicate Support team](mailto:help@survicate.com). + + +## Getting Started + +1. From the Segment web app, click **Destinations**. +2. Search for "Survicate (Actions)" in the Catalog, select it, and choose which of your sources to connect the destination to. +3. Enter the "Workspace Key" into your Segment Settings UI which you can find from your [Survicate Workspace Settings](https://panel.survicate.com/o/0/w/0/settings/web-surveys){:target="_blank"}. +{% include components/actions-fields.html %} +## Identify + +If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like: + +``` +analytics.identify('userId123', { + email: 'john.doe@example.com', + jobTitle: 'CEO', + companySize: '50' +}); +``` + +When you call Identify, we pass Segment traits as respondents' attributes to Survicate. They can be used to trigger web surveys or filter survey results. + +All traits passed in Identify calls will be available in Survicate - once you view a respondent profile or export survey data. + +All `camelCase` attribute keys are translated to `snake_case`. + +All *object attributes* will be flattened to attributes prefixed by object key. All *array attributes* will be omitted. + +``` +analytics.identify('1234', { + address: { + street: '6th St', + city: 'San Francisco', + state: 'CA', + postalCode: '94103', + country: 'USA' + }, + categories: ['startup','SaaS'] +}); +``` + +The above described call creates following respondent's traits in Survicate: + +| key | value | +| ------------------- | ------------- | +| id | 1234 | +| address_street | 6th St | +| address_city | San Francisco | +| address_state | CA | +| address_postal_code | 94103 | +| address_country | USA | + +*Categories* attribute is omitted as it is an array attribute. + +## Group + +If you're not familiar with the Segment Specs, take a look to understand what the [Group method](/docs/connections/spec/group/) does. An example call would look like: + +``` +analytics.group('group123', { + name: 'Company Inc.' +}); +``` + +All Group traits will be passed to respondent attributes with `group_` prefix. All `camelCase` attribute keys are translated to `snake_case`. All *object attributes* will be flattened to attributes prefixed by object key. All *array attributes* will be omitted. + +``` +analytics.group('group123', { + name: 'Company Inc.', + address: { + street: '6th St', + city: 'San Francisco', + state: 'CA', + postalCode: '94103', + country: 'USA' + }, + categories: ['startup','SaaS'] +}); +``` + +The above described call creates the following respondent's traits in Survicate: + +| key | value | +| ------------------------- | ------------- | +| group_id | group123 | +| group_name | Company Inc. | +| group_address_street | 6th St | +| group_address_city | San Francisco | +| group_address_state | CA | +| group_address_postal_code | 94103 | +| group_address_country | USA | + +*Categories* attribute is omitted as it is an array attribute. + +## Track + +A Segment track call, f.ex: +``` +analytics.track('plan_purchased', { + plan: 'Pro Annual', + accountType : 'Facebook' +}); +``` + +will trigger a Survicate call that sends the event name and properties to Survicate. + +If you want to trigger your survey on a Segment event, you are able to do that by setting that condition in the panel in the targeting tab in the section: "When a user triggers an event" under "Where would you like to show the survey". + +When the Segment event fires and other targeting conditions you've set in the panel are met - your survey will show. + +Event properties are optional. + +### Sending survey answers to Segment + +Once the Segment integration is enabled in Survicate Integrations tab, it starts sending track events from your client-side source. Here's a sample call that will be triggered when a survey is answered. + +``` +analytics.track('survicate_survey_answered', { + answer: 'Great suppport!', + answer_type: 'text', + question: 'What makes us stand out from the competition?', + survey: 'Advantages Over Competition Research', +}); +``` diff --git a/src/connections/destinations/catalog/actions-the-trade-desk-crm/index.md b/src/connections/destinations/catalog/actions-the-trade-desk-crm/index.md new file mode 100644 index 0000000000..dbdd3db628 --- /dev/null +++ b/src/connections/destinations/catalog/actions-the-trade-desk-crm/index.md @@ -0,0 +1,67 @@ +--- +title: The Trade Desk CRM Destination +hide-personas-partial: true +hide-boilerplate: true +hide-dossier: false +beta: true +id: 6440068936c4fb9f699b0645 +redirect_from: "/connections/destinations/catalog/the-trade-desk-crm/" +--- + +[The Trade Desk](https://www.thetradedesk.com/us){:target="_blank"} empowers companies and their partners to leverage data in their expansive data marketplace, facilitating seamless discovery, creation, and engagement with valuable audiences. Segment's integration with The Trade Desk allows you to push first-party user data from audiences created in [Twilio Engage](https://www.twilio.com/en-us/engage){:target="_blank"} to The Trade Desk platform, enhancing targeted reach to brand's first-party audiences. + +This integration lets users link Engage audiences to The Trade Desk and transmit Personally Identifiable Information (PII), including email addresses and hashed emails. Users have the flexibility to configure their delivery preferences within Segment. + +The Trade Desk destination can only be connected to Twilio Engage sources. + +## Getting started + +### Obtaining credentials from The Trade Desk + +> info "" +> Contact your The Trade Desk account manager to sign the UID POC contract before you activate audiences on The Trade Desk. Afterwards, The Trade Desk will grant permission and share your advertiser ID and secret key for configuring your destination. + +Before you begin, generate a [long-lived token](https://partner.thetradedesk.com/v3/portal/api/doc/Authentication#ui-method-create){:target="_blank"} on [The Trade Desk's Developer Portal](https://api.thetradedesk.com/v3/tokens){:target="_blank"}. + +### Connecting The Trade Desk CRM + +1. Go to the Segment web app and navigate to **Engage > Audiences**. Ensure you are in the Engage space you intend to use with The Trade Desk. Choose an existing Engage Audience or create a new one. This is the audience you plan to send to The Trade Desk. +2. Access **Engage > Engage Settings** and click on **Destinations**. Confirm that you are in the correct Engage space. +3. Search for **The Trade Desk CRM** and select the destination. +4. Click on **Configure The Trade Desk CRM**. +5. On the **Select Source** screen, your Engage space should already be selected as the source. Click on **Confirm Source**. +6. Generate a [long-lived token](https://partner.thetradedesk.com/v3/portal/api/doc/Authentication#ui-method-create){:target="_blank"} on [The Trade Desk's Developer Portal](https://auth.thetradedesk.com/Account/Login?ReturnUrl=%2Fconnect%2Fauthorize%2Fcallback%3Fclient_id%3Dttd-dev-portal%26redirect_uri%3Dhttps%253A%252F%252Fpartner.thetradedesk.com%252Fv3%252Fsignin-oidc%26response_type%3Dcode%26scope%3Dopenid%2520profile%2520email%2520ttdui_refresh%2520offline_access%2520applications%26code_challenge%3DG5xIiN4NLQYS_L9kqCGZyWg678USH1pV6D2Iqu1e1Q8%26code_challenge_method%3DS256%26response_mode%3Dform_post%26nonce%3D638441362885322803.NWFjOTk2NTMtMzkyOS00NmJmLWE3N2YtODZlYzZjNGQxZWQ1M2E3OGI1ZmUtOThmNC00MDA5LWFiNzQtZmZiZGI2OTUzMzMy%26state%3DCfDJ8BBsgv10-z9IvE3EffVp_QCSKM7pxVdw3rv-shU-_OG4utdVslWzvw8nfZ0D8TKi75uKGCMPp2hiM-IBxjjwToGR-ryK13SXlVMOGMxXj_FUEV8nQfnRR1oQN6YZED0-48NhERsQr96xbaz6a_pVR_z5OZWgQ6RR9MBMUkHYF5tFp651wtbno-7ES1-zsje7hCqzFMTAVV_qAoNur-f8MGkMdw7oSAOQmoYOW4zV2w6SIMLSIOkUvariDC9EAAVPYTjonQdieo2V0rYscC-aVG6U8ASV3yqJc6RmnGRUEVnKHPt-ZZcvy9PHA2-Et04QlGwz6b-buRbNXd3v1E6zuMC5F7dxcT3otr5TQ4yMuC1JA5VRxT4c1tFON2lY4jtxKuyQIQs5N3a59eFc1wGdUSo%26x-client-SKU%3DID_NETSTANDARD2_0%26x-client-ver%3D6.10.0.0){:target="_blank"}. +7. After authenticating, enter your Authentication Token and Advertiser ID from your [The Trade Desk's CRM Data Platform API](https://api.thetradedesk.com/v3/portal/data/doc/DataIntegrateCRMData){:target="_blank"} account. Enable the destination by toggling **Enable Destination** and click **Save Changes**. +8. Navigate to the **Mappings** tab, click **New Mapping**, and choose **Sync Audience to CRM Data Segment**. +9. In the **Select mappings** section, input the PII Type and maintain other defaults. Click **Save** and toggle to enable the mapping. + - **Create only one mapping for every instance.** + - If any of the emails stored in your Engage audience are already in a hashed format, please specify the PII type as `Hashed Email.` Failure to do so results in The Trade Desk categorizing the hashed records as invalid during the ingestion process. +10. Return to **Engage > Audiences** and select the audience from Step 1. +11. Click **Add Destinations** and choose The Trade Desk CRM destination you just created. In the settings that appear in the side panel, enable the **Send Track** option and **do not** alter the Audience Entered/Audience Exited event names. Fill out the audience settings, specifically the region field, with the geographical region of the CRM data segment based on the origin of the PII (US, EU, or APAC). Click **Save Settings**. + +Setup is now complete, and the audience starts syncing to The Trade Desk. + +To sync additional Audiences from your Engage space, create a separate instance of The Trade Desk CRM Destination. + +{% include components/actions-fields.html settings="true"%} + + +## Limitations + +* An audience must have at least 1500 unique members; otherwise, the destination fails, and the data won't sync. +* Audience attempts to sync once per day. +* Audience sync is a full sync. + +## FAQs + +#### How is the CRM Segment Created? + +When connecting your audience from your Engage source to an enabled TTD destination, there's no need to manually create CRM Segments. Segment automatically generates a CRM Segment in your TTD account, mirroring the name of the audience linked to the TTD instance. + +#### How does TTD handle emails that don't already exist? + +The CRM endpoint maps email addresses into UID2s. If it's a valid email address, TTD generates a UID2 for it. However, if there are no bid requests coming in from the SSP with the specific UID2, then the ID would exist in the segment until it hits the TTL and won't be used when purchasing an impression. + +#### What PII format should I send? + +The Trade Desk recommends transmitting personally identifiable information (PII) in its original, non-hashed format. TTD's preference is to handle the hashing of any PII, like emails, on their end. However, if your data already contains any hashed emails, please ensure you are normalizing and hashing the emails by designating the PII type as `Hashed Email`, in line with TTD's [PII Normalization and Hash Encoding](https://api.thetradedesk.com/v3/portal/data/doc/DataPiiNormalization){:target="_blank”} documentation. diff --git a/src/connections/destinations/catalog/actions-tiktok-audiences/index.md b/src/connections/destinations/catalog/actions-tiktok-audiences/index.md index 28e9fcd3d7..45ba7c9e69 100644 --- a/src/connections/destinations/catalog/actions-tiktok-audiences/index.md +++ b/src/connections/destinations/catalog/actions-tiktok-audiences/index.md @@ -4,25 +4,59 @@ id: 63d2e550fb90f1632ed8820a hide-personas-partial: true hide-boilerplate: true hide-dossier: false -hidden: true --- -The TikTok Audiences destination enables advertisers to send Engage audiences to TikTok as Custom Audiences using [TikTok's Segment API](https://ads.tiktok.com/marketing_api/docs?id=1739940504185857){:target="_blank"}. +The TikTok Audiences destination enables advertisers to send Twilio Engage audiences to TikTok as custom audiences using [TikTok's Audience API](https://business-api.tiktok.com/portal/docs?id=1739940504185857){:target="_blank"}. By using Segment's TikTok Audiences destination, you can increase traffic and drive conversions with hyper-relevant ads that promote product discovery. -> info "" -> The TikTok Audiences destination is in beta and is in active development. Some functionality may change before it becomes generally available. - ## Getting started +### Notes + +- If you created a TikTok Audiences destination instance before September 25th, 2023, your instance(s) and all subsequent instances are considered _legacy_ instances. To create a new _legacy_ instance, see the [Create a TikTok audience (Legacy)](#create-a-tiktok-audience-legacy){:target="_blank"} documentation. Users who created their first instance after September 25, 2023 are considered to have _native_ instances. To create a new _native_ instance, see [Configure the TikTok Audiences destination](#configure-the-tiktok-audiences-destination){:target="_blank"} documentation. +- Both _legacy_ and _native_ instances have the same set of features, but are configured differently. Legacy instances require you to create an audience or action manually, but native instances automatically create audiences and actions. +- If you update the events names from the default Audience Entered/Audience Exited, please make sure to also update it in the "Add to Audience" and "Remove from Audience" mappings. +- TikTok [requires](https://business-api.tiktok.com/portal/docs?id=1739940585975809){:target="_blank"} `phone` number to be formatted in E.164 form, e.g. `+1231234567`. If your phone number is missing country code, you can prepend `+1` in the Action Mapping. +- For more information about how to update from _legacy_ to _native_, reach out to [friends@segment.com](mailto:friends@segment.com). + ### Prerequisites -1. Before connecting to the TikTok Audiences destination, you must have a [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account. +Before connecting to the TikTok Audiences destination, you must have a [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account. + +### TikTok Audience Segments + +Send Engage audiences to an existing TikTok audience segment or create a new audience. Note the `audience_id` as this is required to send Engage audiences to TikTok. + +### Configure the TikTok Audiences destination + +1. From the Segment web app, navigate to **Engage > Audiences**. Choose an existing Engage audience or create a new one. Ensure you are in the Engage space you plan to use with the TikTok Audiences destination. + +2. Navigate to **Engage > Engage Settings** and click **Destinations**. + +3. Search for “TikTok Audiences” and select the destination. Click **Configure TikTok Audiences**. + +4. On the Select Source screen, your Engage space should already be selected as the source. Click **Confirm Source**. + +5. On the **Settings** tab for the TikTok Audiences destination, name your destination and authenticate with TikTok Audiences using OAuth. + +6. Once authenticated, toggle “Enable Destination” on and click **Save Changes**. + +7. Navigate to the **Mappings** tab, click **New Mapping**, and select **Add to Audience**. -2. You must also have an audience segment created in your TikTok Advertising account. You can send Engage audiences to an existing audience segment, or you can create a new audience in TikTok. Please take note of the `audience_id` as this will be required to send Engage audiences to TikTok. See TikTok's [Create/Delete an audience segment](https://ads.tiktok.com/marketing_api/docs?id=1739940583739393){:target="_blank"} for instructions on how to create a TikTok audience segment. +8. Navigate to the **Mappings** tab, click **New Mapping**, and select **Remove from Audience**. -### Connect the TikTok Audiences destination +9. Navigate back to **Engage > Audiences** and click on the audience from step 1. + +10. Click **Add Destinations** and select the TikTok Audiences destination you just created. + In the settings that appear in the side panel, toggle the **Send Track** option on and **Send Identify** option off. Provide the [Advertiser ID](https://ads.tiktok.com/help/article/ad-account-information-faq?lang=en){:target="_blank"} linked to the TikTok account that will receive the audience data, as well as the **ID Type** of data you'll be sending. Click **Save Settings**. + +The setup is complete and the audience will start syncing to TikTok. The audience will appear in your [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account under **Assets > Audiences**. Please note that it can take 24-48 hours for users to appear in TikTok. + +### Connect the TikTok Audiences (_Legacy_) destination + +> info "" +> Add User and Remove User are considered legacy actions. 1. From the Segment web app, navigate to **Engage > Audiences**. Ensure you are in the Engage space you plan to use with the TikTok Audiences destination. Either choose an existing Engage audience or create a new one. This is the audience you plan to send to TikTok. @@ -40,7 +74,9 @@ By using Segment's TikTok Audiences destination, you can increase traffic and dr 8. Under Select mappings, select the TikTok "Advertiser ID" of the audience segment you want to add users to. Input the `audience_id` of that audience segment under "Audience ID." **Note: A separate mapping must be created for each audience segment you plan to send Engage audiences to.** -9. Repeat Steps 7 and 8 to also set up a **Remove Users** mapping. + **Note:** Once you've created the audience using the name of Segment's audience key, you can get the Audience ID from TikTok's Assets>Audiences page. You'll also find the Advertised ID, noted by `aadvid`, over the TikTok URL. + +9. Repeat steps 7 and 8 to also set up a **Remove Users** mapping. 10. Navigate back to **Engage > Audiences** and click on the audience from Step 1. @@ -48,6 +84,29 @@ By using Segment's TikTok Audiences destination, you can increase traffic and dr The setup is complete and the audience will start syncing to TikTok. The audience will appear in your [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account under **Assets > Audiences**. Please note that it can take 24-48 hours for users to appear in TikTok. -To sync additional audiences from your Engage space, create a separate mapping in the TikTok Audiences destination. Navigate to **Connections > Destinations**, search and select the TikTok Audiences destination, and follow Steps 7-11 above. +To sync additional audiences from your Engage space, create a separate mapping in the TikTok Audiences destination. Navigate to **Connections > Destinations**, search and select the TikTok Audiences destination, and follow steps 7-11 above. + +### Create a TikTok Audience + +To create an audience in Segment: + +1. Navigate to New Mapping and select **Create Audience**. +2. On the Add test event panel, click **Load Sample Event**. +3. Fill in the mappings on the Select mappings panel accordingly. +4. On the Send test event panel, click **Test Mapping**. +5. You've created your audience. Copy the `audience_id` from the response as you will need it to create additional mappings. + +You can use the same mapping to create as many audiences as you'd like. To create another audience, change the audience name and click **Test Mapping**. + +You can create a duplicate audience since TikTok doesn't restrict users from having multiple audiences with the same name. If you click **Test Mapping** multiple times, you will create audiences with the same name. However, each audience will have its own unique `audience_id`. + +You do not need to update the status of the mapping to `enabled`. + +For instructions on how to create a TikTok audience segment, see TikTok's [Create/Delete an audience segment](https://ads.tiktok.com/marketing_api/docs?id=1739940583739393){:target="_blank"} docs. {% include components/actions-fields.html %} + +## FAQS + +### Why is my audience considered too small in TikTok? +[TikTok](https://ads.tiktok.com/help/article/custom-audiences?lang=en) requires a minimum audience size of 1,000 to target Custom Audiences in an ad group. diff --git a/src/connections/destinations/catalog/actions-tiktok-offline-conversions/index.md b/src/connections/destinations/catalog/actions-tiktok-offline-conversions/index.md new file mode 100644 index 0000000000..6927ed4f3f --- /dev/null +++ b/src/connections/destinations/catalog/actions-tiktok-offline-conversions/index.md @@ -0,0 +1,55 @@ +--- +title: Tiktok Offline Conversions (Actions) Destination +id: 6447ca8bfaa773a2ba0777a0 +--- + +{% include content/plan-grid.md name="actions" %} + +[Tiktok's Offline Events API](https://ads.tiktok.com/marketing_api/docs?id=1758049779688450){:target="_blank”} helps advertisers measure how TikTok ads result in offline customer actions, such as in-store purchases or offline subscriptions, purchases and more. Attributing online and offline events is an important step for advertisers to measure omni-channel results from their campaigns. + +**Benefits** +- **Measure how TikTok ads influence offline conversions.** Learn what online strategies lead to better Brick & Mortar sales, subscription sign-ups or leads. +- **Power holistic attribution models with cross-channel event tracking.** Combine online and offline touchpoints to get comprehensive campaign metrics, like ROAS. +- **Reach offline customers online with custom audiences.** Promote new products or services to high-value customers who initiative offline events. + + +This destination is maintained by Tiktok. For any issues with the destination, [contact their Support team](mailto:segmenteng@bytedance.com). + +## Getting started + +Prior to setting up the **TikTok Offline Conversion Destination**, please create an Offline Event Set and generate the Access Token for it from **TikTok Events Manager**. + +1. From the Segment web app, click **Catalog**, then click **Destinations**. +2. Find the Destinations Actions item in the left navigation, and click it. +3. Click **Configure Tiktok Offline Conversions (Actions)**. +4. Select an existing Source to connect to Tiktok Offline Conversions (Actions). +5. Give Destination a name. +6. On the Settings screen, provide Access Token and Event Set ID. +7. Toggle on the Destination. +8. Hit the Save Change button. + +**Mappings Enabled by Default** + +After setting up the Destination, four mappings will be enabled by default. You can click on the mappings tab to view and edit these mappings. + +- Complete Payment: use this to track offline purchase events +- Subscribe: use this to track offline subscription events +- Contact: use this to track offline contact events +- Submit Form: use this to track offline form submissions + +{% include components/actions-fields.html %} + +## Acess Token & Event Set ID +Please refer to the [documentation](https://ads.tiktok.com/marketing_api/docs?id=1758051319816193){:target="_blank”} to obtain the **Access Token** and the **Event Set ID**. + +## PII Requirement & Validation +TikTok Offline Events API requires at least one type of PII (email addresses and/or phone numbers) to be included in all offline conversion events. The email addresses and phone numbers will be hashed using SHA 256 from Segment before they are sent to TikTok. TikTok Offline Conversions Destination will automatically hash the provided PII, so please do not hash the PIIs before sending them to Segment. In addition, TikTok Offline Conversions Destination will validate all offline events before forwarding them to TikTok Offline Events API. TikTok Offline Conversions Destination will not send any offline events to TikTok with invalid or missing PIIs. + +## Data and Privacy Considerations +- Every offline event sent to TikTok Offline Events API requires at least one email address or phone number. +- E-mails and phone numbers will be hashed in a privacy-safe way by default so that TikTok cannot identify customers who are not TikTok users. +- iOS compliance checks will be performed on PII (ATT opt-out users will still be reported and attributed). +- TikTok will pruge unmatched offline conversions IDs/records. + + +--- diff --git a/src/connections/destinations/catalog/actions-tiktok-pixel/index.md b/src/connections/destinations/catalog/actions-tiktok-pixel/index.md new file mode 100644 index 0000000000..5cb68cb960 --- /dev/null +++ b/src/connections/destinations/catalog/actions-tiktok-pixel/index.md @@ -0,0 +1,69 @@ +--- +title: TikTok Pixel Destination +id: 64c1690a9f08c84a420aba78 +--- + +{% include content/plan-grid.md name="actions" %} + +[TikTok Pixel](https://ads.tiktok.com/marketing_api/docs?id=1739583652957185){:target="_blank"} is a piece of code that you can place on your website that allows you to share website events with TikTok. With TikTok for Business Tools, the Pixel can help you measure traffic on your website, measure ad campaign performance, optimize your campaigns and find new customers. + +### Benefits of TikTok Pixel + +Use data collected from TikTok Pixel to: +- **Build marketing audiences**: Create custom Audiences based on website visitor events, like viewing a product page or making a purchase. Audiences can be used to re-engage previous site visitors or model lookalikes to find new customers. +- **Optimize ad delivery**: Target Audiences that are more likely to initiate a website event by setting an optimization goal on visitor events like add to cart, view page, or purchase. +- **Measure campaign performance**: Measure your ad performance and return on ad spend (ROAS) based on a series of conversion events you define. + +This destination is maintained by TikTok. For any issues with the destination, [contact TikTok's Support team](mailto:segmenteng@bytedance.com). + +## Getting started + +1. From the Segment web app, click **Catalog**, then click **Destinations**. +2. Search for "TikTok Pixel" in the search bar, then click on the Destination "TikTok Pixel". +3. Click **Add Destination**. +4. Select an existing JavaScript Source to connect to TikTok Pixel. +5. Give the Destination a name. +6. On the Settings screen, provide the Pixel Code. This can be found in the TikTok Events Manager (TTEM). +7. Toggle on the Destination using the **Enable Destination** toggle. +8. Click **Save Change**. + +### Mappings enabled by default + +After setting up the Destination, Segment enables seven mappings by default. You can click on the mappings tab to view and edit these mappings. + +- **View Content**: When a page is viewed +- **Search**: When a search is made +- **Add to Wishlist**: When an item is added to a wishlist +- **Add to Cart**: When an item is added to the shopping cart +- **Initiate Checkout**: When the checkout process is started +- **Add Payment Info**: When payment information is added in the checkout flow +- **Place an Order**: When an order is placed + +{% include components/actions-fields.html %} + +## Getting started with Pixel and obtaining the Pixel code + +Please refer to the [TikTok Help Center documentation](https://ads.tiktok.com/help/article/get-started-pixel?redirected=2){:target="_blank"} to learn more about how to get started with TikTok Pixel. Once the Pixel is created, please retrieve the Pixel Code from TikTok Events Manager (TTEM). + +## Advanced Matching + +Advanced Matching helps you optimize your TikTok ads and drive performance by matching customer information with TikTok users. Hashed customer information can be shared with any TikTok event to attribute more conversions, build bigger audiences, and improve campaign optimization. + +There are two types of Advanced Matching: manual or automatic. + +**Manual Advanced Matching** is the passing of customer information to TikTok from your website. With this option, you have the flexibility to configure what information and for which event you want to pass to TikTok. This will be enabled automatically if PIIs are included in the Pixel events sent from TikTok Pixel Destination. + +When email and/or phone number values are sent to TikTok, TikTok will try to match users with the PII you send to TikTok. If you don't send email or phone number values, TikTok will try to match users with IP and user-agent values that are included in the Pixel event payload. + +**Automatic Advanced Matching** is when advertisers instruct TikTok to automatically identify form fields on pages where Pixel is installed and to hash and collect email and phone numbers entered on those pages for ad measurement and attribution purposes. Learn more about Automatic Advanced Matching and how to turn it on in [TikTok help center](https://ads.tiktok.com/help/article/advanced-matching-web?lang=en){:target="_blank"}. + +To maximize Advanced Matching's performance, TikTok recommends using both Manual and Automatic Advanced Matching at the same time. + +## PII hashing +- TikTok hashes all values with `sha256` before processing. + +- Normalize phone numbers you send to TikTok with in the `E.164` format. This format is a combination of `+［country code]［phone number]`. For example: `+12133734253`. + +## Data and privacy + +Visit TikTok's [docs](https://ads.tiktok.com/i18n/official/policy/business-products-terms){:target="_blank"} to learn more about TikTok's privacy and data terms. diff --git a/src/connections/destinations/catalog/actions-toplyne-cloud/index.md b/src/connections/destinations/catalog/actions-toplyne-cloud/index.md index 9db1283d96..7082de33e8 100644 --- a/src/connections/destinations/catalog/actions-toplyne-cloud/index.md +++ b/src/connections/destinations/catalog/actions-toplyne-cloud/index.md @@ -1,26 +1,17 @@ --- -# The end name should be similar to `Slack Destination` title: Toplyne Cloud Mode (Actions) Destination beta: true hide-boilerplate: true hide-dossier: true -hidden: true -private: true id: 6408ac6c144a7d5ac55cf414 ---- - - +private: false +hidden: false +--- {% include content/plan-grid.md name="actions" %} [Toplyne](https://www.toplyne.io/){:target="_blank"} is a headless Sales AI for revenue teams. Toplyne's AI captures and understands every user click passed through Segment and enriches it with demographic data (through 3rd party enrichment tools). Toplyne then delivers opportunities for expansion and conversion into your existing CRM. Toplyne does this without involving your data and engineering teams. Cloudflare, Vercel, and Canva depend on Toplyne to build predictable pipelines and improve conversions and expansions for their sales and account management teams. - - -{% include content/ajs-upgrade.md %} - - - ## Benefits of Toplyne (Actions) Toplyne (Actions) provides the following benefits: @@ -29,7 +20,7 @@ Toplyne (Actions) provides the following benefits: - **Clear mapping of data** Actions-based destinations enable you to define the mapping between the data Segment received from your source and the data Segment sends to Toplyne. - **Pre-built mapping.** Mappings for Toplyne, are prebuilt with the prescribed parameters and available for customization - **No 3rd party tool is involved.** Move the data directly from Segment to Toplyne without the requirement of a 3rd party tool to facilitate the data sync. - + ## Getting started @@ -43,9 +34,6 @@ Toplyne (Actions) provides the following benefits: 8. Copy the access token that has just been generated. This will be the API key that you will enter in Segment. 9. Save your changes and enable the destination. - - {% include components/actions-fields.html %} - + +{% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-upollo/index.md b/src/connections/destinations/catalog/actions-upollo/index.md index 7709441ef4..20bbe96329 100644 --- a/src/connections/destinations/catalog/actions-upollo/index.md +++ b/src/connections/destinations/catalog/actions-upollo/index.md @@ -5,10 +5,11 @@ id: 640267d74c13708d74062dcd {% include content/plan-grid.md name="actions" %} -[Upollo](https://upollo.ai?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} finds and converts repeat trialers, account sharers and more. +[Upollo](https://upollo.ai?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} gives unique and actionable insights that lead to conversion, retention and expansion. -11% of users signing up for free trials have [already had a free trial](https://upollo.ai/blog/turn-repeated-trials-into-growth?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"}, and up to 45% of users [share their logins](https://upollo.ai/blog/grow-by-understanding-account-sharing?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} with others. -Inviting these users to a paid account is the top underutilized growth channel for SaaS businesses. +Understand who your users truly are, if they are ready to convert, churn or expand and why they are ready. Upollo provices unique insights from users who are ready to convert because they have [already had a free trial](https://upollo.ai/blog/turn-repeated-trials-into-growth?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"}, a company ripe for a team wide roll out because they [share logins](https://upollo.ai/blog/grow-by-understanding-account-sharing?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} or finding high intent companies [hidden behind public emails](https://upollo.ai/blog/hidden-goldmine-public-emails){:target="_blank”}. + +Upollo also enriches your identify data with firmopgrahic data so you can understand your users in Upollo or in your data warehouse. See company name, size and industry for your users as soon as they sign in, for free at unlimited scale. Upollo maintains this destination. For any questions or issues with the destination, please [contact the Upollo team](https://upollo.ai/contact?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"}. @@ -16,13 +17,12 @@ Upollo maintains this destination. For any questions or issues with the destinat Upollo (Actions) provides the following benefits: -- **Find hidden growth opportunities**. Quickly see how many users are repeating free trials or sharing their account. +- **Find hidden growth opportunities**. Quickly see opportunities to convert, retain and expand. - **More happy paying customers**. Upgrade these users onto a paying plan and get more happy paying users. ## Getting Started - -1. From the Segment web app, navigate to **Connections > Catalog**, and select the **Destinations** tab. +1. From the Segment web app, navigate to **Connections > Catalog**, and select the **Destinations** tab. 2. Select **Destinations Actions** under **Categories** in the left navigation. 3. Search for **Upollo (Actions)** and click **Configure Upollo**. 4. Select an existing Source to connect to Upollo (Actions). @@ -31,15 +31,15 @@ Upollo (Actions) provides the following benefits: ## Identify -Upollo uses the `identify` call to analyze users on your platform. If the same person is using multiple accounts or if different people are sharing an account, they are flagged and shown in the Upollo dashboard. - +Upollo uses the `identify` call to analyze users on your platform. Our unique insights shown in the Upollo dashboard and optionally enriched data is added to identify events. The `identify` call provides any available information about the user. + ```js -analytics.identify('userId123', { - email: 'john.doe@example.com', - name: 'John Doe', - phone: '+123456789' +analytics.identify("userId123", { + email: "john.doe@example.com", + name: "John Doe", + phone: "+123456789", }); ``` diff --git a/src/connections/destinations/catalog/actions-usermotion/index.md b/src/connections/destinations/catalog/actions-usermotion/index.md new file mode 100644 index 0000000000..53d884712a --- /dev/null +++ b/src/connections/destinations/catalog/actions-usermotion/index.md @@ -0,0 +1,22 @@ +--- +title: UserMotion (Actions) Destination +id: 6537b5da8f27fd20713a5ba8 +beta: true +--- + +{% include content/plan-grid.md name="actions" %} + +[UserMotion](https://usermotion.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="\_blank”} is AI-powered predictive lead scoring software that discovers intention signals and scores leads on potential to buy, expand, or churn. + +This destination is maintained by UserMotion. For any issues with the destination, [contact their Support team](mailto:support@usermotion.com). + +## Getting started + +1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="\_blank”} search for "UserMotion (Actions)". +2. Select UserMotion (Actions) and click **Add Destination**. +3. Select an existing Source to connect to UserMotion (Actions). +4. Go to the [UserMotion dashboard](https://app.usermotion.com/?returnPath=/settings/integrations?provider=api){:target="\_blank"}, find and copy the **API key**. +5. Enter the **API Key** in the UserMotion destination settings in Segment. +6. Save your changes and enable the destination. + +{% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-vwo-cloud/index.md b/src/connections/destinations/catalog/actions-vwo-cloud/index.md index 0c5e1f06e4..837a8a3e26 100644 --- a/src/connections/destinations/catalog/actions-vwo-cloud/index.md +++ b/src/connections/destinations/catalog/actions-vwo-cloud/index.md @@ -10,10 +10,10 @@ versions: {% include content/plan-grid.md name="actions" %} -[VWO](https://vwo.com/) is an optimization platform that allows websites to run experiments on their platforms to derive insights from visitor behavior and harness the results to amp up the conversion rate. Apart from experimentation, it also provides for personalization of the platform for different cohorts, full stack implementation, and direct deployment of the changes determined through experimentation. +[VWO](https://vwo.com/){:target="_blank"} is an optimization platform that allows websites to run experiments on their platforms to derive insights from visitor behavior and harness the results to amp up the conversion rate. Apart from experimentation, it also provides for personalization of the platform for different cohorts, full stack implementation, and direct deployment of the changes determined through experimentation. > info "" -> The events and attributes that are transferred from Segment to your VWO account will appear under [Unregistered Events](https://help.vwo.com/hc/en-us/articles/8676443712537-Working-with-Events-in-VWO#:~:text=UNREGISTERED%20EVENTS%3A%20These%20are%20the,UNREGISTERED%20EVENTS.){:target="_blank"} and [Unregistered Attributes](https://help.vwo.com/hc/en-us/articles/8681465703705-Working-with-Attributes-in-VWO#:~:text=UNREGISTERED%20ATTRIBUTES%3A%20These%20are%20the,UNREGISTERED%20ATTRIBUTES.){:target="_blank"} sections, respectively. You need to save these events and attributes to VWO for further use. +> The events and attributes that are transferred from Segment to your VWO account will appear under [UNREGISTERED EVENTS](https://help.vwo.com/hc/en-us/articles/8676443712537-Working-with-Events-in-VWO#:~:text=UNREGISTERED%20EVENTS%3A%20These%20are%20the,UNREGISTERED%20EVENTS.){:target="_blank"} and [UNREGISTERED ATTRIBUTES](https://help.vwo.com/hc/en-us/articles/8681465703705-Working-with-Attributes-in-VWO#:~:text=UNREGISTERED%20ATTRIBUTES%3A%20These%20are%20the,UNREGISTERED%20ATTRIBUTES.){:target="_blank"} sections, respectively. You need to save these events and attributes to VWO for further use. ## Benefits of VWO Cloud Mode(Actions) vs VWO Classic @@ -32,6 +32,172 @@ VWO Cloud Mode (Actions) provides the following benefits over the classic VWO de 6. To customize the mapping of actions, follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). Mappings in Segment allow you to control the events and attributes that are sent to VWO. 7. Enable the destination using the toggle switch. +> info "" +> VWO requires you to include a `vwo_uuid` key for all calls made in cloud-mode. The value of this key must be the VWO UUID(in the case of a website) or the User ID (in the case of FullStack). Track and Page calls require the `vwo_uuid` in the *properties* object. For Identify calls, you can place `vwo_uuid` in the *traits* object. + +## Using VWO Cloud mode destination with Web + +> info "" +> VWO recommends using the [VWO Web Mode destination](/docs/connections/destinations/catalog/actions-vwo-web/) for web pages as it requires minimal to no additional setup. + +1. Install the VWO SmartCode on your website following VWO's guide [Configuring SmartCode for Your Website](https://help.vwo.com/hc/en-us/articles/360019422834-Configuring-SmartCode-for-Your-Website){:target="_blank"} +2. Create a VWO campaign on your website. +3. When a visitor lands on your website VWO generates a `_vwo_uuid` cookie that acts as a unique identifier for the visitor. To learn more about the VWO UUID, see VWO's article [How to locate your VWO UUID](https://help.vwo.com/hc/en-us/articles/360034891513-How-to-Locate-your-VWO-UUID-){:target="_blank"}. +4. Pass the value of the `_vwo_uuid` cookie with every call to Segment in the `vwo_uuid` key. Track and Page calls require the `vwo_uuid` in the *properties* object. For Identify calls, you can place `vwo_uuid` in the *traits* object.
To automate this step, you can use [Segment Analytics.js middleware](/docs/connections/sources/catalog/libraries/website/javascript/middleware/) and use the following script on your website. This script fetches the VWO UUID from the cookie and adds it to the segment payload so that you don’t have to do the same manually. + +```html + +``` + +All the events triggered in Segment will be available under **UNREGISTERED EVENTS** in the **Data360 > Events** section in VWO. For more information about Events in VWO Data360, see VWO's article [Working with Events in VWO](https://help.vwo.com/hc/en-us/articles/8676443712537-Working-with-Events-in-VWO){:target="_blank"}. + +## Using VWO Cloud mode destination with VWO FullStack + +To use the VWO Cloud mode destination with the VWO FullStack suite, link your VWO FullStack environment with Segment using the environment’s SDK key. After that's done, integrate your VWO account with Segment. + +To link your VWO FullStack environment with Segment: + +1. From your VWO dashboard, navigate to the nav bar on the left > **FullStack > Projects** and select the appropriate project. +2. Under the **Environments** section, click the **Copy** button corresponding to the environment that you want to link to Segment. +3. In the **VWO SDK Key** field in the destination settings in Segment, paste the copied SDK key from the previous step. +4. Click **Save Changes**. + +To integrate Segment with VWO FullStack: + +1. Initialize VWO FullStack SDK. Follow the steps for your server in VWO's [Quick Start Guide](https://developers.vwo.com/docs/quick-start-guide){:target="_blank"}. +2. To track visitors in VWO, provide the user IDs of the visitors, which were used to track them in the VWO FullStack campaign. Pass that same User ID as `vwo_uuid` with all calls to Segment. Track and Page calls require the `vwo_uuid` in the *properties* object. For Identify calls, you can place `vwo_uuid` in the *traits* object.. +3. All the events triggered in Segment will be available under **UNREGISTERED EVENTS** section which can be accessed by navigating from the left navbar > **Data360 > Events**. + +## Using VWO Cloud mode destination with audiences in VWO + +By adding the VWO Cloud mode destination to your Segment audiences, you can export audiences to your VWO account to target your campaigns in VWO. To achieve this, perform the following steps: + +1. Navigate to **Engage > Engage Settings**, and click **Destinations**. +- Ensure that you're in the Engage space you plan to use for VWO. +2. Click **Add Destination**. +3. Search for “VWO Cloud Mode (Actions)” and select the destination. Click **Add Destination**. +4. On the **Select Source** screen, you'll see your Engage space selected as the source. Click **Confirm Source**. +5. Select the VWO Cloud mode destination that you’ve created and navigate to the **Settings** tab. Name your destination and enter your **VWO Account ID**. Toggle **Enable Destination** on and click **Save Changes**. +- You'll find your VWO account ID at the top of the VWO dashboard. +6. Navigate to the **Mappings** tab and click **New Mapping**. Under **PRE-BUILT MAPPINGS**, select **Sync Audience**, then click **Save**. +7. The **STATUS** of the mapping displays as disabled by default. Enable the mapping using the toggle. +8. Navigate to **Engage > Audiences**. Choose an existing Engage audience or create a new one to export to VWO. +9. Click **Add Destination** and select the VWO Cloud Mode destination you created. From the **Connection Settings** screen, toggle the Send Track option on. Be sure you don't change the **Audience Entered/Audience Exited** event names. Click **Save**. + +> success "" +> After you set up your destination, you can repeat steps eight and nine to sync any subsequent audiences. + +Visit [Using Data From Segment](https://help.vwo.com/hc/en-us/articles/16147461611161){:target="_blank"} for more on how to configure audiences in VWO. + +## Supported Segment Calls in VWO + +VWO Supports the following calls, as specified in the [Segment Spec](/docs/connections/spec/). + +### Track +The [Track](/docs/connections/spec/track/) call records any actions your visitors perform, along with any properties that describe the action. Each action is known as an event. + +The destination forwards these events to VWO Data360 where they can be seen under the **UNREGISTERED EVENTS** section in **Data360 > Events** in VWO. These events can be registered and used as [Metrics](https://help.vwo.com/hc/en-us/articles/8675547113625-Working-with-Metrics-in-VWO){:target="_blank"} in VWO. + +**Sample payload for Track Call to the destination** + +```js +analytics.track("Segment Test Event", { + "vwo_uuid": "
**Note:** The destination displays an error if the provided value includes any characters other than [a-zA-Z0-9] and “_” (underscore). This is to prevent passing values not supported by Yahoo. + Customer Description | Provide an optional description for the integration. +5. Turn on the **Enable Destination** toggle. +6. Click **Save Changes** to save the destination. +7. Configure destination Action Mappings. Action Mappings determine the information sent from Engage to the Yahoo Audiences destination. + 1. On the **Mapping** tab click **Add Mapping** and select **Sync to Yahoo Ads Segment**. + 2. Within the mapping’s **Select events to map and send** configure whether the mapping should be triggered for all audiences connected to the destination, or for specific audiences only. + - **Note:** Action mapping settings apply to all audiences that are processed by the mapping. The mapping can be configured to process all audiences connected to the destination, or only specific audiences. This can be helpful when enabling the GDPR flag only for specific audiences. + - To apply the mapping only to specific audiences, modify the trigger as follows: +  + - To apply the mapping to all audiences, modify the trigger as follows: +  + 3. Configure the mapping for **Email**, **Phone**, **Mobile Advertising Id** and **Device Type** fields. You can keep default mapping for these fields, if your data matches default mappings. + - **Note:** The destination expects the mobile advertising ID to be a combination of 2 fields: advertising ID and device type. If device type field is not available in your data, the destination deduces the platform (iOS /Android) based on advertising ID value formatting. If the value is capitalized - the destination assumes that this is iOS IDFA, otherwise the destination assumes that is Android DSP ID. + 4. Configure whether **GDPR Flag** should be sent. + - **Note:** **GDPR Flag** setting applies to the entire audience. Set this setting to TRUE if the audience is subject to GDPR regulations. If you set the **GDPR Flag** to YES, then populate **GDPR Consent Attributes** setting with the following IAB user consent attributes: “Access of Information” and “Personalization”. See more in [Yahoo DSP API documentation](https://developer.yahooinc.com/datax/guide/gdpr/faq/){:target="_blank"}. If the **GDPR Flag** setting is set to YES, and **GDPR Consent Attributes** is not populated, the audience sync fails. + 5. Provide **GDPR Consent Attributes** if you opted to send a **GDPR Flag**. + 6. Save the mapping. +8. Connect the Destination to the Audience and configure the Audience Sync settings. + 1. Navigate to **Engage** > **Audiences** > **(your audience)**. Click **Add Destination** and select the destination you just created. + 2. Configure how the audience should be synced. Enable **Send Track** and disable **Send Identify**. + 3. Select the identifiers to be synced to Yahoo: + - **Default Setup**: Sends all email IDs available on a user profile. + - **Customized Setup**: Configure the identifiers to be sent to Yahoo DSP. + 4. If you’d like to send iOS IDFA and Android Advertising ID - turn on **Send Mobile IDs** and map MAIDs using **Customized Setup**. + 5. Don't modify the **Placeholder** setting. + 6. Click **Save Settings**. + +> info "" +> Yahoo DSP supports the following identifiers: **email**, **phone**, **iOS IDFA**, **Android Advertising Id**. Segment hashes email and phone per Yahoo DSP requirements, so you don’t have to hash email and phone. Segment formats the phone to meet E.164 requirements: removes non-digit characters and adds “+” sign. Your phone trait/identifier must include country code, as Segment does not prepend phone with country code. + +Once the Audience is connected to the Destination, Segment makes a request to Yahoo DSP to create an ‘audience’ (‘segment’) node in Yahoo Data Taxonomy. The node is identified by Audience ID, and named with Audience Key. After Engage has computed the audience, the Destination syncs the audience to Yahoo DSP. + +{% include components/actions-fields.html %} + +## Destination configurations for various use cases + +### Use case 1 + +Email, phone, IOS IDFA and Android Advertising ID are available as Engage Identifiers. + +Setting | Details +------- | -------- +Action Mappings | Keep default field mappings. +Audience Sync settings | Select **Customized Setup**, and map available identifiers under the Identifiers section. You can select whether Engage should send First, Last, or All Available identifiers. + +### Use case 2 + +Email, phone, IOS IDFA and Android Advertising Id are available as Engage Identifiers and/or Traits. + +Settings | Details +-------- | -------- +Action Mappings | Modify the mapping to reflect your custom trait names. For example, if you’re planning to send `email_addr` trait as email to Yahoo Audiences, map `email_addr` trait in the **User Email** field. +Audience Sync settings | Click **Customized Setup** and select the **Identifiers** and **Traits** that you plan to send to Yahoo Audiences. For example, if you plan to send `phone` identifier and `email_addr` trait, map these fields as shown below:  + +### Use case 3 +Send mobile advertising ID custom traits to Yahoo Audiences. + +Settings | Details +-------- | -------- +Action Mappings | The destination expects 2 fields for mobile advertising ID: 1) advertising ID field (trait) storing the ID value iteself, and 2) device type field (trait) storing mobile platform name (`ios` or `android`).
* If your Engage data includes these 2 fields, you can map them as: `traits.advertising_id_trait` → `User Mobile Advertising ID` and `traits.device_type_trait` → `User Mobile Device Type`.
* If your data doesn't include a field with the device type, you can only map the advertising ID trait. The destination detects device type based on the ID value format. Apple IDFA is typically capitalized, and Android advertising ID is typically lowercase.
* If you have separate traits for iOS IDFA and Android Advertising ID, you can map them using the coalesce() function: `coalesce( traits.ios_ad_id_trait`, `traits.android_ad_id_trait)` → `User Mobile Advertising ID` +Audience Sync settings | Use **Customized Setup** to map custom advertising ID and, if available, device type traits.  + + +## FAQs + +### Why am I seeing the difference between audience size in Engage and in Yahoo DSP? +The difference between audience size in Segment and in Yahoo DSP is expected due to ID matching. Yahoo DSP will recognize only users it has matching ID (email / phone / MAID) for. + +### The audience has synced, but I’m seeing 0 population in Yahoo DSP UI. +As soon as user records land in Yahoo DSP, users become targetable in minutes. However, Yahoo DSP reporting is not realtime, and might take 24-48 hours to catch up. This delay does not affect targeting. Because of that you might see 0 users in the Yahoo DSP audience immediately after the sync. diff --git a/src/connections/destinations/catalog/activecampaign/index.md b/src/connections/destinations/catalog/activecampaign/index.md index 940e5ed0ca..06cfb1cced 100644 --- a/src/connections/destinations/catalog/activecampaign/index.md +++ b/src/connections/destinations/catalog/activecampaign/index.md @@ -3,13 +3,13 @@ rewrite: true title: ActiveCampaign Destination id: 55d66bb5ebe537b09c977fa3 --- -[ActiveCampaign](https://www.activecampaign.com) is an integrated email marketing, marketing automation, and small business CRM. It allows you to send beautiful newsletters, set up behavioral based automations, and benefit from sales automation. +[ActiveCampaign](https://www.activecampaign.com){:target="_blank”} is an integrated email marketing, marketing automation, and small business CRM. It allows you to send beautiful newsletters, set up behavioral based automations, and benefit from sales automation. -This destination is maintained by ActiveCampaign. For any issues with the destination, [contact the ActiveCampaign support team](https://www.activecampaign.com/contact/). +This destination is maintained by ActiveCampaign. For any issues with the destination, [contact the ActiveCampaign support team](https://www.activecampaign.com/contact/){:target="_blank”}. ## Getting Started -{% include content/connection-modes.md %} + 1. From your Segment UI's Destinations page click on "Add Destination". 2. Search for "Active Campaign" in the Catalog, select it, and choose which of your sources to connect the destination to. diff --git a/src/connections/destinations/catalog/adikteev/index.md b/src/connections/destinations/catalog/adikteev/index.md index 048a67bcfb..065af29ecd 100644 --- a/src/connections/destinations/catalog/adikteev/index.md +++ b/src/connections/destinations/catalog/adikteev/index.md @@ -5,12 +5,10 @@ id: 5c75564f1d2f34000116ef78 --- This destination is maintained by Adikteev. For any issues with the destination, [contact the Adikteev support team](mailto:contact@adikteev.com). -{% include content/beta-note.md %} - ## Getting Started -{% include content/connection-modes.md %} + Currently, this destination supports events originating from Mobile sources alone. diff --git a/src/connections/destinations/catalog/adjust/index.md b/src/connections/destinations/catalog/adjust/index.md index 5825aebee8..f01340d82f 100644 --- a/src/connections/destinations/catalog/adjust/index.md +++ b/src/connections/destinations/catalog/adjust/index.md @@ -5,12 +5,12 @@ id: 56f6ce7280412f644ff12fb2 --- [Adjust](https://adjust.com){:target="_blank"} is the mobile attribution provider of choice for hundreds of organizations across the globe. They unify all your marketing activities into one powerful platform, giving you the insights you need to scale your business. The Adjust Destination is open-source. You can browse the code on GitHub for [iOS](https://github.com/segment-integrations/analytics-ios-integration-adjust){:target="_blank"} and [Android](https://github.com/segment-integrations/analytics-android-integration-adjust){:target="_blank"}. -If you notice any gaps, out-dated information, or want to leave feedback to help improve Segment's documentation, [let us know](https://segment.com/help/contact). +If you notice any gaps, out-dated information, or want to leave feedback to help improve Segment's documentation, [let us know](https://segment.com/help/contact){:target="_blank”}. ## Getting started -{% include content/connection-modes.md %} + 1. From the Segment web app, click **Catalog**. 2. Search for "Adjust" in the Catalog, select it, and choose which of your sources to connect the destination to. @@ -109,10 +109,6 @@ analytics = new Analytics.Builder(this, "write_key") After you build and release to the App Store, Segment automatically starts translating and sending your data to Adjust. -### React Native - -{% include content/react-dest.md %} - ### Server The Cloud-mode integration allows you to send *supplemental* data to Adjust. This *does not* include attribution events. If you rely on the Adjust server-side component, and do not bundle the Segment-Adjust SDK, your installs will not be attributed. E-commerce events and other general `track` events are supported out of the box. You **must** map your `track` events to your custom Adjust Event Token in your [Adjust destination settings](#map-your-events-to-custom-adjust-event-tokens). @@ -237,7 +233,7 @@ If you're using Adjust's iOS SDK, it will automatically takes care of duplicate ### In-app purchase receipts -The destination does not currently support in-app purchase receipts. If this is important to you, [reach out to support](https://segment.com/help/contact/). +The destination does not currently support in-app purchase receipts. If this is important to you, [reach out to support](https://segment.com/help/contact/){:target="_blank”}. ### Push notifications diff --git a/src/connections/destinations/catalog/adobe-analytics/best-practices.md b/src/connections/destinations/catalog/adobe-analytics/best-practices.md index 7285a3df48..138082951b 100644 --- a/src/connections/destinations/catalog/adobe-analytics/best-practices.md +++ b/src/connections/destinations/catalog/adobe-analytics/best-practices.md @@ -9,7 +9,7 @@ This page contains best practices and tips for setting up and testing Adobe Anal The following list contains tools you can use to validate data coming from Segment and going to each different Adobe Analytics component -- **Analytics.js** - [Adobe Experience Cloud Debugger](https://chrome.google.com/webstore/detail/adobe-experience-cloud-de/ocdmogmohccmeicdhlhhgepeaijenapj) and Chrome Developer Tools +- **Analytics.js** - [Adobe Experience Cloud Debugger](https://chromewebstore.google.com/detail/adobe-experience-platform/bfnnokhpnncpkdmbokanobigaccjkpob){:target="_blank”} and Chrome Developer Tools - **Other Segment server libraries** - Segment's in-app [Event Tester Tool](/docs/connections/test-connections/) - **iOS Device mode** - Charles Proxy, DEBUG mode - **Android Device Mode** - Charles Proxy, VERBOSE logging @@ -48,7 +48,7 @@ If you are setting up the Adobe Analytics destination in cloud-mode, you can pas **Note**: If you pass in the `visitorId` in a destination-specific `integration` object in your Segment Page or Track events, the `visitorId` passed persists on Page or Track calls that occur after an Identify call. This effectively supersedes the `visitorId` variable Segment would set to your `userId` after an Identify call. -We know this is daunting territory, so don't hesitate to [contact us directly for guidance](https://segment.com/help/contact/)! +We know this is daunting territory, so don't hesitate to [contact us directly for guidance](https://segment.com/help/contact/){:target="_blank”}. ### Setting the event linkType diff --git a/src/connections/destinations/catalog/adobe-analytics/heartbeat.md b/src/connections/destinations/catalog/adobe-analytics/heartbeat.md index 107168e53e..601b49848a 100644 --- a/src/connections/destinations/catalog/adobe-analytics/heartbeat.md +++ b/src/connections/destinations/catalog/adobe-analytics/heartbeat.md @@ -3,7 +3,7 @@ title: Setting up Adobe Analytics Heartbeat strat: adobe --- -Adobe Heartbeat is an Adobe Analytics add-on that allows you to collect video analytics data from [mobile applications, and JavaScript or website sources](https://marketing.adobe.com/resources/help/en_US/sc/appmeasurement/hbvideo/). +Adobe Heartbeat is an Adobe Analytics add-on that allows you to collect video analytics data from [mobile applications, and JavaScript or website sources](https://marketing.adobe.com/resources/help/en_US/sc/appmeasurement/hbvideo/){:target="_blank”}. > info "" > At this time, Adobe Heartbeat is only available for events sent using [device mode](/docs/connections/destinations/#connection-modes). @@ -24,9 +24,9 @@ Next, enable Adobe's VisitorID service in your Adobe account. You must do this t For Android: -1. If you haven't done so already, go to the Adobe Mobile Services UI and follow [these steps](https://docs.adobe.com/content/help/en/mobile-services/android/getting-started-android/requirements.html#section_044C17DF82BC4FD8A3E409C456CE9A46) to download the core `adobeMobileLibrary` and configure in your Android project. Add the `ABDMobileConfig.json` to your project from the downloaded SDK. -2. Download the latest version of the `MediaSDK.jar` file and [include it in your Android project using Adobe's documentation steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html). -3. Follow the [remaining set up steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html) to complete the installation. +1. If you haven't done so already, go to the Adobe Mobile Services UI and follow [these steps](https://docs.adobe.com/content/help/en/mobile-services/android/getting-started-android/requirements.html#section_044C17DF82BC4FD8A3E409C456CE9A46){:target="_blank”} to download the core `adobeMobileLibrary` and configure in your Android project. Add the `ABDMobileConfig.json` to your project from the downloaded SDK. +2. Download the latest version of the `MediaSDK.jar` file and [include it in your Android project using Adobe's documentation steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html){:target="_blank”}. +3. Follow the [remaining set up steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html){:target="_blank”} to complete the installation. For iOS: The Adobe Heartbeat SDK is already included with the Segment-Adobe-Analytics SDK when you add a Heartbeat Tracking Server URL. Ensure you have added the `ABDMobileConfig.json` for your iOS project from the Adobe Mobile Services UI. @@ -174,7 +174,7 @@ Adobe Analytics supports many - but not all - of the [Segment Video Spec events]
| `id` optional | -String | -The user Id to associate tags with. If this is not specified, the destination will simply use the userId from the event itself. | -|
| `action` required | -String | -Must be either 'add' or 'remove'. Indicates whether you would like to add or remove the tags for the given user. | -|
| `values` required | -Array | -An array of strings representing the tags to either add or remove. | - |