Skip to content

Commit 22d01f8

Browse files
authored
Merge pull request #7501 from segmentio/master
`master` into `develop` after one-off
2 parents e16b923 + 538fb2f commit 22d01f8

File tree

4 files changed

+200
-13
lines changed

4 files changed

+200
-13
lines changed

src/connections/delivery-overview.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@ title: Delivery Overview
44

55
Delivery Overview is a visual observability tool designed to help Segment users diagnose event delivery issues for any cloud-streaming destination receiving events from cloud-streaming sources.
66

7-
> info "Delivery Overview for RETL destinations and Engage Audience Syncs currently in development"
8-
> This means that Segment is actively developing Delivery Overview features for RETL destinations and Engage Audience syncs. Some functionality may change before Delivery Overview for these integrations becomes generally available.
9-
>
10-
> Delivery Overview is generally available for streaming connections (cloud-streaming sources and cloud-streaming destinations) and in public beta for storage destinations. Some metrics specific to storage destinations, like selective syncs, failed row counts, and total rows seen, are not yet available.
11-
> All users of Delivery Overview have access to the Event Delivery tab, and can configure delivery alerts for their destinations.
12-
13-
147
## Key features
158

169
Delivery Overview has three core features:
@@ -63,6 +56,21 @@ The following image shows a storage destination with 23 partially successful syn
6356

6457
![A screenshot of the Delivery Overview tab for a Storage destination, with the Failed to sync step selected and a table of partially successful syncs.](images/delivery-overview-storage-destinations.png)
6558

59+
#### Destinations connected to Engage Destinations
60+
61+
> info "Delivery Overview for Engage Destinations is in Public Beta"
62+
> During the Public Beta, you can filter your pipeline view by audience.
63+
64+
Destinations connected to an Audience have the following steps in the pipeline view:
65+
- **Events from audience**<sup>*</sup>: Events that Segment created for your activation. The number of events for each compute depends on the changes detected in your audience membership.
66+
- **Filtered at source**: Events discarded by Protocols: either by the [schema settings](/docs/protocols/enforce/schema-configuration/) or [Tracking Plans](/docs/protocols/tracking-plan/create/).
67+
- **Filtered at destination**: If any events aren’t eligible to be sent (for example, due to destination filters, insert function logic, and so on), Segment displays them at this step.
68+
- **Events pending retry**: A step that reveals the number of events that are awaiting retry. Unlike the other steps, you cannot click into this step to view the breakdown table.
69+
- **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.
70+
- **Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations.
71+
72+
<sup>*</sup>_The "Events from audience" step is currently only available for Linked Audiences._
73+
6674
### Breakdown table
6775
The breakdown table provides you with greater detail about the selected events.
6876

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: Connect HubSpot to Segment Profiles
3+
plan: unify
4+
---
5+
6+
This guide explains how to set up HubSpot as a source and connect it to Segment Profiles.
7+
8+
Once configured, this integration lets you send HubSpot data directly to Segment Profiles, eliminating the need for a data warehouse and enabling faster data synchronization and profile enrichment.
9+
10+
> info "Public Beta"
11+
> The HubSpot/Segment Profiles integration is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
12+
13+
## Prerequisites
14+
15+
Before you begin, make sure that you have the following:
16+
17+
- A Segment workspace with [Unify](/docs/unify/) enabled and [Identity Resolution](/docs/unify/identity-resolution/) configured.
18+
- Administrator access to your HubSpot account.
19+
20+
## Integration steps
21+
22+
Follow the steps in this section to connect HubSpot to Segment Profiles.
23+
24+
### 1. Add HubSpot as a source
25+
26+
To start syncing HubSpot data, first add HubSpot as a source to your workspace.
27+
28+
1. From your Segment workspace, go to **Connections > Catalog** and search for **HubSpot**.
29+
2. Select **HubSpot**, then click **Add Source**.
30+
3. Enter a name for your HubSpot source and add an optional label.
31+
4. Log in to HubSpot and choose the account you want to sync data from.
32+
5. Once you've authenticated, return to Segment and click **Next**.
33+
6. Verify the **Schema name**, then click **Next**.
34+
7. In the **Selective Sync** settings:
35+
- Set a start date for the initial sync (or leave it blank for a full historical sync).
36+
- Keep the default sync frequency (every three hours) or adjust it by contacting [email protected].
37+
- Choose the collections to sync.
38+
39+
After adding the source, go to **Settings > Basic settings** and toggle **Enable source**. The first sync begins immediately.
40+
41+
### 2. Add a Segment Profiles destination
42+
43+
Next, add a Segment Profiles destination.
44+
45+
1. From your HubSpot source, go to the **Models** tab and click **Add destination**.
46+
2. Select **Segment Profiles**, then click **Add destination**.
47+
3. Enter a name for the destination, then click **Create destination**.
48+
49+
### 3. Create a data model
50+
51+
A data model defines how HubSpot data maps to Segment Profiles.
52+
53+
1. In the HubSpot source, go to the **Models** tab and click **Create Model**.
54+
2. Select the collections and columns to sync.
55+
3. Preview the data in real time and validate the schema.
56+
4. Name the model and click **Next** to save it.
57+
58+
### 4. Map HubSpot data to Segment Profiles
59+
60+
Now, configure mappings to determine how HubSpot data updates Segment Profiles.
61+
62+
1. In the **Models** tab of your HubSpot source, click **Add mapping**.
63+
2. Segment redirects you to the Segment Profiles destination. Click **Add mapping**.
64+
3. Select your data model and define the mapping rules:
65+
- Choose the Profile Space to update.
66+
- Map HubSpot fields to Segment Profile fields.
67+
- **You must map either the User ID, Anonymous ID, or Group ID field.**
68+
4. Test the mapping with real HubSpot data.
69+
5. Save the configuration.
70+
71+
72+
### 5. Enable destination mapping and finish setup
73+
74+
Finish the setup process by enabling the destination mapping.
75+
76+
1. From the **Overview** tab of the Segment Profiles destination, toggle **Mapping Status** to **Enabled**.
77+
2. Return to your HubSpot source and verify that **Settings > Basic settings** is enabled.
78+
79+
Once complete, HubSpot data syncs to Segment Profiles automatically.
80+
81+
## Data synchronization
82+
83+
After connecting HubSpot to the Segment Profiles destination, the integration begins syncing data:
84+
85+
- New or updated records in HubSpot get sent to Segment Profiles based on your mapping configuration.
86+
- The first sync includes historical data based on your selected start date.
87+
- Future syncs run at the default interval of every three hours.
88+
89+
If you change the start date after the first sync, Segment doesn’t retroactively sync data unless you manually trigger a full sync. Changes to synced collections apply only to future syncs. Data you previously synced from removed collections stays in your workspace.
90+
91+
## Best practices
92+
93+
Keep the following in mind when working with the HubSpot/Segment Profiles integration:
94+
95+
- Start with a small dataset to validate mappings before expanding to all HubSpot objects.
96+
- Regularly review your mappings to make sure they reflect any schema changes in HubSpot or Segment Profiles.
97+
- Monitor both your HubSpot source and Segment Profiles destination for errors and data discrepancies.
98+
99+
Each data model supports mapping from one HubSpot collection at a time. For complex use cases requiring multiple collections, create separate data models and mappings.

