Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
4ff9ce9
custom alerts to monitor tab
forstisabella Mar 28, 2025
806c982
[netlify-build]
forstisabella Mar 28, 2025
e47c6d2
[netlify-build]
forstisabella Mar 28, 2025
c2fe446
Create consent-in-engage.md
forstisabella Jun 17, 2025
e68a330
first pass
forstisabella Jul 11, 2025
8590319
editing pass
forstisabella Jul 14, 2025
c2f0bdb
Merge branch 'develop' into consent-in-engage
forstisabella Jul 14, 2025
df456b7
[netlify-build]
forstisabella Jul 14, 2025
d125bcf
add to sidebar [netlify-build]
forstisabella Jul 14, 2025
73f2168
fix [netlify-build]
forstisabella Jul 14, 2025
7cb55bb
Apply suggestions from code review
forstisabella Jul 15, 2025
cf19988
initial draft
forstisabella Jul 15, 2025
f510efb
addtl updates [netlify-build]
forstisabella Jul 16, 2025
d70e365
add unsupported destinations [netlify-build]
forstisabella Jul 16, 2025
2026da7
Apply suggestions from code review
forstisabella Jul 17, 2025
6865b18
Update src/privacy/consent-management/consent-in-engage.md
forstisabella Jul 18, 2025
aab2c6f
[netlify-build]
forstisabella Jul 18, 2025
976e5a1
Merge branch 'consent-in-engage' of https://github.com/segmentio/segm…
forstisabella Jul 18, 2025
89ad32e
[netlify-build]
forstisabella Jul 18, 2025
f6b54b9
reorganize content [netlify-build]
forstisabella Jul 18, 2025
6655487
content update [netlify-build]
forstisabella Jul 21, 2025
968dac2
addtl fixes [netlify-build]
forstisabella Jul 21, 2025
5aa78fb
Liveramp and TTD CRM destinations now supported
forstisabella Jul 29, 2025
208d43b
Merge pull request #7859 from segmentio/develop
pwseg Aug 28, 2025
2c9816d
Update src/privacy/consent-management/consent-in-engage.md
forstisabella Sep 2, 2025
ef063b6
Merge pull request #7763 from segmentio/consent-in-engage
forstisabella Sep 2, 2025
fc858ae
add screenshot standardize language
forstisabella Sep 2, 2025
841b9da
Merge pull request #7536 from segmentio/custom-alerts
forstisabella Sep 2, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/_data/sidenav/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -316,8 +316,6 @@ sections:
title: Event Delivery
- path: /connections/delivery-overview
title: Delivery Overview
- path: /connections/alerting
title: Connections Alerting
- path: /connections/find-writekey
title: Locate Your Write Key
- path: /connections/integration_error_codes
Expand Down Expand Up @@ -605,6 +603,8 @@ sections:
title: Consent Stored on the Profile
- path: /privacy/consent-management/consent-in-retl
title: Consent in Reverse ETL
- path: /privacy/consent-management/consent-in-engage
title: Consent in Engage Audiences
- path: /privacy/consent-management/consent-faq
title: Consent FAQs
- section_title: Deletion and Suppression
Expand Down Expand Up @@ -633,6 +633,8 @@ sections:
title: Alerts Overview
- path: /monitor/alerts/default-alerts
title: Default Alerts
- path: /monitor/alerts/custom-alerts
title: Custom Alerts
- section_title: Protocols
section:
- path: /protocols
Expand Down
3 changes: 3 additions & 0 deletions src/connections/alerting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Connections Alerting
beta: true
hidden: 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.
Expand Down Expand Up @@ -34,6 +35,8 @@ To delete a source volume alert, select the icon in the Actions column for the a

> 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.
Expand Down
100 changes: 100 additions & 0 deletions src/monitor/alerts/custom-alerts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
---
title: Custom Alerts
---

Segment's custom alerts allow you to customize the sensitivity of the trigger that activates an alert so you can more accurately detect event volume fluctuations in your integrations.

> info "Public beta"
> The Monitor hub is in Public Beta. Some functionality may change before it becomes generally available.

![A screenshot of the custom alerts tab for a Segment workspace depicting three different source volume alerts with different integrations and thresholds.](/docs/monitor/images/custom-alerting.png)

