From 752f94e740da613547629e7046b4cc622d9d8b1d Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 18 Jun 2025 15:30:13 -0400 Subject: [PATCH 1/4] init --- src/engage/audiences/index.md | 28 ++++++++++-- src/engage/audiences/linked-audiences.md | 55 ++++++++++++++++++++++++ 2 files changed, 80 insertions(+), 3 deletions(-) diff --git a/src/engage/audiences/index.md b/src/engage/audiences/index.md index 285032c5b4..7867685073 100644 --- a/src/engage/audiences/index.md +++ b/src/engage/audiences/index.md @@ -286,6 +286,9 @@ To access audience alerting, navigate to **Engage > Audiences**, select an audie On the **Alerts** tab, you can create new alerts and view all active alerts for this connection. You can only edit or delete the alerts that you create, unless you have the [Workspace Owner role](/docs/segment-app/iam/roles/). +> info "Deleting alerts created by other users requires Workspace Owner role" +> All users can delete alerts that they created, but only those with [Workspace Owner role](/docs/segment-app/iam/roles/) can delete alerts created by other users. + #### 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 change percentage 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. @@ -293,7 +296,7 @@ You can create an Activation event health spikes or drops alert that notifies yo 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. +3. On the Create alert sidesheet, select the **Activation event health spikes or drops** alert and pick a 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. @@ -305,8 +308,27 @@ To make changes to an Activation event health spikes or drops alert, select the To delete a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**. -> info "Deleting alerts created by other users requires Workspace Owner role" -> All users can delete alerts that they created, but only those with [Workspace Owner role](/docs/segment-app/iam/roles/) can delete alerts created by other users. +#### Audience size change + +You can create an Audience size change alert that notifies you when your audience increases or decreases by a certain threshold. For example, if you set a change percentage of 4% and your destination had 100 members over the first 24 hours, Segment would notify you the following day if your audience had fewer than 96 or more than 104 members. + +> info "Audience size change alerts are currently in Public Beta" +> Audience size change alerts are in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. During the public beta, Audience size change alerts only support Linked Audiences. + +To create an Audience size change alert: +1. From your Segment workspace's home page, navigate to **Engage > Audiences**. +2. Select the Linked Audience you want to create an alert for, select the Alerts tab, and click **Create alert**. +3. On the Create alert sidesheet, select the **Audience size change alert** and pick a destination for which you'd like to monitor event health. +4. Enter a percentage threshold to trigger audience size change 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. 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**. + +To make changes to an Audience size change alert, select the icon in the Actions column for the alert and click **Edit**. + +To delete a Audience size change alert, select the icon in the Actions column for the alert and click **Delete**. ## Access your Audiences using the Profiles API diff --git a/src/engage/audiences/linked-audiences.md b/src/engage/audiences/linked-audiences.md index 2b05ab718f..54baf1c245 100644 --- a/src/engage/audiences/linked-audiences.md +++ b/src/engage/audiences/linked-audiences.md @@ -260,6 +260,61 @@ Linked Audiences have the following steps in Delivery Overview's pipeline view: - **Failed delivery**: Events that Segment _attempted_ to deliver to your destination, but that ultimately _failed_ to be delivered. Failed delivery might indicate an issue with the destination, like invalid credentials, rate limits, or other error statuses received during delivery. - **Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations. +## Linked Audience Alerts + +You can create alerts related to the performance and throughput of Linked Audience syncs and receive in-app, email, and Slack notifications when event volume fluctuations occur. + +> info "Generate a Slack webhook to receive Slack notifications" +> To receive an 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. + +To access Linked Audience alerting, navigate to **Engage > Audiences**, select a Linked Audience, and click the **Alerts** tab. + +On the **Alerts** tab, you can create new alerts and view all active alerts for this connection. You can only edit or delete the alerts that you create, unless you have the [Workspace Owner role](/docs/segment-app/iam/roles/). + +> info "Deleting alerts created by other users requires Workspace Owner role" +> All users can delete alerts that they created, but only those with [Workspace Owner role](/docs/segment-app/iam/roles/) can delete alerts created by other users. + +#### 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 change percentage 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 **Activation event health spikes or drops** alert and pick a 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. 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**. + +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**. + +#### Audience size change + +You can create an Audience size change alert that notifies you when your audience increases or decreases by a certain threshold. For example, if you set a change percentage of 4% and your destination had 100 members over the first 24 hours, Segment would notify you the following day if your audience had fewer than 96 or more than 104 members. + +> info "Audience size change alerts are currently in Public Beta" +> Audience size change alerts are in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. + +To create an Audience size change alert: +1. From your Segment workspace's home page, navigate to **Engage > Audiences**. +2. Select the Linked Audience you want to create an alert for, select the Alerts tab, and click **Create alert**. +3. On the Create alert sidesheet, select the **Audience size change alert** and pick a destination for which you'd like to monitor event health. +4. Enter a percentage threshold to trigger audience size change 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. 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**. + +To make changes to an Audience size change alert, select the icon in the Actions column for the alert and click **Edit**. + +To delete a Audience size change alert, select the icon in the Actions column for the alert and click **Delete**. + ## Maintaining Linked Audiences You can maintain your Linked Audience by accessing these tabs on the main page of your Linked Audience: From 48f40af0765ce853acefd3093fa186afdf72df6b Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 18 Jun 2025 16:07:12 -0400 Subject: [PATCH 2/4] add to default alerts page --- src/monitor/alerts/default-alerts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/monitor/alerts/default-alerts.md b/src/monitor/alerts/default-alerts.md index 5d4b7dca16..a652b58d84 100644 --- a/src/monitor/alerts/default-alerts.md +++ b/src/monitor/alerts/default-alerts.md @@ -117,7 +117,7 @@ your identity-resolved profiles to your data warehouse. - **Audience Run Failed**: Segment was unable to compute your Audience. To resolve this error, please [contact Segment support](https://segment.com/help/contact/){:target="_blank”}. > 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. +> During the Monitor public beta, you can configure custom [Activation event health spikes or drops](/docs/engage/audiences/#activation-event-health-spikes-or-drops) and [Audience size change alerts](/docs/engage/audiences/#audience-size-change) 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. From ab6edc90acc831cdc522265415599f2f2ce11c5d Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 18 Jun 2025 16:08:09 -0400 Subject: [PATCH 3/4] fix --- src/monitor/alerts/default-alerts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/monitor/alerts/default-alerts.md b/src/monitor/alerts/default-alerts.md index a652b58d84..5e4ca88392 100644 --- a/src/monitor/alerts/default-alerts.md +++ b/src/monitor/alerts/default-alerts.md @@ -117,7 +117,7 @@ your identity-resolved profiles to your data warehouse. - **Audience Run Failed**: Segment was unable to compute your Audience. To resolve this error, please [contact Segment support](https://segment.com/help/contact/){:target="_blank”}. > 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) and [Audience size change alerts](/docs/engage/audiences/#audience-size-change) alerts, but these alerts won't appear in the Monitor tab. +> During the Monitor public beta, you can configure custom [Activation event health spikes or drops](/docs/engage/audiences/#activation-event-health-spikes-or-drops) and [Audience size change](/docs/engage/audiences/#audience-size-change) 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. From 4cc95bb7e5daece9c648e533a3680e0bfbf68a52 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 18 Jun 2025 19:58:26 -0400 Subject: [PATCH 4/4] Update index.md --- src/engage/audiences/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/engage/audiences/index.md b/src/engage/audiences/index.md index 7867685073..86259525b9 100644 --- a/src/engage/audiences/index.md +++ b/src/engage/audiences/index.md @@ -312,8 +312,8 @@ To delete a Activation event health spikes or drops alert, select the icon in th You can create an Audience size change alert that notifies you when your audience increases or decreases by a certain threshold. For example, if you set a change percentage of 4% and your destination had 100 members over the first 24 hours, Segment would notify you the following day if your audience had fewer than 96 or more than 104 members. -> info "Audience size change alerts are currently in Public Beta" -> Audience size change alerts are in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. During the public beta, Audience size change alerts only support Linked Audiences. +> info "Audience size change alerts currently only support Linked Audiences" +> Audience size change alerts are in public beta, and Segment is actively working on this feature. During the public beta, Audience size change alerts only support Linked Audiences. Some functionality may change before it becomes generally available. To create an Audience size change alert: 1. From your Segment workspace's home page, navigate to **Engage > Audiences**.