Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
4eb4e9f
Update index.md
courtneyga Apr 3, 2024
87bd1e1
Add warning that OAuth must be done by workspace owner
ashton-huxtable May 1, 2024
c3295a8
Update template.md - email templates & journey steps using them, beha…
samkcrespo May 31, 2024
6ac32c3
Enabling batch for Klaviyo(Actions) destination
Panandhan22 Jul 31, 2024
da2b0a8
missing period in the first sentence
forstisabella Nov 22, 2024
0b6f0f0
Merge pull request #7253 from segmentio/add-missing-period
forstisabella Nov 22, 2024
1a53c6e
info on new error message
spencerattick Nov 22, 2024
bc57012
remove currently
pwseg Nov 24, 2024
06a4edf
Update custom-proxy.md
jfoskin Nov 25, 2024
3ec03d7
PII fuzzy matching FAQ
pwseg Nov 26, 2024
dd2b228
plans don't access anything, people do
pwseg Nov 26, 2024
b114207
source-level data blocking
pwseg Nov 26, 2024
ba84b86
deletion requests FAQ
pwseg Nov 26, 2024
fd60c33
regulation types cleanup
pwseg Nov 26, 2024
22f8ea9
rewording
pwseg Nov 26, 2024
86379e0
Merge pull request #7255 from segmentio/spencerattick-patch-5
pwseg Nov 26, 2024
9319a86
update Segment support contact
pwseg Nov 26, 2024
95042ab
remove currently and reword FAQ
pwseg Nov 26, 2024
891d8d1
Merge branch 'develop' into Panandhan22-patch-11
pwseg Nov 26, 2024
f9f779c
Merge pull request #6877 from segmentio/Panandhan22-patch-11
pwseg Nov 26, 2024
148a5b7
Document GET limit for HubSpot
spencerattick Nov 26, 2024
dbc7ea7
Update custom-proxy.md
stayseesong Nov 26, 2024
23651e3
Merge pull request #7263 from segmentio/jfoskin-patch-13
stayseesong Nov 26, 2024
29e225c
Apply suggestions from code review
stayseesong Nov 26, 2024
6558a04
Merge pull request #6346 from segmentio/courtneyga-patch-31
stayseesong Nov 26, 2024
5dfd7d2
Merge pull request #7265 from segmentio/privacy-faq-style-fixes
pwseg Nov 26, 2024
98bf8d9
Add HIPAA ineligibility to callout
pwseg Nov 26, 2024
d26b0c9
Merge pull request #7267 from segmentio/event-triggered-journeys-hipa…
pwseg Nov 26, 2024
265a3c9
add computed traits link
pwseg Nov 26, 2024
1913b86
in concert is too weird
pwseg Nov 26, 2024
661ec03
make Audiences bullet like others
pwseg Nov 26, 2024
d821972
simplify language
pwseg Nov 26, 2024
6c9899b
clarify AUC range
pwseg Nov 26, 2024
35674b4
replace you with Segment
pwseg Nov 26, 2024
4bd9edd
add new model monitoring section
pwseg Nov 26, 2024
3c64697
more model monitoring info
pwseg Nov 26, 2024
43adbd4
add screenshot [netlify-build]
pwseg Nov 26, 2024
fa9dde2
catalog update 26 november 2024
pwseg Nov 26, 2024
b319c01
Merge pull request #7268 from segmentio/predictions-model-monitoring
pwseg Nov 26, 2024
a0decab
Merge pull request #7269 from segmentio/catalog_update_26_nov_24
pwseg Nov 26, 2024
51c0699
rewording
pwseg Nov 26, 2024
004c9e6
Merge pull request #7266 from segmentio/spencerattick-patch-5
pwseg Nov 26, 2024
cd5365d
update faq phrasing and answer
pwseg Nov 26, 2024
27fa5bb
Merge pull request #6640 from segmentio/samkcrespo-patch-20-1
pwseg Nov 26, 2024
2c1e989
update warning language
pwseg Nov 26, 2024
ea6a01f
Merge pull request #6474 from segmentio/ashton-huxtable-patch-2
pwseg Nov 26, 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
2 changes: 1 addition & 1 deletion src/_data/catalog/destination_categories.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination categories last updated 2024-11-21
# destination categories last updated 2024-11-26
items:
- display_name: A/B Testing
slug: a-b-testing
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/destinations.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination data last updated 2024-11-21
# destination data last updated 2024-11-26
items:
- id: 637e8d185e2dec264895ea89
display_name: 1Flow
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/destinations_private.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination data last updated 2024-11-21
# destination data last updated 2024-11-26
items:
- id: 54521fd925e721e32a72eee1
display_name: Pardot
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/source_categories.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# source categories last updated 2024-11-21
# source categories last updated 2024-11-26
items:
- display_name: A/B Testing
slug: a-b-testing
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/sources.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# sources last updated 2024-11-21
# sources last updated 2024-11-26
items:
- id: 8HWbgPTt3k
display_name: .NET
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,10 @@ No. Engage audiences are designed to initiate the creation of new lists in Klavi