You can create alerts for the following product areas:
- [Sources](#source-volume-alert)
- [Destinations](#successful-delivery-rate-alert)
- [Reverse ETL](#mapping-level-successful-delivery-rate-fluctuations)
- [Twilio Engage](#activation-event-health-spikes-or-drops)

## Source volume alert
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 threshold you set. For example, if you set a threshold 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.

<img src="/docs/connections/images/alerting-source-alert.png" alt="A screenshot of the Source Volume alert creation sidesheet." width="470px" height="540px">

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 alert

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 threshold you set. For example, if you set a threshold 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 threshold.
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**.

## Mapping-level successful delivery rate fluctuations

You can create an alert that notifies you when the volume of events successfully received by your mapping in the last 24 hours falls below a threshold you set. For example, if you set a threshold of 99%, Segment notifies you if your destination had a successful delivery rate of 98% or below.

To receive a successful delivery rate fluctuation alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see Slack's [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation.

![A screenshot of the Alerts tab for a Mapping, with the new mapping sidesheet partially filled out.](/docs/connections/reverse-etl/images/mapping-alerting.jpeg)

To subscribe to alerts for successful delivery fluctuations at the mapping level:
1. Navigate to your intended mapping and select the **Alerts** tab.
2. Click **Create alert**.
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.
- **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**.

To edit or disable your alert, navigate to your mapping's Alerts tab and select the Actions menu for the alert you'd like to edit.

## Activation event health spikes or drops

You can create an Activation event health spikes or drops alert that notifies you when events sent from your audience to a downstream destination have failures to a destination above a certain threshold. For example, if you set a threshold of 4% and your destination received 100 events from your Audience over the first 24 hours, Segment would notify you the following day if your destination ingested fewer than 96 or more than 104 events.

To create an Activation event health spikes or drops alert:
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**.
3. On the Create alert sidesheet, select the destination for which you'd like to monitor event health.
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.
- **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**.

To make changes to an Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Edit**.

To delete a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**.
16 changes: 13 additions & 3 deletions src/monitor/alerts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,20 @@ Segment has two kinds of alerts:
- **Default alerts**: Alerts that have a preset threshold and are often used to detect changes users make to the integrations in your workspace. For example, a _Source created_ alert is a default alert.
- **Custom alerts**: Alerts that allow you to customize the sensitivity of the trigger that activates an alert so you can more accurately detect event volume fluctuations in your sources and destinations. For example, a _Source volume fluctuation_ alert would be a custom alert, as you could select a percentage of fluctuation that would work for your business needs.


<div class="double">
{% include components/reference-button.html
href="/monitor/alerts/default-alerts"
variant="related"
icon="monitor.svg"
icon="segment-app.svg"
title="Default alerts"
description="Learn more about Segment's default alerts."
%}
description="Default alerts are often used to detect changes users made in your workspace."
%}

{% include components/reference-button.html
href="/monitor/alerts/custom-alerts"
icon="book.svg"
title="Custom alerts"
description="Custom alerts allow you detect fluctuations in event volumes."
%}
</div>
Binary file added src/monitor/images/custom-alerting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
72 changes: 72 additions & 0 deletions src/privacy/consent-management/consent-in-engage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: Consent in Engage Audiences
plan: consent-management
---

Once an end user's consent preferences are [stored on their Profile](/docs/privacy/consent-management/consent-in-unify#segment-consent-preference-updated-event), you can create Engage Audiences that respect end user consent preferences to better comply with privacy regulations.

> info "Consent in Engage Profiles Audiences is in public beta"
> Consent in Engage Audiences is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. Contact your account team to participate in the public beta.
>
> Consent in Engage Audiences does **not** support Engage Accounts Audiences, Linked Audiences, Predictions, Computed Traits, and Journeys.

## Enforce consent preferences in your Audiences

Before enforcing consent preferences in your Profiles Audiences, you must complete the following prerequisites:
- Set up [Consent in Segment Connections](/docs/privacy/consent-management/configure-consent-management) or [Consent in Reverse ETL](/docs/privacy/consent-management/consent-in-retl) and have events stamped with the [consent object](/docs/privacy/consent-management/consent-in-segment-connections#consent-object) streaming from your source or available in your data warehouse.
- Map your Engage Destinations to consent categories. Segment assumes all Engage Destinations not mapped to a consent category do not require consent and will recieve all events containing a consent object.
- Verify that your Profiles have consent preferences by creating an Audience with a consent trait condition. If the majority of Profiles have consent preferences on them, you're ready to enable consent enforcement in your Unify space.

### Step 1: Enable consent in your Unify space

You can enable Consent Management in each Unify space that you'd like Segment to automatically enforce consent preferences. If you've chosen not to enable Consent Management for a Unify space but have set up Consent Management for Reverse ETL or Segment Connections, Segment continues to stamp consent preferences on your Profiles.

> info ""
> To enable Consent Management in your Unify space, you must have a [Workspace Owner role](/docs/segment-app/iam/roles/).

To enable Consent Management in your Unify space:
1. Navigate to **Privacy > Consent Management** and select the Settings tab.
2. Enable the toggle under the Status column to turn on Consent Management for your Unify space.
3. On the **Enable consent enforcement for [Space Name]?** popup, enter the name of your Unify space and click **Enable enforcement**.

### Step 2: Create your Audience

You can create a Profiles Audiences as you normally would and Segment automatically enforces consent in your downstream destinations. If you don't want Segment to automatically enforce consent, disable consent enforcement in your Unify space and manually add the consent trait Audience condition when building your Audiences.

> warning "Consent enforcement doesn't automatically apply to Audiences that existed prior to the enablement of Consent Management in your Unify space"
> Audiences that existed before you enabled Consent Management in a Unify space only enforce consent preferences for new Profiles that enter the Audience after you enabled Consent Management. If you want to ensure each of your Audiences only includes consenting Profiles, request a resync. All Audiences created after you enable Consent Management for a space automatically enforce consent preferences when sharing their data with mapped destination(s).

Destinations mapped to a consent category only receive the Profiles of users who have given consent to that category. Destinations not mapped to a consent category receive all Profiles in an Audience, regardless of the Profile's consent preferences.

If you opt to send your Audience to multiple destinations belonging to multiple categories, then each destination receives data for the Profiles that have consent to the destination’s mapped category. For example, if you have an audience mapped to Google Ads (mapped to the Advertising consent category) and Snowflake (mapped to the Analytics consent category), then:
* Google Ads receives all profiles that have consented to Advertising consent category, independent of users' who consented to Analytics
* Snowflake receives all profiles that have consented to Analytics, independent of their Advertising preferences.

> info "Consent preferences can affect Audience sync size"
> The number of profiles that sync to your Engage destination(s) depends on the number of end users that consented to their data being shared with the destinations connected to your Audience. To see the impact of consent on your Audience, add consent traits to the Audience builder.

If you have Profiles with consent preferences for some, but not all consent categories, Segment adds all available categories to the `categoryPreferences` object on all Identify and/or Track calls and considers missing consent categories to be `false`. If you have Profiles with no consent preferences, Segment automatically adds an empty `categoryPreferences` object and prevents those Profiles from flowing downstream to your destination.

## Verify that your Audiences respect consent preferences

After you enable consent management in your Unify space, Segment automatically filters out end users that have not consented to the category that you mapped to your connected destination.

However, if you'd like to confirm that this behavior is working as intended, you can either [compare an end user Profile against your mapped categories](#compare-an-end-user-profile-to-your-mapped-categories) or verify that [Delivery Overview](#use-delivery-overview) contains a `FILTERED_BY_END_USER_CONSENT` event.

> warning "Consent enforcement does not automatically apply to Audiences that existed prior to the enablement of Consent Management in your Unify space"
> Audiences that existed before you enabled Consent Management in a Unify space only enforce consent preferences for new Profiles that enter the Audience after you enabled Consent Management. If you want to ensure each of your Audiences only includes consenting Profiles, request a resync. All Audiences created after you enable Consent Management for a space automatically enforce consent preferences when sharing their data with mapped destination(s).

### Compare an end user Profile to your mapped categories

You can verify that your Audiences are respecting consent preferences by selecting a user Profile, identifying one category they consented to, and confirming that the user's Profile appears in one of the destinations mapped to that category.

### Use Delivery Overview

You can use [Delivery Overview](/docs/connections/delivery-overview/) to verify that your destination is enforcing your user's consent preferences by checking for the presence of a `FILTERED_BY_END_USER_CONSENT` discard reason.

To verify that your events are being filtered by end user consent:
1. Select the destination connected to your Engage Audience.
2. On the Delivery Overview page, select **Filtered at destination**.
3. Search through the table of discarded events until you find an event with a discard reason of `FILTERED_BY_END_USER_CONSENT`.

If the discard reason `FILTERED_BY_END_USER_CONSENT` is present in the point where your destination discards events, your destination is enforcing your end users' consent preferences appropriately.
Loading
Loading