diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index a6731c764f..65fa36b340 100644 --- a/src/_data/catalog/destination_categories.yml +++ b/src/_data/catalog/destination_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination categories last updated 2025-05-02 +# destination categories last updated 2025-05-08 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index 8b68908ada..55657d2fb1 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination data last updated 2025-05-02 +# destination data last updated 2025-05-08 items: - id: 637e8d185e2dec264895ea89 display_name: 1Flow diff --git a/src/_data/catalog/destinations_private.yml b/src/_data/catalog/destinations_private.yml index 4a08c84441..a930152ec4 100644 --- a/src/_data/catalog/destinations_private.yml +++ b/src/_data/catalog/destinations_private.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination data last updated 2025-05-02 +# destination data last updated 2025-05-08 items: - id: 54521fd925e721e32a72eee1 display_name: Pardot diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index e133a992c2..4f4fee434d 100644 --- a/src/_data/catalog/source_categories.yml +++ b/src/_data/catalog/source_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# source categories last updated 2025-05-02 +# source categories last updated 2025-05-08 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index ac22ab9638..19ac91cd50 100644 --- a/src/_data/catalog/sources.yml +++ b/src/_data/catalog/sources.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# sources last updated 2025-05-02 +# sources last updated 2025-05-08 items: - id: 8HWbgPTt3k display_name: .NET diff --git a/src/connections/alerting.md b/src/connections/alerting.md index 690fe781ec..09f74d8a70 100644 --- a/src/connections/alerting.md +++ b/src/connections/alerting.md @@ -24,7 +24,7 @@ To create a source volume 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. + - **Slack**: Select this to send alerts to one or more channels in your workspace. You can post messages to your channel with either a [webhook](https://api.slack.com/messaging/webhooks){:target="_blank”} or a [workflow](https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack){:target="_blank”}. - **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**. @@ -46,7 +46,7 @@ To create a successful delivery rate 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. + - **Slack**: Select this to send alerts to one or more channels in your workspace. You can post messages to your channel with either a [webhook](https://api.slack.com/messaging/webhooks){:target="_blank”} or a [workflow](https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack){:target="_blank”}. - **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**. diff --git a/src/connections/destinations/catalog/actions-reddit-audiences/index.md b/src/connections/destinations/catalog/actions-reddit-audiences/index.md new file mode 100644 index 0000000000..ae12980367 --- /dev/null +++ b/src/connections/destinations/catalog/actions-reddit-audiences/index.md @@ -0,0 +1,30 @@ +--- +title: Reddit Audiences +id: 66f2b0f961bb2128729079bb +--- + +{% include content/plan-grid.md name="actions" %} + +The Reddit Audiences destination allows advertisers to send Engage audiences from Segment to Reddit to use as [Custom Audiences](https://business.reddithelp.com/s/article/custom-audiences?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"}, which can be used for Reddit Ads features like audience targeting, retargeting, creating lookalike audiences, and engagement retargeting. + +This destination is maintained by Reddit. For any issues with the destination, [contact their Support team](mailto:adsapi-partner-support@reddit.com). + +### Reddit Requirements +* Create a Reddit Ads account. * Find your ad account ID in [Accounts](https://ads.reddit.com/accounts). + +### Connect Reddit Ads to your workspace + +## Getting started + +1. In your Segment workspace, click **Engage** in the left navigation bar, then select your space. +2. Click **Engage Settings** and select the **Destinations** tab. +3. Search for `Reddit Audiences`. +4. Click **Add Destination**. +5. Confirm the source. By default, this is the source connected to the space to which you’re adding the destination. +6. In the **Settings** tab, click **Connect to Reddit Audiences** and authenticate the connection between Segment and Reddit. +7. Provide your ad account ID for **Ad Account ID**. +8. Toggle **Enable Destination** on and click **Save Changes**. +9. Navigate to the engage space that contains the audience, and select it in the **Audiences** tab. +10. Click **Add Destination**. + +{% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-reddit-conversions-api/index.md b/src/connections/destinations/catalog/actions-reddit-conversions-api/index.md index 374767b294..0d3af5d7b1 100644 --- a/src/connections/destinations/catalog/actions-reddit-conversions-api/index.md +++ b/src/connections/destinations/catalog/actions-reddit-conversions-api/index.md @@ -5,7 +5,7 @@ id: 66cc766ef4b1c152177239a0 {% include content/plan-grid.md name="actions" %} -The [Reddit Conversions API](https://business.reddithelp.com/helpcenter/s/article/Conversions-API/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} allows advertisers to send conversion events from Segment directly to Reddit, without needing website code. By building a sustainable server-side connection more resilient to signal loss, you can gain stronger campaign performance with improved measurement, targeting, and optimization. +The [Reddit Conversions API](https://ads-api.reddit.com/docs/v2/#tag/Conversions-API){:target="_blank"} allows advertisers to send conversion events from Segment directly to Reddit, without needing website code. By building a sustainable server-side connection more resilient to signal loss, you can gain stronger campaign performance with improved measurement, targeting, and optimization. ### Benefits of Reddit Conversions API diff --git a/src/connections/destinations/catalog/trubrics/index.md b/src/connections/destinations/catalog/trubrics/index.md new file mode 100644 index 0000000000..34aa98c72e --- /dev/null +++ b/src/connections/destinations/catalog/trubrics/index.md @@ -0,0 +1,26 @@ +--- +title: Trubrics (Actions) Destination +id: 664ce847b3e6f19ea96b3611 +private: true +hidden: true +--- + +{% include content/plan-grid.md name="actions" %} + +[Trubrics](https://trubrics.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} provides self-serve product analytics for AI product teams. On top of regular product analytics to understand user behavior, Trubrics helps you understand how your AI is performing and how to improve it. + +This destination is maintained by Trubrics. For any issues with the destination, [contact their Support team](mailto:jeff.kayne@trubrics.com). + +## Getting started + +1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”}, search for "Trubrics". +2. Select Trubrics and click **Add Destination**. +3. Select an existing source to connect to Trubrics (Actions). +4. Go to the [Trubrics app](https://app.trubrics.com){:target="_blank"}, and copy the **Project API key** from the settings page. +5. Enter the **Project API Key** in the Trubrics destination settings in Segment, then enable the destination. +6. Add mappings for your AI/user properties. + - To learn more about adding mappings, see [Trubrics <> Segment Mapping Events](https://www.loom.com/share/3bc3a02cf38d47b4b865c50314dbc8fb){:target="_blank”}. + + + +{% include components/actions-fields.html %} \ No newline at end of file diff --git a/src/connections/reverse-etl/manage-retl.md b/src/connections/reverse-etl/manage-retl.md index e4dd195d2e..dbe3a0022d 100644 --- a/src/connections/reverse-etl/manage-retl.md +++ b/src/connections/reverse-etl/manage-retl.md @@ -84,7 +84,7 @@ To subscribe to alerts for a failed or partially successful sync: - **Reverse ETL sync partial success**: Receive a notification when your Reverse ETL sync is partially successful. 4. Select one or more of the following alert options: - **Enable email notifications**: Enter an email address or alias that should receive alerts. - - **Enable Slack notifications**: Enter a webhook URL and Slack channel name. + - **Enable Slack notifications**: Enter a webhook URL and Slack channel name. You can post messages to your channel with either a [webhook](https://api.slack.com/messaging/webhooks){:target="_blank”} or a [workflow](https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack){:target="_blank”}. - **Enable in-app notifications**: Select this option to see an in-app notification. 5. Click **Create alert**. @@ -124,7 +124,7 @@ To subscribe to alerts for successful delivery fluctuations at the mapping level 3. Set an *alert threshold*, or the percentage of successfully delivered events that would prompt an alert. 4. Select one or more of the following notification channels: - **Email**: Enter an email address or alias that should receive alerts. - - **Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel. + - **Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel. You can post messages to your channel with either a [webhook](https://api.slack.com/messaging/webhooks){:target="_blank”} or a [workflow](https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack){:target="_blank”}. - **In-app notifications**: 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. Toggle the **Enable alert** setting on and click **Create**. diff --git a/src/connections/sources/catalog/cloud-apps/qualtrics/index.md b/src/connections/sources/catalog/cloud-apps/qualtrics/index.md index 69938aa5ad..1d1979b6ea 100644 --- a/src/connections/sources/catalog/cloud-apps/qualtrics/index.md +++ b/src/connections/sources/catalog/cloud-apps/qualtrics/index.md @@ -8,24 +8,24 @@ This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can no Qualtrics maintains this source. For any issues with the source, [contact the Qualtrics Support team](mailto:support@qualtrics.com). -> info "Beta Source" -> The Qualtrics Source is in beta, which means that they are still actively developing the source. This doc was last updated on February 15, 2023. If you are interested in joining their beta program or have any feedback to help improve the Qualtrics Source and its documentation, [let the Qualtrics team know](mailto:support@qualtrics.com)!_ +> info "Beta source" +> The Qualtrics Source is in beta, which means that they are still actively developing the source. This doc was last updated on February 15, 2023. If you are interested in joining their beta program or have any feedback to help improve the Qualtrics source and its documentation, [let the Qualtrics team know](mailto:support@qualtrics.com). ## Getting started 1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**. 2. Search for "Qualtrics" in the Sources Catalog, select Qualtrics, and click **Add Source**. -3. On the next screen, give the Source a nickname configure any other settings. +3. On the next screen, give the source a nickname configure any other settings. - The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but Segment recommends using something that reflects the source itself and distinguishes amongst your environments (for example, SourceName_Prod, SourceName_Staging, or SourceName_Dev). 4. Click **Add Source** to save your settings. -5. Log in to your Qualtrics Account. Navigate to workflows, select a workflow to send Segment events from, and add a new Segment task. +5. Log in to your Qualtrics Account. Navigate to Workflows, select a workflow to send Segment events from, and add a new Segment task. 6. From within the Segment task, after connecting with your Segment workspace API token, select your Qualtrics source and continue to set up the task with the event, data mapping, and more. - Your workspace token will need Source Admin permissions, at a minimum. 7. For more information on the Qualtrics Segment task, view the [Qualtrics support page](https://www.qualtrics.com/support/integrations/twilio-segment/twilio-segment-task/){:target="_blank"}. ## Stream -Qualtrics uses Segment's stream Source component to send Segment event data. It uses a server-side (select from `track` and `identify`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events and are available in a schema in your data warehouse, so you can query using SQL. +Qualtrics uses Segment's stream source component to send Segment event data. It uses a server-side (select from `track` and `identify`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events and are available in a schema in your data warehouse, so you can query using SQL. Qualtrics allows you to configure the userId from various sources from within the Qualtrics platform, for example, data from a survey response or a XM Directory contact's external data reference. The anonymous ID can also be configured from within Qualtrics task setup. @@ -33,18 +33,18 @@ Qualtrics allows you to configure the userId from various sources from within th Use the Qualtrics integration to define the event to be sent to Segment from within the task. This can be customized for a particular use case such as 'Onboarding Survey Completed' which could be the event based on a response to a particular survey. Another example may be 'Contact Updated' based on XM Directory change. These events can be tailored to align with your existing process or particular use case. -## Event Properties +## Event properties The Qualtrics integration allows you to define event properties within the following constraints: - Use `Track` events to define the `properties` object - Use `Identify` events to define the `traits` object -## Adding Destinations +## Adding destinations -Now that your Source is set up, you can connect it with Destinations. +Now that your source is set up, you can connect it with destinations. -Log into your downstream tools and verify that events and properties appear the way you expect. If events and properties don’t appear as you expect them to, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting. +Log into your downstream tools and verify that events and properties appear the way you expect. If events and properties don’t appear as you expect them to, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the destination docs for each tool for troubleshooting. If there are any issues with how the events are arriving to Segment, [contact the Qualtrics support team](mailto:support@Qualtrics.com). diff --git a/src/engage/audiences/index.md b/src/engage/audiences/index.md index a52c924ba3..3f104f92f6 100644 --- a/src/engage/audiences/index.md +++ b/src/engage/audiences/index.md @@ -288,7 +288,7 @@ To create an Activation event health spikes or drops alert: 4. Enter a percentage threshold to trigger activation event health notifications. 5. 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. + - **Slack**: Select this to send alerts to one or more channels in your workspace. You can post messages to your channel with either a [webhook](https://api.slack.com/messaging/webhooks){:target="_blank”} or a [workflow](https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack){:target="_blank”}. - **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. 6. Click **Save**. diff --git a/src/getting-started/01-what-is-segment.md b/src/getting-started/01-what-is-segment.md index b791d80ec6..4078c74a4a 100644 --- a/src/getting-started/01-what-is-segment.md +++ b/src/getting-started/01-what-is-segment.md @@ -12,8 +12,8 @@ In a nutshell, the Segment libraries ([Sources](/docs/connections/sources/catalo [Segment Spec methods](/docs/connections/spec/) are how you collect interaction data from your interfaces, and the [Sources](/docs/connections/sources/) are what you package with your interfaces to collect and route the data. Once you've collected your interaction data, there are several different actions you can take: -- Send it to [Destinations](/docs/connections/destinations/), which receive the data from any number of sources in real time -- Send it to [Warehouses](/docs/connections/storage/) and other bulk storage tools, which hold your raw event schemas and update on regular intervals +- Send it to [Destinations](/docs/connections/destinations/), which receive the data from any number of sources in real time. +- Send it to [Warehouses](/docs/connections/storage/) and other bulk storage tools, which hold your raw event schemas and update on regular intervals. - Enrich the customer data you collect by [connecting data from your other tools](/docs/connections/sources/catalog/#cloud-apps), and then collect it in a warehouse to monitor performance, inform decision-making processes, and create uniquely customized user experiences. - Use [Engage](/docs/engage/), Twilio's marketing automation tool, to build marketing campaigns personalized to your audience. @@ -53,7 +53,7 @@ Although there are some tradeoffs between the two approaches, neither is better TODO: Image removed, didn't work with formatting. need a better version of this flowchart or else to just omit?--> -## The Segment Methods +## The Segment methods The Segment libraries generate messages about what happens on your interface, translate those messages into different formats for use by destinations, and transmit the messages to those tools. diff --git a/src/getting-started/03-planning-full-install.md b/src/getting-started/03-planning-full-install.md index 5599e9fd40..1c04a2576e 100644 --- a/src/getting-started/03-planning-full-install.md +++ b/src/getting-started/03-planning-full-install.md @@ -24,20 +24,20 @@ Now that you've seen Segment in action, step back and think through what a full Be prepared to invest time deciding with stakeholders how to track your data, and planning how you'll analyze it. The time you spend here will save you lots of time in the future, as following Segment's best practices allows you to easily change your tracking later. -## Define Business Objectives +## Define business objectives Tracking is about learning and taking action. Think about what you want to know about your product or customers. Think about what assumptions need to be tested and what theories need to be proven true or false. Think about the unknowns. Here are some helpful questions to get started: -- What kind of events or data best illustrate or explain how your customers use your product? +- What kinds of events or data best illustrate or explain how your customers use your product? - How do people discover, start using, and paying for your product? - What are the most important steps in a customer's journey? -While it may seem obvious, we highly recommend documenting your high-level business objectives. More specifically, ask yourself: what are the measurable business outcomes you want to achieve this year? Do you want to acquire new customers? Generate more new sign-ups, drive more incremental revenue among your current customer base? +While it may seem obvious, we highly recommend documenting your high-level business objectives. More specifically, ask yourself: what are the measurable business outcomes you want to achieve this year? Do you want to acquire new customers? Generate more new sign-ups? Drive more incremental revenue among your current customer base? -The best way to answer this question is to interview stakeholders in your organization who will consume the data. +The best way to answer these questions is to interview stakeholders in your organization who will consume the data. With your business goals documented, the next step is to map user actions to those business goals. For example, if one of your goals is to activate new signups, you want to think about which activities are related to a signup. Ask yourself, what actions do people take _before_ signing up? Do specific actions predict a user signing up? @@ -55,7 +55,7 @@ While this list represents a tiny fraction of the user actions you _could_ track ## Decide what to collect -With your business objectives documented and mapped to user actions, it's time to build standards that you can use when deciding what to track. With your stakeholders, make a list of the actual events (page or screen views, and user actions) that you want to track. Think about all of the ways your users can interact with your site or app +With your business objectives documented and mapped to user actions, it's time to build standards that you can use when deciding what to track. With your stakeholders, make a list of the actual events (page or screen views, and user actions) that you want to track. Think about all of the ways your users can interact with your site or app. When you're first starting out, we recommend that you limit your tracking plan to a few core events, but add lots of properties to provide context about them. We generally see more success with the “less is more” philosophy of tracking data, but you might also decide to take a more liberal “track more and analyze later” approach. Like everything, each alternative has pros and cons that are important to consider especially as it relates to your company's needs. @@ -95,7 +95,7 @@ Regardless of approach, here are some important best practices to keep in mind: - **Don't create events to track properties:** Avoid adding values to event names when they could be a property. Instead, add values as a property. For example, rather than having an event called "Read Blog Post - Best Tracking Plans Ever", create a "Blog Post Read" event and with a property like `"blog_post_title":"Best Tracking Plans Ever"`. -- **Don't create property keys dynamically:** Avoid creating property names like `"feature_1":"true"`,`"feature_2":"false"` as these are ambiguous and very difficult to analyze +- **Don't create property keys dynamically:** Avoid creating property names like `"feature_1":"true"`,`"feature_2":"false"` as these are ambiguous and very difficult to analyze. ![An image comparing good and bad naming and collection standards](/docs/protocols/images/asset_nVdJ3ZyA.png) @@ -141,11 +141,11 @@ At Segment, we started out tracking these events: - **Source Data Sent** - **Subscription Started** -Then we added some peripheral events to to better understand how we're performing, for the following reasons: +Then we added some peripheral events to better understand how we're performing, for the following reasons: - **User Invited** When users invite more people to their organization, it's a good indicator that they're engaged and serious about using the product. This helps us measure growth in organizations. - **Destination Enabled** Turning on a destination is a key value driver for our customers. -- **Debugger Call Expanded** When we see that a certain customer has used the live event stream feature a number of times, we can contact see if we can help them debug. +- **Debugger Call Expanded** When we see that a customer has used the live event stream feature multiple times, we can contact them to see if we can help them debug. For an Ecommerce company, however, the main events might be something like: diff --git a/src/getting-started/whats-next.md b/src/getting-started/whats-next.md index 1a421246fe..9dab9da2e3 100644 --- a/src/getting-started/whats-next.md +++ b/src/getting-started/whats-next.md @@ -38,7 +38,7 @@ With Engage, you can create unified customer profiles, enrich those profiles wit ##### Recipes -Need ideas or prior art? [Segment Recipes](https://segment.com/recipes/?utm=docs) are some cool things you can do by hooking your Segment workspace up to different Destination tools. Everything from sending tailored onboarding emails, to joining and cleaning your data with third party tools +Need ideas or prior art? [Segment Recipes](https://segment.com/recipes/?utm=docs) are some cool things you can do by hooking your Segment workspace up to different Destination tools. Everything from sending tailored onboarding emails, to joining and cleaning your data with third party tools. ### Other Resources diff --git a/src/monitor/alerts/default-alerts.md b/src/monitor/alerts/default-alerts.md index 717c7ec1ea..361f329271 100644 --- a/src/monitor/alerts/default-alerts.md +++ b/src/monitor/alerts/default-alerts.md @@ -16,15 +16,16 @@ You can create alerts for the following product areas: - [Protocols](#protocols-alerts) - [Unify](#unify-alerts) - [Engage](#engage-alerts) +- [Users](#users-alerts) - [Functions](#functions-alerts) - [Reverse ETL](#reverse-etl-alerts) - [Data Graph](#data-graph-alerts) The Alerting table includes the following information about each event: - **Alert name**: The type of alert, for example, "Audience created" or "Audience deleted". -- **Last triggered**: The most recent date and time, in your local time zone, that the alert was triggered. +- **Last triggered**: The most recent date and time, in your local time zone, that the alert was triggered. Some alerts, like **Violations Detected**, trigger only once per day. - **Status**: Either **enabled**, if the alert is currently configured in your workspace, or **disabled**, if you're not configured to receive alerts for an event. -- **Notification channels**: Icons describing what notification channels you'll receive the alerts on - through a Slack webhook, email, or in-app notification. +- **Notification channels**: Icons describing what notification channels you'll receive the alerts on - through a Slack webhook, Slack workflow, email, or in-app notification. - **Actions**: By selecting the menu icon for an individual alert, you can edit or delete it from the Alerting page. ## Create a new alert @@ -116,6 +117,11 @@ your identity-resolved profiles to your data warehouse. > info "Custom Engage alerts" > During the Monitor public beta, you can configure custom [Activation event health spikes or drops](/docs/engage/audiences/#activation-event-health-spikes-or-drops) alerts, but these alerts won't appear in the Monitor tab. +## Users alerts +- **Access Request Created**: A user in your workspace requested access to a resource that they don't currently have permission to view. For more information, see the [Request Access](/docs/segment-app/iam/membership/#request-access) documentation. +- **Public API Tokens Without Owners Detected**: Segment detected that the user that created one of your Public API tokens is no longer in your workspace. Workspace Owners receive the alert on the day that Segment detects the token's owner is no longer in the workspace and then again 30 days after the last alert. +- **Users Invited**: Someone [invited a new Team Member](/docs/segment-app/iam/membership/#invite-a-new-team-member) to your workspace. + ## Functions alerts - **Destination Filter Created**: A user in your workspace created a [destination filter](/docs/connections/destinations/destination-filters/). - **Destination Filter Deleted**: A user in your workspace deleted a [destination filter](/docs/connections/destinations/destination-filters/). diff --git a/src/unify/event-filtering.md b/src/unify/event-filtering.md new file mode 100644 index 0000000000..c4e8dc3088 --- /dev/null +++ b/src/unify/event-filtering.md @@ -0,0 +1,82 @@ +--- +title: Unify Event Filtering +plan: unify +--- + +Unify Event Filtering lets you control which events reach your Unify space. + +> info "Public Beta" +> Unify Event Filtering is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. + +## Overview + +With Unify Event Filtering, you can use block events that aren’t useful for [Identity Resolution](/docs/unify/identity-resolution/) or downstream activation, which keeps your space cleaner and more efficient. + +Event Filtering is useful when you’re sending a lot of different event types into Segment but only some of them are relevant to Unify. For example, you might want to: + +- Drop telemetry or system events that don’t describe user behavior +- Filter out events from certain regions or user groups +- Keep events in Connections, but exclude them from Unify + +Unify Event Filtering works differently from [Destination Filters](/docs/connections/destinations/destination-filters/) in a few important ways: + +| | Unify Event Filtering | Destination Filters | +| ---------------- | ---------------------------------------------------------------- | --------------------------------------- | +| Where it applies | Unify space | Individual destinations | +| Filter scope | All [sources](/docs/connections/sources/) connected to the space | One source for each destination | +| Filter action | Drops entire events | Can drop or modify events and fields | +| Setup | Created through API, visible in Unify UI | Created in UI or API | +| Timing | Before Identity Resolution | Before events get sent to a destination | + +This helps simplify your setup and reduce noise in profile data without needing repeaters, webhooks, or custom logic. + +## How filtering works + +Unify Event Filtering evaluates every incoming event before it enters your Unify space. If the event matches any of your filters, it gets dropped. + +Keep the following in mind as you work with Unify Event Filtering: + +- Filters are configured at the space level. You don’t create filters per source. Instead, one set of filters applies to all sources connected to the space. +- The filtering logic is based on [Filter Query Language](/docs/api/public-api/fql/). If you’ve used Destination Filters before, it works the same way. You can write expressions to match events based on type, name, traits, properties, or values. +- Matching is inclusive: if an event matches any filter, Segment drops it. +- Filtering happens **before** Identity Resolution: dropped events never reach the profile graph and won’t affect trait updates or [computed traits](/docs/unify/traits/computed-traits/). + +As a result, Unify Event Filtering helps you keep profile data clean from the start, without having to preprocess or transform events outside of Segment. + +## Creating and managing filters + +During public beta, you'll use the [Space Filter API](https://docs.segmentapis.com/tag/Space-Filters/){:target="_blank"} to create and manage all Unify event filters. The API lets you define filters using FQL, name them, enable or disable them, and delete them. Each Unify space can have up to 10 filters. Any event that matches 1 of those filters gets dropped before it reaches Unify. + +After you create a filter through the API, it shows up in your Segment workspace in **Unify > Unify settings > Filters**. From there, you can view existing filters, turn them on or off, rename them, or delete them. However, you can’t edit the filtering logic from within your workspace. If you want to edit filtering logic, you'll need to managed it through the API. + +The following table compares what you can do with Event Filtering with the API compared your Segment workspace: + +| Action | Where it happens | +| ------------------------- | ------------------- | +| Create a filter | API only | +| Define filter logic (FQL) | API only | +| Enable or disable filters | API or workspace | +| Rename a filter | API or workspace | +| Delete a filter | API or workspace | +| View filters | API or workspace | +| Edit filter logic | Replace in API only | + +> info "Updating filter logic" +> To update a filter’s logic, you’ll need to delete the existing filter through the Space Filter API and create a new one with the updated expression. + +## Best practices + +Unify Event Filtering is most useful when you want to keep noisy, irrelevant, or duplicate data out of your Unify space. The following table lists best practices to help you get the most value out of filtering: + +| Tip | Why it matters | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Filter early | Prevents irrelevant events from affecting profile data or identity resolution. | +| Drop obvious noise | Start with telemetry, test data, or internal events. | +| Keep it simple | A few targeted filters are easier to manage than multiple complex filters. | +| Think at the space level | Filters apply to all sources. Write conditions accordingly. | +| Test before enabling | Use the [preview endpoint](https://docs.segmentapis.com/tag/Destination-Filters#operation/previewDestinationFilter){:target="_blank"} to check filter behavior before turning it on. | + + +Unify Event Filtering gives you an early control point for managing the quality of data entering your space. It helps reduce noise, control costs, and improve the accuracy of profile data before any Identity Resolution takes place. + +To learn more about how Unify spaces work and how Segment processes events after filtering, see the [Unify documentation](/docs/unify/). \ No newline at end of file