When adding a user to a list, our action make use of the [Bulk Profile Import](https://developers.klaviyo.com/en/reference/spawn_bulk_profile_import_job){:target="_blank”} endpoint (when batching is enabled), and the [Add Profile To List](https://developers.klaviyo.com/en/reference/create_list_relationships){:target="_blank”} endpoint for non-batched requests. Both of which will not update a users suppression status if they were previously suppressed.

To ensure a suppressed profile gets unsuppressed, you can use the "Subscribe Profile" action. When a profile is subscribed in Klaviyo, it automatically unsuppresses any previously suppressed user. You can combine this action with other actions to achieve your goal. If this solution does not fully address your use case, please contact us at [email protected] so we can consider your specific requirements.
To unsuppress a previously suppressed profile in Klaviyo, use the **Subscribe Profile** action. This action automatically removes the suppression status for the user when they are subscribed. You can also pair this action with other mappings to suit your workflow.

If this approach doesn't address your use case, [reach out to Segment](mailto:[email protected]) to discuss your specific requirements.

### Can batching be enabled for the entire Klaviyo (Actions) destination?

Batching is only available for events sent through the Upsert Profile action mapping. Other actions in the Klaviyo (Actions) destination don't support batching.
8 changes: 8 additions & 0 deletions src/connections/destinations/catalog/hubspot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,14 @@ HubSpot Plan: API Add-On (Any Tier)
* Maximum Number of API Calls per 10 Seconds, per Key or Token: **120**
* Maximum Number of API Calls per Day, per Key or Token: **1,000,000**

### Maximum data size returned from HubSpot

When Segment pulls contact or company fields from HubSpot, there is a 1MB limit on the size of the data Segment allows to return from HubSpot’s platform. If this limit is exceeded, the request and response process stops, and the event you tried to send to HubSpot won't be delivered.

To avoid this issue:
- **Maintain clean and concise datasets**: Regularly review and remove unused or redundant fields.
- **Minimize returned traits**: Verify that only the fields essential for to your workflow are included in the data retrieved from HubSpot.
By keeping your datasets streamlined, you improve data hygiene and reduce the risk of exceeding Segment's data size limit for processing.

### Sending Dates as Property Values

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ This destination is maintained by Impact. For any issues with the destination, c
4. Go to the [Impact Partnership Cloud Settings](https://app.impact.com){:target="_blank"}, find and copy the "Account SID", "Auth Token", and "Campaign ID".
5. Back in the Impact Partnership Cloud destination settings in Segment, enter the "Account SID", "Auth Token", and "Campaign ID".

> warning "Workspace owner required for OAuth setup"
> Only a Segment workspace owner can enable OAuth between Impact and Segment. If you run into during setup, check your workspace settings to verify you have the required permissions.

## Page

If you aren't familiar with the Segment Spec, take a look at the [Page method documentation](/docs/connections/spec/page/) to learn about what it does. An example call would look like:
Expand Down
6 changes: 6 additions & 0 deletions src/connections/destinations/catalog/iterable/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@ Iterable supports sending push notification events to Segment. These events are
They support the following events:
`Push Delivered`, `Push Bounced`, `Mobile App Uninstalled`, `Push Opened`

## High retry rate

If you're experiencing a large amount of retries within your destinations that are connected to your HTTP API source, this could be due to Etimedout errors. Etimedout errors are intermittent problems that can come about when HTTP requests are made from server to server.

The Etimedout error is the result of an HTTP response not being received in a specific timeframe. [Learn more](/docs/connections/destinations/#retries-between-segment-and-destinations) about how Segment retries events to destinations.


## Using Iterable with Engage

Expand Down
6 changes: 6 additions & 0 deletions src/connections/functions/source-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -438,3 +438,9 @@ The test function interface has a 4KB console logging limit. Outputs surpassing
#### Can I send a custom response from my Source Function to an external tool?

No, Source Functions can't send custom responses to the tool that triggered the Function's webhook. Source Functions can only send a success or failure response, not a custom one.

#### Why am I seeing the error "Functions are unable to send data or events back to their originating source" when trying to save my Source Function?

This error occurs because Segment prevents Source Functions from sending data back to their own webhook endpoint (`https://fn.segmentapis.com`). Allowing this could create an infinite loop where the function continuously triggers itself.

To resolve this error, check your Function code and ensure the URL `https://fn.segmentapis.com` is not included. This URL is used to send data to a Source Function and shouldn't appear in your outgoing requests. Once you remove this URL from your code, you’ll be able to save the Function successfully.
Original file line number Diff line number Diff line change
Expand Up @@ -161,13 +161,12 @@ To add a CNAME record for the Segment proxy to your organizations DNS settings:

### Tracking API Proxy

Set up a proxy for the tracking API so that all calls proxy through your domain. To do this, set up a CloudFront distribution that's similar to the one in the previous section, with the exception of the Origin Domain Name:
As events travel through the proxy before reaching the tracking API, set up a proxy for the tracking API so that all calls proxy through your domain. To do this, set up a CloudFront distribution that's similar to the one in the previous section, with the exception of the Origin Domain Name:

| Field | Value | Description |
| ------------------ | ---------------- | -------------------------------------------- |
| Origin Domain Name | `api.segment.io` | The domain name to which the proxy is served |


#### Add CNAME Record to DNS

To add a CNAME record to your DNS settings:
Expand Down
7 changes: 6 additions & 1 deletion src/engage/content/email/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,9 @@ Segment doesn't support profile traits in object and array datatypes in [Broadca
- View some [email deliverability tips and tricks](https://docs.sendgrid.com/ui/sending-email/deliverability){:target="blank"} from SendGrid.

- You can also use the Templates screen in Engage to [build SMS templates](/docs/engage/content/sms/template/).


## FAQs

### Do updates to an email template automatically apply to Journey steps using it?

When you add a template to a Journey step, it becomes a copy specific to that step. Changes made to the original template won’t update the Journey version, and edits made in the Journey step won’t affect the original template. This keeps your Journey changes separate while preserving the original for reuse.
2 changes: 1 addition & 1 deletion src/engage/journeys/event-triggered-journeys.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Unlike traditional audience-based journeys that rely on pre-defined user segment
On this page, you'll learn how to create an event-triggered journey, configure entry conditions, and work with published event-triggered journeys.

> info "Private Beta"
> Event-Triggered Journeys is in private beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
> Event-Triggered Journeys is in private beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. During private beta, Event-Triggered Journeys is not HIPAA eligible.

## Overview

Expand Down
61 changes: 29 additions & 32 deletions src/privacy/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,49 +2,45 @@
title: Privacy Frequently Asked Questions
---

## Privacy Portal Questions
## Privacy Portal questions

### Why aren't fields from my Cloud Object Sources (such as Salesforce and Zendesk) showing up in the Privacy Portal Inbox and Inventory?
### Why aren't fields from my Cloud Object Sources (like Salesforce and Zendesk) showing up in the Privacy Portal Inbox and Inventory?

We do not currently support Cloud Object Sources in the Privacy Portal, but it's on our roadmap. Stay tuned for new features in the future.
The Privacy Portal doesn't doesn't support fields from Cloud Object Sources like Salesforce or Zendesk.

### Why is Segment suggesting my fields should be classified as Yellow or Red?
### Why does Segment suggest classifying my fields as Yellow or Red?

You can see a full list of the fields we exact-match and fuzzy-match against [by default](/docs/privacy/portal/#default-pii-matchers). These classifications are our best-guess suggestions, and you can easily change them by following the instructions to [change a recommended classification](/docs/privacy/portal/#change-a-recommended-classification).
Segment provides suggested classifications based on [default PII matchers](/docs/privacy/portal/#default-pii-matchers). These suggestions include exact and fuzzy matches for potential PII. You can update these classifications by following the instructions to [change a recommended classification](/docs/privacy/portal/#change-a-recommended-classification).

### Who can access the Privacy Portal?

Only Workspace Owners can access the portal.

### Which Segment plan types get access to the Privacy Portal?
### Which Segment plan types include access to the Privacy Portal?

All Segment plans have access to the Privacy Portal, because we believe data
privacy should be a right, not an add-on.
All Segment plans include access to the Privacy Portal. Data privacy is a fundamental Segment feature, not an add-on.

### If I block data at the Source level, can I reverse it or get that data back using Segment's Data Replay feature?
### If I block data at the source level, can I reverse it or recover the data using Segment's Data Replay feature?

If you use Privacy Controls to block data at the Source level, the data never
enters Segment, and we cannot Replay that data for you. We recommend caution
when blocking data at the Source level.
When you block data at the source level using Privacy Controls, the data never enters Segment. As a result, Segment can't replay the data. Segment recommends exercising caution when blocking data at the source level.

### The Privacy Portal classified my property as `Yellow`, but it's required for some of my destinations to function. What should I do?
### The Privacy Portal classified my property as Yellow, but my destinations require it to function. What should I do?

Segment classifications are simply recommendations. If an integration you rely
on requires a field that we recommend be classified as Yellow, you can override
the recommended setting to send that field downstream.
Segment classifications are recommendations. If a destination requires a field classified as Yellow, you can override the recommended classification to ensure the field gets sent downstream.

## User Deletion and Suppression Questions
## User deletion and suppression questions

### How can I find my user's userId?
### How can I find a specific `userId`?

The easiest way to find a customer's `userId` is by querying an existing tool. Specifically, you can use your Segment [data warehouse](https://segment.com/warehouses) to query the `users` table for another known item of information about the user (their email address, for example) and then use that row to find their userId.
To locate a specific `userId`, query your Segment [data warehouse](https://segment.com/warehouses){:target="_blank”} for the `users` table. Use other known details about the user, like their email address, to identify the correct row and retrieve the `userId`.

### How many deletion requests can I send?
You can send us batches of up to 5,000 `userIds`, or 4 MB, per payload. We process these batches asynchronously. [Contact Segment](https://segment.com/help/contact/){:target="_blank”} if you need to process more than 110,000 users within a 30 day period.

### Which Destinations can I send deletion requests to?
You can send batches of up to 5,000 `userIds`, or 4 MB, per payload. Segment processes these batches asynchronously. [Contact Segment](https://segment.com/help/contact/){:target="_blank”} if you need to process more than 110,000 users within a 30-day period.

In addition to your Raw Data destinations (Amazon S3 and Data Warehouses), we can forward requests to the following streaming destinations:
### Which destinations can I send deletion requests to?

In addition to your Raw Data destinations (Amazon S3 and data warehouses), Segment can forward requests to the following streaming destinations:

- Amplitude
- Iterable
Expand All @@ -60,25 +56,26 @@ In addition to your Raw Data destinations (Amazon S3 and Data Warehouses), we ca
- Google Cloud PubSub
- Friendbuy (Cloud Destination)

Segment cannot guarantee that data is deleted from your Destinations. When you issue a user deletion request, Segment forwards the request to supported streaming Destinations. You must still contact these Destinations to confirm that they've executed the request.
Segment forwards deletion requests but cannot guarantee that data is deleted from downstream destinations. You must contact these destinations to confirm that they executed the request.

### Which destinations require additional destination setting configuration?
### Which destinations require additional configuration to process deletion requests?

#### Amplitude
If you have the Amplitude destination enabled in one or more sources, you must include Amplitude's secret key in each destination(s) settings so they can accept the deletion request. (You add it in the Amplitude destination settings, under "Secret Key"). You can find your Secret Key on the [General Settings](https://help.amplitude.com/hc/en-us/articles/235649848-Settings) of your Amplitude project.
To process deletion requests in Amplitude, add your Amplitude secret key to the destination settings under "Secret Key." You can find this key in your Amplitude project's [General Settings](https://help.amplitude.com/hc/en-us/articles/235649848-Settings){:target="_blank”}.


#### Google Analytics
To send user deletion requests to Google Analytics you must authenticate your Google Analytics account with Segment using OAuth. If you have the Google Analytics destination enabled in one or more sources, you must authenticate your account in each destination(s) settings. Navigate to the **User Deletion** settings in your Segment Google Analytics settings and use your email and password to authenticate your account.
To send deletion requests to Google Analytics, authenticate your account with Segment using OAuth. Go to the **User Deletion** settings in your Segment Google Analytics destination and use your email and password to complete authentication.


### What regulation types does Segment support?

Segment supports the following regulation types:
- **SUPPRESS_ONLY**: Suppress new data based on the `userId` without deleting existing data stored in your workspace and in downstream destinations.
- **UNSUPPRESS**: Stop the ongoing suppression of a `userId`.
- **SUPPRESS_WITH_DELETE**: Suppress new data based on the `userId` and also delete all existing data for that ID from your workspace and our internal archives. While Segment forwards the deletion request to your downstream destinations, Segment cannot guarantee deletion in your third-party tools.
- **DELETE_INTERNAL**: Deletes user data from within Segment archives only and not from any connected destinations.
- **SUPPRESS_ONLY**: Suppresses new data for a `userId` without deleting existing data in your workspace or downstream destinations.
- **UNSUPPRESS**: Stops ongoing suppression of a `userId`.
- **SUPPRESS_WITH_DELETE**: Suppresses new data for a `userId` and deletes all existing data for that ID in your workspace and Segment's internal archives. Segment forwards the deletion request to downstream destinations but can't guarantee deletion in third-party tools.
- **DELETE_INTERNAL**: Deletes user data only from Segment archives, without affecting downstream destinations.
- **DELETE_ONLY**: Deletes user data from Segment and your connected warehouses. Also sends a deletion request to your downstream destinations.


> info ""
> Using **SUPPRESS_WITH_DELETE** or **DELETE_ONLY** regulation types might lead to additional charges levied by your destination providers.
> Using **SUPPRESS_WITH_DELETE** or **DELETE_ONLY** regulation types might lead to additional charges levied by your destination providers.
Loading
Loading