Skip to content

Commit 8afd4d9

Browse files
Merge pull request #7869 from segmentio/master
Master to develop after consent in engage + custom alerts betas
2 parents c1306f4 + 841b9da commit 8afd4d9

File tree

8 files changed

+208
-14
lines changed

8 files changed

+208
-14
lines changed

src/_data/sidenav/main.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,8 +316,6 @@ sections:
316316
title: Event Delivery
317317
- path: /connections/delivery-overview
318318
title: Delivery Overview
319-
- path: /connections/alerting
320-
title: Connections Alerting
321319
- path: /connections/find-writekey
322320
title: Locate Your Write Key
323321
- path: /connections/integration_error_codes
@@ -605,6 +603,8 @@ sections:
605603
title: Consent Stored on the Profile
606604
- path: /privacy/consent-management/consent-in-retl
607605
title: Consent in Reverse ETL
606+
- path: /privacy/consent-management/consent-in-engage
607+
title: Consent in Engage Audiences
608608
- path: /privacy/consent-management/consent-faq
609609
title: Consent FAQs
610610
- section_title: Deletion and Suppression
@@ -633,6 +633,8 @@ sections:
633633
title: Alerts Overview
634634
- path: /monitor/alerts/default-alerts
635635
title: Default Alerts
636+
- path: /monitor/alerts/custom-alerts
637+
title: Custom Alerts
636638
- section_title: Protocols
637639
section:
638640
- path: /protocols

src/connections/alerting.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Connections Alerting
33
beta: true
4+
hidden: true
45
---
56

67
Connections Alerting allows Segment users to receive in-app, email, and Slack notifications related to the performance and throughput of an event-streaming connection.
@@ -34,6 +35,8 @@ To delete a source volume alert, select the icon in the Actions column for the a
3435

3536
> info "Deleting alerts created by other users requires Workspace Owner permissions"
3637
> All users can delete source volume alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
38+
39+
3740
## Successful delivery rate alerts
3841

