Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BD-3508 Add note about hourly Segment Extension refreshes #8137

Merged
merged 5 commits into from
Sep 25, 2024
Merged

BD-3508 Add note about hourly Segment Extension refreshes #8137

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8e70cfc
BD-3508 Add note about hourly Segment Extension refreshes
rachel-feinberg Sep 23, 2024
9d827ec
Update _docs/_user_guide/engagement_tools/segments/segment_extension.md
rachel-feinberg Sep 25, 2024
30f328a
Remove duplicate section
rachel-feinberg Sep 25, 2024
d1db08c
Add details
rachel-feinberg Sep 25, 2024
8d04619
Minor verbiage changes to clarify between regular segments and extens…
bre-fitzgerald Sep 25, 2024
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
18 changes: 9 additions & 9 deletions _docs/_user_guide/engagement_tools/segments/segment_extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,20 +82,16 @@ Using event properties within Segment Extensions does not impact data point usag

## Step 4: Designate refresh settings (optional)

You can specify whether you want this extension to represent a single snapshot in time, or to refresh on a recurring schedule.
If you don't need your extension to refresh on a regular schedule, you can save it without using refresh settings, and Braze will default to generating your Segment Extension based on your user membership at that moment. Use the default behavior if you only want to generate the audience once and then target it with a one-off campaign.

Your segment will always begin processing after the initial save. Whenever your segment refreshes, Braze will re-run the segment and update segment membership to reflect the users in your segment at the time of refresh.

### Saving a snapshot in time

If you don't need your segment to refresh on a regular schedule, you can save it without using any refresh settings, and Braze will generate your segment based on your user membership at that moment.
Your segment will always begin processing after the initial save. Whenever your segment refreshes, Braze will re-run the segment and update segment membership to reflect the users in your segment at the time of refresh. This can help your recurring campaigns reach the most relevant users.

### Setting up a recurring refresh

To set up a recurring schedule, select **Refresh Settings** in the upper right corner of your specific extension. The option to designate refresh settings is available for SQL segments and CDI segments. Currently, this option is not available for simple form-based Segment Extensions.
To set up a recurring schedule, select **Refresh Settings** in the upper right corner of your specific extension. The option to designate refresh settings is available for all types of Segment Extensions, including SQL segments, CDI segments, and simple form-based Segment Extensions.

{% alert important %}
The setting to regenerate extensions daily is automatically turned off for unused Segment Extensions. Braze defines unused extensions as ones that meet the following criteria:
Refresh settings are automatically turned off for unused Segment Extensions. Braze defines unused extensions as ones that meet the following criteria:

- Not used in any active campaigns, Canvases, or segments
- Not used in any inactive (draft, stopped, archived) campaigns, Canvases, or segments
Expand All @@ -108,11 +104,15 @@ Braze will notify the company contact and creator of the extension when this set

![Refresh Interval Settings with a weekly refresh frequency, start time of 10 am, and Monday selected as a day.][21]{: style="max-width:60%;"}

Within the **Refresh Settings** panel, you can select the frequency at which this segment extension will refresh: daily, weekly, or monthly. You’ll also be required to select the specific time (which is in your company’s time zone) the refresh would occur, such as:
Within the **Refresh Settings** panel, you can select the frequency at which this segment extension will refresh: hourly, daily, weekly, or monthly. You’ll also be required to select the specific time (which is in your company’s time zone) the refresh would occur, such as:

- If you have an email campaign that is sent every Monday at 11 am company time, and you want to ensure your segment is refreshed right before it's sent, you should choose a refresh schedule of weekly at 10 am on Mondays.
- If you’d like your segment to refresh every day, select the daily refresh frequency and then choose the time of day to refresh.

{% alert note %}
The ability to set an hourly refresh schedule isn't available for form-based Segment Extensions (but you can set daily, weekly, or monthly schedules).
{% endalert %}

### Credit consumption and additional costs

Because refreshes re-run your segment’s query, each refresh for SQL segments will consume SQL segment credits, and each refresh for CDI segments will incur a cost within your third-party data warehouse.
Expand Down