src/engage/audiences/index.md

+72
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,78 @@ Engage then processes your realtime Audience or Trait edits. While the edit task
202202
> warning ""
203203
> You can't edit an audience to include anonymous users. If you need to include anonymous profiles, recreate the audience with the appropriate conditions
204204
205+
## Monitor the health of your Audience syncs
206+
207+
Use Segment's [Delivery Overview](#delivery-overview) and [Alerting](#alerting) features to monitor the health of your Audience syncs and get notifications when event volume spikes or drops.
208+
209+
### Delivery Overview
210+
211+
Delivery Overview is a visual observability tool designed to help Segment users diagnose event delivery issues for any event-streaming destination receiving events from Engage Audiences.
212+
213+
Delivery Overview has three core features:
214+
- [Pipeline view](/docs/connections/delivery-overview/#pipeline-view): A visual overview of each step your data takes during the delivery process - from when your audiences outputs events to when events are successfully delivered to your connected destination.
215+
- [Breakdown table](/docs/connections/delivery-overview/#breakdown-table): If you select a step in the pipeline view, you can see more details about the events that were processed at each pipeline step.
216+
- [Discard table](/docs/connections/delivery-overview/#discard-table): If you select an event in a breakdown table, you can see more details about the events that failed or were filtered out of your process. You can also inspect samples of the discarded events.
217+
218+
For more information about the breakdown and discard tables, see the [Delivery Overview](/docs/connections/delivery-overview/) documentation.
219+
220+
To view Delivery Overview for an Audience:
221+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
222+
2. Find an Audience, click the **(...)** menu, and select Delivery Overview.
223+
3. On the Delivery Overview page, select the Audience dropdown to filter by a specific Audience, select the Date range dropdown to filter by a specific time period, or use the Show metrics toggle to view your metrics as percentages.
224+
225+
#### Steps in the pipeline view
226+
227+
By default, Segment displays Delivery Overview information for all Audiences connected to your destination. You can filter your Delivery Overview pipeline view by an individual Audience for more granular data.
228+
229+
You can also further refine the data displayed on the pipeline view using the time picker and the metric toggle, located under the destination header. With the time picker, you can specify a time period (last 10 minutes, 1 hour, 24 hours, 7 days, 2 weeks, or a custom date range over the last two weeks) for which you’d like to see data. With the metric toggle, you can switch between seeing metrics represented as percentages (for example, _85% of events_ or _a 133% increase in events_) or as counts (_13 events_ or _an increase of 145 events_.) Delivery Overview shows percentages by default.
230+
231+
> info "Linked Audiences have additional filtering functionality"
232+
> Linked Audiences users can filter the Delivery Overview event pipeline by [Linked Audience events](/docs/engage/audiences/linked-audiences/#step-2c-define-how-and-when-to-trigger-an-event-to-your-destination). For more information, see the [Linked Audiences](/docs/engage/audiences/linked-audiences/#delivery-overview-for-linked-audiences) documentation.
233+
234+
Audiences have the following steps in the pipeline view:
235+
- **Events that Segment created for your activation**<sup>*</sup>: The number of events for each compute depends on the changes detected in your audience membership.
236+
- **Filtered at source**: Events discarded by Protocols: either by the [schema settings](/docs/protocols/enforce/schema-configuration/) or [Tracking Plans](/docs/protocols/tracking-plan/create/).
237+
- **Filtered at destination**: If any events aren’t eligible to be sent (for example, due to destination filters, insert function logic, and so on), Segment displays them at this step.
238+
- **Events pending retry**: A step that reveals the number of events that are awaiting retry. Unlike the other steps, you cannot click into this step to view the breakdown table.
239+
- **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.
240+
- **Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations.
241+
242+
<sup>*</sup>_The "Events from audience" step is currently only available for Linked Audiences._
243+
244+
### Alerting
245+
246+
Create alerts related to the performance and throughput of Audience syncs and receive in-app, email, and Slack notifications when event volume fluctuations occur.
247+
248+
> info "Generate a Slack webhook to receive Slack notifications"
249+
> 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.
250+
251+
To access Audience alerting, navigate to **Engage > Audiences**, select an Audience, and click the Alerts tab.
252+
253+
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/).
254+
255+
#### Activation event health spikes or drops
256+
257+
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.
258+
259+
To create an Activation event health spikes or drops alert:
260+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
261+
2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**.
262+
3. On the Create alert sidesheet, select the destination for which you'd like to monitor event health.
263+
4. Enter a percentage threshold to trigger activation event health notifications.
264+
5. Select one or more of the following alert channels:
265+
- **Email**: Select this to receive notifications at the provided email address.
266+
- **Slack**: Select this to send alerts to one or more channels in your workspace.
267+
- **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.
268+
6. Click **Save**.
269+
270+
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**.
271+
272+
To delete a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**.
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+
205277
## Access your Audiences using the Profiles API
206278

207279
You can access your Audiences using the Profile API by querying the `/traits` endpoint. For example, you can query for `high_value_user` property with the following `GET` request:

src/engage/audiences/linked-audiences.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -242,12 +242,20 @@ With your Linked Audience activated, follow these steps to monitor your activati
242242

243243
### Delivery Overview for Linked Audiences
244244

245-
Delivery Overview shows you four steps in your data activation pipeline:
246-
247-
- **Events from Audience**: Events that Segment created for your activation. The number of events for each compute depends on the changes detected in your audience membership.
248-
- **Filtered at Destination**: The activation pipeline is rich with features that let you control which events make it to the destination. If any events aren't eligible to be sent (for example, due to destination filters, insert function logic, and so on), Segment will show them in Filtered at Destination.
249-
- **Failed Delivery**: Events that Segment attempted but failed to deliver to your destination. Failed Delivery indicates an issue with the destination, like invalid credentials, rate limits, or other error statuses received during delivery.
250-
- **Successful Delivery**: Events that Segment successfully delivered to your destination. You'll see these events in your downstream integration.
245+
In addition to the standard Audience observability provided by [Delivery Overview](/docs/engage/audiences/#delivery-overview), Linked Audiences can filter Delivery Overview's pipeline view by [Linked Audience events](/docs/engage/audiences/linked-audiences/#step-2c-define-how-and-when-to-trigger-an-event-to-your-destination).
246+
247+
To filter by events:
248+
1. From your Segment workspace's home page, navigate to **Engage > Audiences**.
249+
2. Find an Audience, click the **(...)** menu, and select Delivery Overview.
250+
3. On the Delivery Overview page, select the Linked audience event dropdown to filter by a specific event.
251+
252+
Linked Audiences have the following steps in Delivery Overview's pipeline view:
253+
- **Events from audience**: Events that Segment created for your activation. The number of events for each compute depends on the changes detected in your audience membership.
254+
- **Filtered at source**: Events discarded by Protocols: either by the [schema settings](/docs/protocols/enforce/schema-configuration/) or [Tracking Plans](/docs/protocols/tracking-plan/create/).
255+
- **Filtered at destination**: If any events aren’t eligible to be sent (for example, due to destination filters, insert function logic, and so on), Segment displays them at this step.
256+
- **Events pending retry**: A step that reveals the number of events that are awaiting retry. Unlike the other steps, you cannot click into this step to view the breakdown table.
257+
- **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.
258+
- **Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations.
251259

252260
## Maintaining Linked Audiences
253261

0 commit comments

Comments
 (0)