3942
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.
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: Custom Alerts
3+
---
4+
5+
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.
6+
7+
> info "Public beta"
8+
> The Monitor hub is in Public Beta. Some functionality may change before it becomes generally available.
9+
10+
![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)
11+
12+
You can create alerts for the following product areas:
13+
- [Sources](#source-volume-alert)
14+
- [Destinations](#successful-delivery-rate-alert)
15+
- [Reverse ETL](#mapping-level-successful-delivery-rate-fluctuations)
16+
- [Twilio Engage](#activation-event-health-spikes-or-drops)
17+
18+
## Source volume alert
19+
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.
20+
21+
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.
22+
23+
<img src="/docs/connections/images/alerting-source-alert.png" alt="A screenshot of the Source Volume alert creation sidesheet." width="470px" height="540px">
24+
25+
To create a source volume alert:
26+
1. In your workspace, navigate to Connections, select Sources, and select the Event streams tab.
27+
2. Select the [event streams source](/docs/connections/sources/#event-streams-sources) you'd like to configure alerts for.
28+
2. Select the Alerts tab and click **Create alert**.
29+
3. On the Create alert sidesheet, enter a percentage of source volume change that you'd like to be notified for.
30+
4. Select one or more of the following alert channels:
31+
- **Email**: Select this to receive notifications at the provided email address.
32+
- **Slack**: Select this to send alerts to one or more channels in your workspace.
33+
- **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.
34+
5. Click **Save**.
35+
36+
To make changes to a source volume alert, select the icon in the Actions column for the alert and click **Edit**.
37+
38+
To delete a source volume alert, select the icon in the Actions column for the alert and click **Delete**.
39+
40+
> info "Deleting alerts created by other users requires Workspace Owner permissions"
41+
> All users can delete source volume alerts that they created, but only those with Workspace Owner permissions can delete alerts created by other users.
42+
43+
## Successful delivery rate alert
44+
45+
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.
46+
47+
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.
48+
49+
To create a successful delivery rate alert:
50+
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.
51+
2. Select the Alerts tab and click **Create alert**.
52+
3. On the Create alert sidesheet, enter a percentage. You will receive events if your successful delivery rate falls below this threshold.
53+
4. Select one of the following alert channels:
54+
- **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.
55+
- **Slack**: Select this and enter a Slack webhook URL and channel name to send alerts to a channel in your Slack workspace.
56+
- **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.
57+
5. Click **Save**.
58+
59+
To make changes to a successful delivery rate alert, select the icon in the Actions column for the alert and click **Edit**.
60+
61+
To delete a successful delivery rate alert, select the icon in the Actions column for the alert and click **Delete**.
62+
63+
## Mapping-level successful delivery rate fluctuations
64+
65+
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.
66+
67+
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.
68+
69+
![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)
70+
71+
To subscribe to alerts for successful delivery fluctuations at the mapping level:
72+
1. Navigate to your intended mapping and select the **Alerts** tab.
73+
2. Click **Create alert**.
74+
3. Set an *alert threshold*, or the percentage of successfully delivered events that would prompt an alert.
75+
4. Select one or more of the following notification channels:
76+
- **Email**: Enter an email address or alias that should receive alerts.
77+
- **Slack notification**: Enter a Webhook URL and a Slack channel name to receive alerts in a Slack channel.
78+
- **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.
79+
5. Toggle the **Enable alert** setting on and click **Create**.
80+
81+
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.
82+
83+
## Activation event health spikes or drops
84+
85+
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.
86+
87+
To create an Activation event health spikes or drops alert:
88+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
89+
2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**.
90+
3. On the Create alert sidesheet, select the destination for which you'd like to monitor event health.
91+
4. Enter a percentage threshold to trigger activation event health notifications.
92+
5. Select one or more of the following alert channels:
93+
- **Email**: Select this to receive notifications at the provided email address.
94+
- **Slack**: Select this to send alerts to one or more channels in your workspace.
95+
- **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.
96+
6. Click **Save**.
97+
98+
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**.
99+
100+
To delete a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**.

src/monitor/alerts/index.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,20 @@ Segment has two kinds of alerts:
1010
- **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.
1111
- **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.
1212

13+
14+
<div class="double">
1315
{% include components/reference-button.html
1416
href="/monitor/alerts/default-alerts"
1517
variant="related"
16-
icon="monitor.svg"
18+
icon="segment-app.svg"
1719
title="Default alerts"
18-
description="Learn more about Segment's default alerts."
19-
%}
20+
description="Default alerts are often used to detect changes users made in your workspace."
21+
%}
22+
23+
{% include components/reference-button.html
24+
href="/monitor/alerts/custom-alerts"
25+
icon="book.svg"
26+
title="Custom alerts"
27+
description="Custom alerts allow you detect fluctuations in event volumes."
28+
%}
29+
</div>
116 KB
Loading
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Consent in Engage Audiences
3+
plan: consent-management
4+
---
5+
6+
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.
7+
8+
> info "Consent in Engage Profiles Audiences is in public beta"
9+
> 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.
10+
>
11+
> Consent in Engage Audiences does **not** support Engage Accounts Audiences, Linked Audiences, Predictions, Computed Traits, and Journeys.
12+
13+
## Enforce consent preferences in your Audiences
14+
15+
Before enforcing consent preferences in your Profiles Audiences, you must complete the following prerequisites:
16+
- 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.
17+
- 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.
18+
- 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.
19+
20+
### Step 1: Enable consent in your Unify space
21+
22+
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.
23+
24+
> info ""
25+
> To enable Consent Management in your Unify space, you must have a [Workspace Owner role](/docs/segment-app/iam/roles/).
26+
27+
To enable Consent Management in your Unify space:
28+
1. Navigate to **Privacy > Consent Management** and select the Settings tab.
29+
2. Enable the toggle under the Status column to turn on Consent Management for your Unify space.
30+
3. On the **Enable consent enforcement for [Space Name]?** popup, enter the name of your Unify space and click **Enable enforcement**.
31+
32+
### Step 2: Create your Audience
33+
34+
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.
35+
36+
> warning "Consent enforcement doesn't automatically apply to Audiences that existed prior to the enablement of Consent Management in your Unify space"
37+
> 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).
38+
39+
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.
40+
41+
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:
42+
* Google Ads receives all profiles that have consented to Advertising consent category, independent of users' who consented to Analytics
43+
* Snowflake receives all profiles that have consented to Analytics, independent of their Advertising preferences.
44+
45+
> info "Consent preferences can affect Audience sync size"
46+
> 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.
47+
48+
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.
49+
50+
## Verify that your Audiences respect consent preferences
51+
52+
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.
53+
54+
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.
55+
56+
> warning "Consent enforcement does not automatically apply to Audiences that existed prior to the enablement of Consent Management in your Unify space"
57+
> 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).
58+
59+
### Compare an end user Profile to your mapped categories
60+
61+
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.
62+
63+
### Use Delivery Overview
64+
65+
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.
66+
67+
To verify that your events are being filtered by end user consent:
68+
1. Select the destination connected to your Engage Audience.
69+
2. On the Delivery Overview page, select **Filtered at destination**.
70+
3. Search through the table of discarded events until you find an event with a discard reason of `FILTERED_BY_END_USER_CONSENT`.
71+
72+
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.

0 commit comments

Comments
 (0)