-
Notifications
You must be signed in to change notification settings - Fork 384
linked audiences test event draft #6648
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
da8dfc1
linked audiences test event draft
cmastr c38c23d
adding more definitions
cmastr 52771ec
more notes integration
cmastr 81acb02
Update linked-audiences.md
cmastr 7975dc8
updating payload info [netlify-build]
cmastr e5b19cc
Update linked-audiences.md [netlify-build]
cmastr 7e012dd
Update linked-audiences.md [netlify-build]
cmastr 67276a0
more updates and iterations [netlify-build]
cmastr e82ff4f
adding payload image [netlify-build]
cmastr 6ff7206
Update linked-audiences.md [netlify-build]
cmastr 7497fd4
Update linked-audiences.md
cmastr 861b13b
Apply suggestions from code review
cmastr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,7 +9,9 @@ hidden: true | |
> info "Linked Audiences is in public beta" | ||
> Linked Audiences is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. | ||
|
||
Linked Audiences allows you to build a warehouse first solution that powers individualized customer experiences using the relational data you've defined in your [Data Graph](/docs/unify/linked-profiles/data-graph/). You can: | ||
Linked Audiences allows you to build a warehouse-first solution that powers individualized customer experiences using the relational data you've defined in your [Data Graph](/docs/unify/linked-profiles/data-graph/). | ||
|
||
You can: | ||
|
||
- Preserve rich relationships between all the data in your warehouse by creating connections with any entity data back to your audience profile. | ||
- Build advanced audience segments that include the rich context needed for personalization downstream. | ||
|
@@ -32,8 +34,8 @@ To set up your Linked Audience, complete the following steps: | |
|
||
- [Step 1: Build a Linked Audience](#step-1-build-a-linked-audience) | ||
- [Step 2: Activate your Linked Audiences](#step-2-activate-your-linked-audience) | ||
- [Step 3: Enable your Linked Audience](#step-3-enable-your-linked-audience) | ||
- [Step 4: Confirm the payload in your destination](#step-4-confirm-the-payload-in-your-destination) | ||
- [Step 3: Send a test event to your destination](#step-3-send-a-test-event-to-your-destination) | ||
- [Step 4: Enable your Linked Audience](step-4-enable-your-linked-audience) | ||
|
||
## Step 1: Build a Linked Audience | ||
|
||
|
@@ -96,9 +98,7 @@ To activate your Linked Audience: | |
|
||
### Step 2b: Select your Destination Actions | ||
|
||
The [Destination Actions](/docs/connections/destinations/actions/) framework allows you to see and control how Segment sends the event data it receives from your sources to actions-based destinations. Each Action in a destination lists the event data it requires, and the event data that is optional. | ||
|
||
Segment displays available actions based on the destination you've connected to your Linked Audience. | ||
The [Destination Actions](/docs/connections/destinations/actions/) framework allows you to see and control how Segment sends the event data it receives from your sources to actions-based destinations. Each Action in a destination lists the event data it requires and the event data that is optional. Segment displays available Actions based on the destination you've connected to your Linked Audience. You can see details of each option and how to use it in the [Actions Destinations Catalog](/docs/connections/destinations/catalog/) documentation. | ||
|
||
Select the Destination Action to call when the event happens, then click **Next**. | ||
|
||
|
@@ -108,7 +108,7 @@ Configure how and when events are produced with each audience run. Select the en | |
|
||
Event Selection |Definition |Examples | ||
--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ||
Profile enters audience | Send a Track event when a profile matches the audience condition. | Send a congratulatory email when a traveler qualifies for premium status with a mileage program.<br>- Send a discount to all customers with a particular product on their wishlist. | ||
Profile enters audience | Send a Track event when a profile matches the audience condition. | Send a congratulatory email when a traveler qualifies for premium status with a mileage program.<br>Send a discount to all customers with a particular product on their wishlist. | ||
Profile exits audience | Send a Track event when a profile no longer matches the audience condition. | Send an email to credit card owners to confirm that their credit cards have been paid in full.<br> Send a confirmation to a patient when they have completed all their pre-screening forms. | ||
Entity enters audience | Send a Track event when an entity condition associated with a profile matches the audience condition. With this event, you must select the entity that triggers Segment to send the Track event. | Send a reminder to a customer when a credit card associated with their profile has an outstanding balance.<br> Notify a traveler when a flight associated with their profile is delayed.<br> Notify a customer when a product associated with their profile's wishlist is back in stock. | ||
Entity exits audience | Send a Track event when an entity condition associated with a profile no longer matches the audience condition. With this event, you must select the entity that triggers Segment to send the Track event| Send a confirmation to a customer when a credit card associated with their profile has been paid off.<br> Send a confirmation to the primary doctor when each of their associated patients completes their annual check up. | ||
|
@@ -118,19 +118,41 @@ Profile enters or exits audience| Send an Identify event when a profile's audien | |
|
||
After you select an action, Segment attempts to automatically configure the data fields that will be sent to the destination. You can review and adjust these settings before enabling this event. | ||
|
||
## Step 3: Enable your Linked Audience | ||
#### Enrich event | ||
|
||
After building your Linked Audience, you'll be redirected to the Audience Overview page. Segment automatically disables your audience so that it does not start computing until you're ready. To enable your audience: | ||
Select additional traits and properties to include when the event is sent. | ||
|
||
Select the **Enabled** toggle, then select **Enable audience**. | ||
#### Show/Hide preview | ||
|
||
As you're enriching your events in Linked Audiences, you should view a preview of the event payload schema based on the properties you select. It might look like the following: | ||
|
||
 | ||
|
||
**Important:** It is important to make a copy of the data from your final payload schema; you will need this data later when you set up your destination. | ||
|
||
#### Map event | ||
|
||
Only required fields are displayed. All optional & pre-filled fields are hidden. | ||
|
||
You can trigger a compute for your audience if you want to send events to your destination without waiting for the next scheduled compute run. To do so, select **Compute Now**. This triggers a compute for the audience (where the audience conditions run on your data warehouse) and sends events downstream. | ||
These fields are pre-filled with properties that will work by default. | ||
|
||
## Step 4: Confirm the payload in your destination | ||
## Step 3: Send a test event to your destination | ||
|
||
Linked Audiences sends events to your destination after Segment computes the audience. | ||
Send a test event to ensure that everything is connected properly and your destination receives the event. | ||
|
||
To confirm your destination is receiving events, Segment recommends that you log in to your destination and perform one of the following: | ||
Enter the destination User id for the profile you want to use to test the event, then click **Send test event to destination**. | ||
|
||
The Event content drop-down shows you a preview of what the data sent to your destination might look like. | ||
|
||
### Step 3a: Configure your multi-channel marketing campaign | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When I get a separate PR up for this topic (Braze), I'll link to it. |
||
|
||
If you're using a multi-channel marketing tool, set up your email campaign before contiuing to Step 4. | ||
|
||
## Step 4: Enable your Linked Audience | ||
|
||
After building your Linked Audience, choose **Save and Enable**. You'll be redirected to the Audience Overview page, where you can view the audience you created. Segment automatically disables your audience so that it doesn't start computing until you're ready. A compute is when Segment runs the audience conditions on your data warehouse and sends events downstream. | ||
|
||
To enable your audience: | ||
Select the **Enabled** toggle, then select **Enable audience**. | ||
|
||
- Monitor the event activity | ||
- Search for the `UserID` or `Event Name` (for example, `Entity Added`) | ||
You can trigger a compute for your audience if you want to send events to your destination without waiting for the next scheduled compute run. To do so, select **Compute Now**. This triggers a compute for the audience and sends events downstream. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.