diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index 3103ad53f9..3b6931cbdc 100644 --- a/src/_data/catalog/destination_categories.yml +++ b/src/_data/catalog/destination_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination categories last updated 2024-11-05 +# destination categories last updated 2024-11-07 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index 874fe520e8..0993a8143c 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination data last updated 2024-11-05 +# destination data last updated 2024-11-07 items: - id: 637e8d185e2dec264895ea89 display_name: 1Flow @@ -18340,7 +18340,7 @@ items: slug: actions-attio hidden: false endpoints: - - US + - EU regions: - us-west-2 - eu-west-1 diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index 89bb865849..c9831057c6 100644 --- a/src/_data/catalog/source_categories.yml +++ b/src/_data/catalog/source_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# source categories last updated 2024-11-05 +# source categories last updated 2024-11-07 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index b369b05898..fde7054b35 100644 --- a/src/_data/catalog/sources.yml +++ b/src/_data/catalog/sources.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# sources last updated 2024-11-05 +# sources last updated 2024-11-07 items: - id: 8HWbgPTt3k display_name: .NET diff --git a/src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md b/src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md index 85f56197ae..5fbf9c529f 100644 --- a/src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md +++ b/src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md @@ -26,6 +26,7 @@ This destination sends audiences, or lists of users, from your data warehouse to ### Prerequisites - A Reverse ETL source already set up. If you don't yet have a Reverse ETL source, follow the instructions in Segment's [Reverse ETL documentation](/docs/connections/reverse-etl/#getting-started). Segment recommends setting an [External ID](#sync-audience) as the primary key for your Reverse ETL model, as you'll need an External ID to remove users from your custom audiences. - A Facebook account with [ads_management](https://developers.facebook.com/docs/permissions#ads_management){:target="_blank”} permissions for the target Facebook Ad Account(s). The Facebook Ad Account(s) must also be associated with a [Facebook Business Account](https://www.facebook.com/business/help/407323696966570?id=649869995454285){:target="_blank”}. +- Ensure that the user connecting to the destination using OAuth has at least an *Advertiser* or *Admin* role on the ad account. To manage permissions and roles for an ad account, reference [Facebook's documentation](https://www.facebook.com/business/help/186007118118684?id=829106167281625){:target="_blank"}. ### Connect to Facebook Custom Audiences 1. From your Segment app, navigate to **Catalog > Destinations** and search for "Facebook Custom Audiences (Actions)". diff --git a/src/engage/audiences/linked-audiences-limits.md b/src/engage/audiences/linked-audiences-limits.md index 61d35a2dc0..fa8e777feb 100644 --- a/src/engage/audiences/linked-audiences-limits.md +++ b/src/engage/audiences/linked-audiences-limits.md @@ -36,6 +36,6 @@ Event Size | 32 KB | Segment doesn’t emit messages for profiles whose total re Data Graph depth | 6 | You can't save a Data Graph if you exceed the limit. Preview size | 3K rows | The maximum number of rows you can have to generate a preview. The preview fails if you bring back too many entities. Entity value type ahead cache | Up to 100 unique values | The maximum number of entity values Segment stores in cache. -Entity columns | Up to 200 unique values | The maximum number of entity property columns Segment surfaces in the condition builder. -Run frequency | 15 minutes (this is the fastest time) | You can’t configure more frequency syncs. You can select **Compute Now** to trigger runs, but you’re limited by Profiles Sync for when new data syncs back to the data warehouse. +Entity columns | Up to 1000 unique values | The maximum number of entity property columns Segment surfaces in the condition builder. +Run frequency | 15 minutes (this is the fastest time) | You can’t configure more frequency syncs. You can select **Run Now** to trigger runs, but you’re limited by Profiles Sync for when new data syncs back to the data warehouse. diff --git a/src/segment-app/extensions/dbt.md b/src/segment-app/extensions/dbt.md index 547bcdcfc4..2b811103de 100644 --- a/src/segment-app/extensions/dbt.md +++ b/src/segment-app/extensions/dbt.md @@ -69,3 +69,44 @@ After you've successfully set up dbt with a warehouse and connected to your Git 6. Enter your **Model Name**, then click **Create Model**. To change a connected model, ensure that you've removed it from all active Reverse ETL syncs. + +## Git Connections + +Git Connections enable Segment to sync data with your preferred Git repository through supported like SSH and token-based authentication. + +> info "" +> Git Sync and the dbt integration operate independently. You don’t need to set up Git Sync to use dbt, and dbt Cloud can trigger its own syncs without relying on Git Sync. + +### Supported connection types + +Segment supports the following credential types for setting up a Git Connection: + +- **SSH**: Compatible with GitHub, GitLab, and Bitbucket, SSH provides a secure method for connecting to your repository. +- **Git token**: Git tokens are supported across GitHub, GitLab, and Bitbucket, enabling token-based authentication for added flexibility. +- **GitHub App**: For GitHub users, GitHub App integrations offer enhanced security and functionality. This method is exclusive to GitHub and supports additional features, like [CI checks](#setting-up-ci-checks). + +### Reusing Git Connections + +Segment lets you set up multiple Git Connections, allowing you to reuse credentials across both dbt and Git Sync. You can either use the same credential for multiple configurations or create separate Git Connections for each product and environment as needed. + +If you plan to reuse a Git token across both dbt and Git Sync, ensure it has the necessary read and write permissions for both integrations. + +## Setting Up CI checks + +> info "CI check availability" +> CI checks are available only with the GitHub App connection. + +CI checks in Segment help prevent breaking changes to active dbt models. Avoid changing dbt models currently in use with an active Reverse ETL sync, since changes could disrupt existing mappings and active syncs. + +When CI checks are enabled, Segment monitors model changes in your Git repository. If a model already linked to an active Reverse ETL sync gets modified, Segment automatically rejects the change to maintain data integrity. + +To enable CI Checks, authorize a GitHub App credential for your Git connection. Once connected, you can enable CI Checks in the dbt model sync configuration section. + +## Troubleshooting dbt Extensions + +The following table lists common dbt Extension errors, as well as their solutions: + +| Error | Error message | Solution | +| ----------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Failed sync | `Sync Failed: Incorrect dbt Project File Path: dbt project file not found` | Verify that the path to your `dbt_project.yml` file is relative to the repository root, excluding the root branch.
For example, use `project/dbt_project.yml` instead of `main/project/dbt_project.yml`. | +| Failed sync | `Sync Failed: remote: Write access to repository not granted` | Verify that the account associated with the token has a write role in the repository settings. Fine-grained tokens may require specific roles, depending on your Git provider. | \ No newline at end of file diff --git a/src/segment-app/extensions/git.md b/src/segment-app/extensions/git.md index 7a2f920a7f..04b87ed6c9 100644 --- a/src/segment-app/extensions/git.md +++ b/src/segment-app/extensions/git.md @@ -23,7 +23,7 @@ The Git sync extension syncs the following resources from Segment to your Git re - [Sources](/docs/connections/sources/) and [Destinations](/docs/connections/destinations/) - [Warehouses](/docs/connections/storage/warehouses/) -- [Destination Filters and Mappings](/docs/connections/destinations/destination-filters/) +- [Destination Filters and Mappings](/docs/connections/destinations/destination-filters/) for Connections - [Tracking Plans](/docs/protocols/tracking-plan/create/) - [Functions](/docs/connections/functions/) - [Transformations](/docs/protocols/transform/) @@ -31,6 +31,13 @@ The Git sync extension syncs the following resources from Segment to your Git re - [Users](/docs/segment-app/iam/concepts/#team-members) and [User groups](/docs/segment-app/iam/concepts/#user-groups) - [Labels](/docs/segment-app/iam/labels/#where-can-i-create-labels) +The Git sync extension doesn't support the following resources: + +- [Spaces](/docs/segment-app/workspace-home/) +- [Audiences](/docs/engage/audiences/) and [Journeys](/docs/engage/journeys/) +- [Data Graph](/docs/unify/data-graph/) +- Mappings for [Linked Audiences](/docs/engage/audiences/linked-audiences/) + Reach out to [Segment support](https://app.segment.com/workspaces?contact=1){:target="blank"} to request support for additional Git Sync resources. After you set up the Git sync extension for the first time, Segment performs an initial sync that sends the current state of your Segment workspace to the Git repository you connected. Segment automatically tracks all following workspace updates. @@ -49,7 +56,7 @@ Using HCL makes it easier to document Segment's data model, especially for users Segment supports one-way synchronization from Segment to Git, but you can set up two-way synchronization using the Segment Terraform provider. -Terraform offers an open-source way to manage Segment resources through a Git repository as an alternative to a fully managed two-way sync. However, this method requires third-party tools like [Atlantis](https://www.runatlantis.io/){:target="_blank"} for CI integration, which Segment doesn’t officially support. +Terraform offers an open-source way to manage Segment resources through a Git repository as an alternative to a fully managed two-way sync. This method requires third-party tools like [Atlantis](https://www.runatlantis.io/){:target="_blank"} for CI integration. To manage Segment resources using Git and Terraform, follow these steps: @@ -76,3 +83,34 @@ To manage Segment resources using Git and Terraform, follow these steps: For more information on using Terraform, visit [Terraform's documentation](https://developer.hashicorp.com/terraform/docs){:target="_blank"}. + +## Git Connections + +Git Connections enable Segment to sync data with your preferred Git repository through supported like SSH and token-based authentication. + +> info "" +> Git Sync and the dbt integration operate independently. You don’t need to set up Git Sync to use dbt, and dbt Cloud can trigger its own syncs without relying on Git Sync. + +### Supported connection types + +Segment supports the following credential types for setting up a Git Connection: + +- **SSH**: Compatible with GitHub, GitLab, and Bitbucket, SSH provides a secure method for connecting to your repository. +- **Git token**: Git tokens are also supported across GitHub, GitLab, and Bitbucket, enabling token-based authentication.. +- **GitHub App**: For GitHub users, GitHub App integrations offer enhanced security and functionality. This method is exclusive to GitHub and supports additional features, like CI checks. + +### Reusing Git Connections + +Segment lets you set up multiple Git Connections, allowing you to reuse credentials across both dbt and Git Sync. You can either use the same credential for multiple configurations or create separate Git Connections for each product and environment as needed. + +If you plan to reuse a Git token across both dbt and Git Sync, ensure it has the necessary read and write permissions for both integrations. + +## Troubleshooting Git Sync + +When setting up Git Sync, you may run into an access error with the following message: `“Unable to create Git Sync due to Git connection issues. Please check your configuration and try again`. + +This error can occur if there are issues with your Git connection settings or permissions. To resolve the error, verify that: + +- Your credentials have write access to the Git repository, as Segment requires this to sync changes. +- Your repository is hosted by GitHub, GitLab, or Bitbucket (Segment doesn't support self-hosted repositories). +- Branch protections are disabled on the repository. diff --git a/src/unify/data-graph/index.md b/src/unify/data-graph/index.md index f58c23ab3d..8cf518a981 100644 --- a/src/unify/data-graph/index.md +++ b/src/unify/data-graph/index.md @@ -414,4 +414,17 @@ Upon editing and saving changes to your Data Graph, a modal will pop up to warn ### Detect warehouse breaking changes -Segment has a service that regularly scans and monitors the Data Graph for changes that occur in your warehouse that may break components of the Data Graph, such as when the table being referenced by the Data Graph gets deleted from your warehouse or when the primary key column no longer exists. An alert banner will be displayed on the Data Graph landing page. The banner will be removed once the issues are resolved in your warehouse and/or the Data Graph. You will also have the option to trigger a manual sync of your warehouse schema. +Segment has a service that regularly scans and monitors the Data Graph for changes that occur in your warehouse that may break components of the Data Graph, like when the table being referenced by the Data Graph gets deleted from your warehouse or when the primary key column no longer exists. An alert banner will be displayed on the Data Graph landing page. The banner will be removed once the issues are resolved in your warehouse and/or the Data Graph. You will also have the option to trigger a manual sync of your warehouse schema. + +### Receive alerts for warehouse breaking changes + +Configure alerts for breaking changes to receive notifications over Slack, email, or in-app notification whenever Segment detects a breaking change in your warehouse. + +To configure alerts for breaking changes: +1. Open your workspace and navigate to **Settings > User Preferences > Activity Notifications**. +2. Select **Data Graph**. +3. Select one of the following notification methods: + - **Email**: Select this to receive notifications at either the email address associated with your account or another email address that you enter into this field. + - **Slack**: Select this and enter a Slack webhook URL and channel name to send alerts to a channel in your Slack workspace. + - **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. +4. Click **Save**. diff --git a/src/unify/profiles-sync/profiles-sync-setup/index.md b/src/unify/profiles-sync/profiles-sync-setup/index.md index 1f7ec69dd1..a825af5bd6 100644 --- a/src/unify/profiles-sync/profiles-sync-setup/index.md +++ b/src/unify/profiles-sync/profiles-sync-setup/index.md @@ -117,7 +117,7 @@ If you choose to re-enable a table or property to sync again, only new data gene #### Using historical backfill -Profiles Sync sends profiles to your warehouse on an hourly basis, beginning after you complete setup. You can use backfill, however, to sync historical profiles to your warehouse, as well. +Profiles Sync sends profiles to your warehouse hourly once setup completes. Setup is complete after an initial automated backfill syncs all profile data. To initiate the backfill, the Profiles Sync requires live data flowing into your workspace. If live data isn’t available, you can send test data to trigger the backfill sooner. Backfill can also sync historical profiles to your warehouse. > info "" > You can only use historical backfill for tables that you enable with [Selective Sync](#using-selective-sync) during setup. Segment does not backfill tables that you disable with Selective Sync.