Skip to content

Commit adf3021

Browse files
authored
Merge pull request #7577 from segmentio/develop
Release 25.16.01
2 parents ef309df + 6ce4b1b commit adf3021

File tree

20 files changed

+80
-94
lines changed

20 files changed

+80
-94
lines changed

src/_data/catalog/destination_categories.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination categories last updated 2025-04-10
2+
# destination categories last updated 2025-04-16
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

src/_data/catalog/destinations.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2025-04-10
2+
# destination data last updated 2025-04-16
33
items:
44
- id: 637e8d185e2dec264895ea89
55
display_name: 1Flow

src/_data/catalog/destinations_private.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2025-04-10
2+
# destination data last updated 2025-04-16
33
items:
44
- id: 54521fd925e721e32a72eee1
55
display_name: Pardot

src/_data/catalog/source_categories.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# source categories last updated 2025-04-10
2+
# source categories last updated 2025-04-16
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

src/_data/catalog/sources.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# sources last updated 2025-04-10
2+
# sources last updated 2025-04-16
33
items:
44
- id: 8HWbgPTt3k
55
display_name: .NET

src/connections/destinations/catalog/actions-klaviyo/index.md

-4
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,6 @@ Some customers experience 403 errors when sending audience data to Klaviyo throu
107107

108108
To reduce the number of `403` errors that you encounter, enable [IP Allowlisting](/docs/connections/destinations/#ip-allowlisting) for your workspace. For more information the range of IP addresses Klaviyo uses for integration traffic, see Klaviyo's [How to allowlist Klaviyo integration traffic IP addresses](https://help.klaviyo.com/hc/en-us/articles/19143781289115){:target="_blank”} documentation.
109109

110-
#### Can I send Engage Audiences to a pre-created Klaviyo List?
111-
112-
No. Engage audiences are designed to initiate the creation of new lists in Klaviyo when you use the "Add Profile to List - Engage" mapping. You cannot link Engage lists to existing Klaviyo lists and cannot edit the List ID for Engage audiences.
113-
114110
#### How can I unsuppress a profile when adding it to a list?
115111

116112
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.

src/connections/destinations/catalog/actions-tiktok-audiences/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ By using Segment's TikTok Audiences destination, you can increase traffic and dr
2323

2424
### Prerequisites
2525

26-
Before connecting to the TikTok Audiences destination, you must have a [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account.
26+
Before connecting to the TikTok Audiences destination, you must have a [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account, with either Admin or Operator permissions to create and manage campaigns in TikTok.
27+
28+
For more details on account and access level permissions, refer to [TikTok's documentation](https://ads.tiktok.com/help/article/how-to-assign-asset-level-permissions?lang=en){:target="_blank"}.
2729

2830
### TikTok Audience Segments
2931

src/connections/destinations/catalog/facebook-offline-conversions/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ id: 58ae54dc70a3e552b95415f6
66
---
77
[Facebook Offline Conversions](https://www.facebook.com/business/help/1782327938668950?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} enables offline event tracking, so marketers can run campaigns, upload transaction data, and compare in-store transactions.
88

9+
> info "Offline Conversions API deprecation"
10+
> Meta will [discontinue the Offline Conversions API](https://developers.facebook.com/docs/graph-api/changelog/version17.0#offline-conversions-api){:target="_blank"} in May 2025. As a result, this destination will stop accepting data at that time and will no longer be available for use. To continue sending offline conversion events to Meta, migrate to the [Facebook Conversions API (Actions)](/docs/connections/destinations/catalog/actions-facebook-conversions-api/#purchase) destination, which supports offline event tracking.
11+
912
> info "Customer Information Parameters Requirements"
1013
> As of Facebook Marketing API v13.0+, Facebook began enforcing new requirements for customer information parameters (match keys). To ensure your events don't throw an error, Segment recommends that you review [Facebook’s new requirements](https://developers.facebook.com/docs/graph-api/changelog/version13.0#conversions-api){:target="_blank"}.
1114

src/connections/destinations/catalog/facebook-pixel/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ In addition, Segment sends the following event types as Standard events:
110110
- `Products Searched`, which Segment sends as `Search`
111111
- `Checkout Started`, which Segment sends as `InitiateCheckout`
112112

113-
Facebook requires a currency for `Purchase` events. If you leave it out a currency, Segment will set a default value of `USD`.
113+
Facebook requires a currency for `Purchase` events. If you leave out a currency, Segment will set a default value of `USD`.
114114

115115
You can set custom properties for the events listed above. Use the setting "Standard Events custom properties" to list all the properties you want to send.
116116

@@ -193,7 +193,7 @@ If you're using real estate, travel, or automotive [Dynamic Ads](https://www.fac
193193

194194
For most implementations, Segment recommends leaving these mappings blank. By default, Segment sets `content_type` to "product".
195195

196-
The same mapping can be used to change the `content_id` from the default value (product_id or the sku) to anything specific for Meta Pixel. For more information about required Meta Pixel events, see Meta's [Required Meta Pixel events and parameters for Advantage+ catalog ads](https://www.facebook.com/business/help/606577526529702?id=1205376682832142){:target="_blank”} documentation.
196+
The same mapping can be used to change the `content_ids` from the default value (product_id or the sku) to anything specific for Meta Pixel. For more information about required Meta Pixel events, see Meta's [Required Meta Pixel events and parameters for Advantage+ catalog ads](https://www.facebook.com/business/help/606577526529702?id=1205376682832142){:target="_blank”} documentation.
197197

198198
## Troubleshooting
199199

src/connections/functions/destination-functions.md

+6
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,12 @@ To change which event type the handler listens to, you can rename it to the name
7979
> info ""
8080
> Functions' runtime includes a `fetch()` polyfill using a `node-fetch` package. Check out the [node-fetch documentation](https://www.npmjs.com/package/node-fetch){:target="_blank"} for usage examples.
8181
82+
### Variable scoping
83+
84+
When declaring settings variables, declare them in the function handler rather than globally in your function. This prevents you from leaking the settings values across other function instances.
85+
86+
The handler for destination functions is event-specific. For example, you might have an `onTrack()`or `onIdentify()` function handler.
87+
8288
### Errors and error handling
8389

8490
{% include content/functions/errors-and-error-handling.md %}

src/connections/functions/insert-functions.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,12 @@ To ensure the Destination processes an event payload modified by the function, r
111111
> info ""
112112
> Functions' runtime includes a `fetch()` polyfill using a `node-fetch` package. Check out the [node-fetch documentation](https://www.npmjs.com/package/node-fetch){:target="_blank"} for usage examples.
113113
114+
### Variable scoping
115+
116+
When declaring settings variables, make sure to declare them in the function handler rather than globally in your function. This prevents you leaking the settings values across other function instances.
117+
118+
The handler for insert functions is event-specific, for example, `onTrack()`, `onIdentify()`, and so on.
119+
114120
### Errors and error handling
115121

116122
Segment considers a function's execution successful if it finishes without error. You can `throw` an error to create a failure on purpose. Use these errors to validate event data before processing it to ensure the function works as expected.
@@ -176,8 +182,7 @@ async function onIdentify(event) {
176182
```
177183
If you don't supply a function for an event type, Segment throws an `EventNotSupported` error by default.
178184

179-
180-
You can read more about [error handling](#destination-insert-functions-logs-and-errors) below.
185+
See [errors and error handling](#errors-and-error-handling) for more information on supported error types and how to troubleshoot them.
181186

182187
## Runtime and dependencies
183188

src/connections/reverse-etl/reverse-etl-source-setup-guides/databricks-setup.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,26 @@ At a high level, when you set up Databricks for Reverse ETL, the configured serv
1212
## Required permissions
1313
* Make sure the service principal you use to connect to Segment has permissions to use that warehouse. In the Databricks console go to **SQL warehouses** and select the warehouse you're using. Navigate to **Overview > Permissions** and make sure the service principal you use to connect to Segment has *can use* permissions.
1414

15+
Note the Service Principal UUID from the [User Management Page](https://accounts.cloud.databricks.com/user-management/serviceprincipals/){:target="_blank”} (under Service Principals) for the following SQL operations.
16+
1517
* To grant access to read data from the tables used in the model query, run:
1618

1719
```
18-
GRANT USAGE ON SCHEMA <schema_name> TO `<service principal you are using to connect to Segment>`;
19-
GRANT SELECT, READ_METADATA ON SCHEMA <schema_name> TO `<service principal you are using to connect to Segment>`;
20+
GRANT USAGE ON SCHEMA <schema_name> TO `<service principal ID you are using to connect to Segment>`;
21+
GRANT SELECT, READ_METADATA ON SCHEMA <schema_name> TO `<service principal ID you are using to connect to Segment>`;
2022
```
2123
2224
* To grant Segment access to create a schema to keep track of the running syncs, run:
2325
2426
```
25-
GRANT CREATE on catalog <name of the catalog, usually hive_metastore or main if using unity-catalog> TO `<service principal you are using to connect to Segment>`;
27+
GRANT CREATE on catalog <name of the catalog, usually hive_metastore or main if using unity-catalog> TO `<service principal ID you are using to connect to Segment>`;
2628
```
2729
2830
* If you want to create the schema yourself instead and then give Segment access to it, run:
2931
3032
```
3133
CREATE SCHEMA IF NOT EXISTS __segment_reverse_etl;
32-
GRANT ALL PRIVILEGES ON SCHEMA __segment_reverse_etl TO `<service principal you are using to connect to Segment>`;
34+
GRANT ALL PRIVILEGES ON SCHEMA __segment_reverse_etl TO `<service principal ID you are using to connect to Segment>`;
3335
```
3436
3537
## Set up guide

src/connections/reverse-etl/reverse-etl-source-setup-guides/postgres-setup.md

+9
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ To set up Postgres with Reverse ETL:
3131

3232
-- allows the "segment" user to create new schemas on the specified database. (this is the name you chose when provisioning your cluster)
3333
GRANT CREATE ON DATABASE "<enter database name here>" TO "segment";
34+
35+
-- create Segment schema
36+
CREATE SCHEMA __segment_reverse_etl;
37+
38+
-- Allow user to use the Segment schema
39+
GRANT USAGE ON SCHEMA __segment_reverse_etl TO segment;
40+
41+
-- Grant all privileges on all existing tables in the Segment schema
42+
GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA __segment_reverse_etl TO segment;
3443
```
3544
4. Make sure the user has correct access permissions to the database.
3645
5. Follow the steps listed in the [Add a source](/docs/connections/reverse-etl/setup/#step-1-add-a-source) section to finish adding Postgres as a source.

src/connections/reverse-etl/reverse-etl-source-setup-guides/redshift-setup.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,21 @@ To set up Redshift with Reverse ETL:
1515
2. Follow the [networking instructions](/docs/connections/storage/catalog/redshift/#networking) to configure the correct network and security settings.
1616
3. Run the SQL commands below to create a user named `segment`.
1717

18-
```ts
18+
```sql
1919
-- create a user named "segment" that Segment will use when connecting to your Redshift cluster.
2020
CREATE USER segment PASSWORD '<enter password here>';
2121

2222
-- allows the "segment" user to create new schemas on the specified database. (this is the name you chose when provisioning your cluster)
2323
GRANT CREATE ON DATABASE "<enter database name here>" TO "segment";
24+
25+
-- create Segment schema
26+
CREATE SCHEMA __segment_reverse_etl;
27+
28+
-- Allow user to use the Segment schema
29+
GRANT USAGE ON SCHEMA __segment_reverse_etl TO segment;
30+
31+
-- Grant all privileges on all current tables in the Segment schema
32+
GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA __segment_reverse_etl TO segment;
2433
```
2534
4. Follow the steps listed in the [Add a source](/docs/connections/reverse-etl/setup/#step-1-add-a-source) section to finish adding Redshift as your source.
2635

src/connections/reverse-etl/reverse-etl-source-setup-guides/snowflake-setup.md

+1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ Follow the instructions below to set up the Segment Snowflake connector. Segment
5555
-- database access
5656
GRANT USAGE ON DATABASE segment_reverse_etl TO ROLE segment_reverse_etl;
5757
GRANT CREATE SCHEMA ON DATABASE segment_reverse_etl TO ROLE segment_reverse_etl;
58+
GRANT CREATE TABLE ON SCHEMA __segment_reverse_etl TO ROLE segment_reverse_etl;
5859
```
5960
6. Enter and run one of the following code snippets below to create the user Segment uses to run queries. For added security, Segment recommends creating a user that authenticates using a key pair.
6061

src/engage/index.md

+2-49
Original file line numberDiff line numberDiff line change
@@ -22,56 +22,9 @@ Add detail to user profiles with new traits and use them to power personalized m
2222
- [**Predictions**:](/docs/unify/traits/predictions/) Predict the likelihood that users will perform custom events tracked in Segment, like LTV, churn, and purchase.
2323

2424
#### Build Audiences
25-
Create lists of users or accounts that match specific criteria. For example, after creating an `inactive accounts` audience that lists paid accounts with no logins in 60 days, you can push the audience to your analytics tools or send an SMS, email, or WhatsApp campaign with Engage Channels. Learn more about [Engage audiences](/docs/engage/audiences/).
25+
Create lists of users or accounts that match specific criteria. For example, after creating an `inactive accounts` audience that lists paid accounts with no logins in 60 days, you can push the audience to your analytics tools or send an SMS, email, or WhatsApp campaign with Engage Channels. Learn more about [Engage audiences](/docs/engage/audiences/).
2626

2727
#### Sync audiences to downstream tools
2828
Once you create your Computed Traits and Audiences, Engage sends them to your Segment Destinations in just a few clicks. You can use these Traits and Audiences to personalize messages across channels, optimize ad spend, and improve targeting. You can also use the [Profile API](/docs/unify/profile-api) to build in-app and onsite personalization. Learn more about [using Engage data](/docs/engage/using-engage-data/) and the [Profile API](/docs/unify/profile-api).
2929

30-
{% include components/reference-button.html href="https://segment.com/customers/drift/" icon="personas.svg" title="Personalizing marketing campaigns" description="Marketing teams use Engage to run real-time multi-channel marketing campaigns based off specific user attributes they've computed in Engage. Read about how Drift used Engage to increase prospect engagement by 150% in two months." %}
31-
32-
## Market to customers with Engage Premier and Channels
33-
34-
To send email, SMS, and WhatsApp campaigns with Engage Channels, you'll connect a [Twilio messaging service](https://support.twilio.com/hc/en-us/articles/223181308-Getting-started-with-Messaging-Services){:target="blank"}, [SendGrid subuser account](https://docs.sendgrid.com/ui/account-and-settings/subusers#create-a-subuser){:target="blank"}, and [WhatsApp messaging service](https://www.twilio.com/docs/whatsapp/self-sign-up){:target="blank"} to your Segment Engage space. Use existing accounts, or create new ones.
35-
36-
View the [onboarding steps](/docs/engage/onboarding/) for more on how to connect Twilio and SendGrid accounts.
37-
38-
#### Send email, SMS, and WhatsApp messages in Journeys
39-
40-
Use Engage to build email, SMS, and WhatsApp campaigns within [Journeys](/docs/engage/journeys/). Send campaigns to [subscribed users](#user-subscriptions) based on event behavior and profile traits. With [message analytics](#message-analytics), you can track the performance of your campaigns.
41-
42-
- **Send Email**: [Build email campaigns](/docs/engage/campaigns/email-campaigns/) with existing templates, or create a new email template within Journeys. Before you send the email, test the template and set [conversion goals](#conversion-goals).
43-
44-
- **Send SMS messages**: [Build SMS campaigns](/docs/engage/campaigns/sms-campaigns/) to message users in real-time as a step in a Journey. For example, create an abandoned cart campaign that texts users a reminder to complete their purchase, along with a promo code. Add [merge tags](#personalize-with-merge-tags) and set conversion goals.
45-
46-
- **Send WhatsApp messages**: [Build WhatsApp campaigns](/docs/engage/campaigns/whatsapp-campaigns) that deliver messages to your customers on the world's most used messaging app.
47-
48-
To learn more, visit the [CSV Uploader](/docs/engage/profiles/csv-upload/) documentation.
49-
50-
#### Build Email, SMS, and WhatsApp message templates
51-
52-
Build personalized [email](/docs/engage/content/email/template/), [SMS](/docs/engage/content/sms/template), and [WhatsApp](/docs/engage/content/whatsapp) templates in Twilio Engage for use in your campaigns. Design email templates with a WYSIWYG [Drag and Drop Editor](/docs/engage/content/email/editor/) or the [HTML Editor](/docs/engage/content/email/html-editor/). Engage saves the templates for you to preview, edit, and reuse throughout Journeys.
53-
54-
#### Personalize with merge tags
55-
Insert real-time user profile traits from merge tags to personalize each message. For example, address recipients by name or highlight new products from a user's favorite brand.
56-
57-
#### CSV Uploader
58-
Use the CSV uploader to add or update user profiles and [subscription states](/docs/engage/user-subscriptions/). To learn more, visit the [CSV Uploader](/docs/engage/profiles/csv-upload/) documentation.
59-
60-
#### User subscriptions
61-
62-
Set user subscription states in two ways:
63-
- [Upload a CSV file](/docs/engage/profiles/csv-upload/) with lists of users along with their phone, email, and WhatsApp subscription states.
64-
- Programmatically with Segment's [Public API](https://api.segmentapis.com/docs/spaces/#replace-messaging-subscriptions-in-spaces){:target="blank"}
65-
66-
Use Engage to add subscription states to user email addresses and phone numbers. Subscription states help determine which users you can send campaigns to in Engage. You can set user subscription states with a [CSV file upload](/docs/engage/profiles/csv-upload/), or programmatically with Segment's [Public API](https://api.segmentapis.com/docs/spaces/#replace-messaging-subscriptions-in-spaces){:target="blank"}.
67-
68-
#### Message Analytics
69-
With analytics in Engage, you can monitor real-time conversion data. Track message performance and customer interaction beyond clicks and opens. Use campaign dashboards to view events such as `Email Delivered`, `Unsubscribed`, `Spam Reported`, and more.
70-
71-
#### Conversion Goals
72-
73-
For each message step in a Journey, you can set conversion conditions with events and properties in your Segment space. Then, define a duration after message delivery to track goals.
74-
75-
For example, track users who perform the event **Order Completed** with a promo code that you send them.
76-
77-
Visit [Message Analytics](/docs/engage/analytics/) to learn more.
30+
{% include components/reference-button.html href="https://segment.com/customers/drift/" icon="personas.svg" title="Personalizing marketing campaigns" description="Marketing teams use Engage to run real-time multi-channel marketing campaigns based off specific user attributes they've computed in Engage. Read about how Drift used Engage to increase prospect engagement by 150% in two months." %}

0 commit comments

Comments
 (0)