Skip to content

Commit c757ec8

Browse files
Merge pull request #7693 from segmentio/master
Master to develop after one-off
2 parents b96a0c2 + f5ac8cc commit c757ec8

File tree

3 files changed

+81
-4
lines changed

3 files changed

+81
-4
lines changed

src/engage/audiences/index.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -286,14 +286,17 @@ To access audience alerting, navigate to **Engage > Audiences**, select an audie
286286

287287
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/).
288288

289+
> info "Deleting alerts created by other users requires Workspace Owner role"
290+
> 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.
291+
289292
#### Activation event health spikes or drops
290293

291294
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.
292295

293296
To create an Activation event health spikes or drops alert:
294297
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
295298
2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**.
296-
3. On the Create alert sidesheet, select the destination for which you'd like to monitor event health.
299+
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.
297300
4. Enter a percentage threshold to trigger activation event health notifications.
298301
5. Select one or more of the following alert channels:
299302
- **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
305308

306309
To delete a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**.
307310

308-
> info "Deleting alerts created by other users requires Workspace Owner role"
309-
> 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.
311+
#### Audience size change
312+
313+
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.
314+
315+
> info "Audience size change alerts currently only support Linked Audiences"
316+
> 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.
317+
318+
To create an Audience size change alert:
319+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
320+
2. Select the Linked Audience you want to create an alert for, select the Alerts tab, and click **Create alert**.
321+
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.
322+
4. Enter a percentage threshold to trigger audience size change notifications.
323+
5. Select one or more of the following alert channels:
324+
- **Email**: Select this to receive notifications at the provided email address.
325+
- **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”}.
326+
- **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.
327+
6. Click **Save**.
328+
329+
To make changes to an Audience size change alert, select the icon in the Actions column for the alert and click **Edit**.
330+
331+
To delete a Audience size change alert, select the icon in the Actions column for the alert and click **Delete**.
310332

311333
## Access your Audiences using the Profiles API
312334

src/engage/audiences/linked-audiences.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,61 @@ Linked Audiences have the following steps in Delivery Overview's pipeline view:
260260
- **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.
261261
- **Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations.
262262

263+
## Linked Audience Alerts
264+
265+
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.
266+
267+
> info "Generate a Slack webhook to receive Slack notifications"
268+
> 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.
269+
270+
To access Linked Audience alerting, navigate to **Engage > Audiences**, select a Linked Audience, and click the **Alerts** tab.
271+
272+
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/).
273+
274+
> info "Deleting alerts created by other users requires Workspace Owner role"
275+
> 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.
276+
277+
#### Activation event health spikes or drops
278+
279+
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.
280+
281+
To create an Activation event health spikes or drops alert:
282+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
283+
2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**.
284+
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.
285+
4. Enter a percentage threshold to trigger activation event health notifications.
286+
5. Select one or more of the following alert channels:
287+
- **Email**: Select this to receive notifications at the provided email address.
288+
- **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”}.
289+
- **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.
290+
6. Click **Save**.
291+
292+
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**.
293+
294+
To delete a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**.
295+
296+
#### Audience size change
297+
298+
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.
299+
300+
> info "Audience size change alerts are currently in Public Beta"
301+
> 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.
302+
303+
To create an Audience size change alert:
304+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
305+
2. Select the Linked Audience you want to create an alert for, select the Alerts tab, and click **Create alert**.
306+
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.
307+
4. Enter a percentage threshold to trigger audience size change notifications.
308+
5. Select one or more of the following alert channels:
309+
- **Email**: Select this to receive notifications at the provided email address.
310+
- **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”}.
311+
- **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.
312+
6. Click **Save**.
313+
314+
To make changes to an Audience size change alert, select the icon in the Actions column for the alert and click **Edit**.
315+
316+
To delete a Audience size change alert, select the icon in the Actions column for the alert and click **Delete**.
317+
263318
## Maintaining Linked Audiences
264319

265320
You can maintain your Linked Audience by accessing these tabs on the main page of your Linked Audience:

src/monitor/alerts/default-alerts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ your identity-resolved profiles to your data warehouse.
117117
- **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”}.
118118

119119
> info "Custom Engage alerts"
120-
> 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.
120+
> 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.
121121
122122
## Users alerts
123123
- **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.

0 commit comments

Comments
 (0)