From 9ea7230201f21d3a0e0a2503fde5b6a4195484d2 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Thu, 29 May 2025 13:37:36 -0400 Subject: [PATCH 1/7] first pass --- .../catalog/libraries/server/http-api/index.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/src/connections/sources/catalog/libraries/server/http-api/index.md b/src/connections/sources/catalog/libraries/server/http-api/index.md index adf8b02a0b..6c487d12ff 100644 --- a/src/connections/sources/catalog/libraries/server/http-api/index.md +++ b/src/connections/sources/catalog/libraries/server/http-api/index.md @@ -3,9 +3,9 @@ title: HTTP API Source redirect_from: '/connections/sources/catalog/libraries/server/http/' id: iUM16Md8P2 --- -The Segment HTTP Tracking API lets you record analytics data from any website or application. The requests hit Segment servers, Segment routes your data to any destination you want. +The Segment HTTP Tracking API lets you record analytics data from any website or application. The requests hit Segment servers then Segment routes your data to any destination you want. -Segment has native [sources](/docs/connections/sources/) for most use cases (like JavaScript and iOS) that are all built for high-performance and are open-source. But sometimes you may want to send to the HTTP API directly—that's what this reference is for. +Segment has native [sources](/docs/connections/sources/) for most use cases (like JavaScript and iOS) that are open-source and built for high-performance. But for unsupported use cases, [blocked event forwarding](/docs/protocols/enforce/forward-blocked-events/) or when you're using [Segment-Managed Custom Domain](/docs/connections/sources/custom-domain/), you may want to send data to Segment's HTTP API directly. > info "HTTP API sources in EU workspaces should use the `events.eu1.segmentapis.com` endpoint" > If you are located in the EU and use the `https://api.segment.io/v1/` endpoint, you might not see any errors, but your events will not appear in the Segment app. For more information about regional support, see the [Source Regional support](/docs/guides/regional-segment/#source-regional-support) documentation. @@ -16,6 +16,8 @@ Segment has native [sources](/docs/connections/sources/) for most use cases (lik Choose between [writeKey authentication](#writeKey-authentication), [basic authentication](#basic-authentication) and [OAuth](#oauth) to authenticate requests. +When authenticating with the HTTP API, don't hard code the IP addresses used to invoke the API. You should refresh this IP address at least once a day or when you experience [5xx errors](#experiencing-5xx-errors). + #### writeKey authentication Authenticate to the Tracking API by sending your project's **Write Key** along with a request. The authentication writeKey should be sent as part of the body of the request. This will be encrypted over https. @@ -284,7 +286,7 @@ Find more details about Group including the **Group payload** in the [Segment Sp ## Alias -`Alias is how you associate one identity with another. This is an advanced method, but it is required to manage user identities successfully in *some* of Segment's destinations. +Alias is how you associate one identity with another. This is an advanced method, but it is required to manage user identities successfully in *some* of Segment's destinations. In [Mixpanel](/docs/connections/destinations/catalog/mixpanel/#alias) it's used to associate an anonymous user with an identified user once they sign up. For [Kissmetrics](/docs/connections/destinations/catalog/kissmetrics/#alias), if your user switches IDs, you can use 'alias' to rename the 'userId'. @@ -481,4 +483,8 @@ Segment welcomes feedback on API responses and error messages. [Reach out to sup 1. Double check that you've set up the library correctly. -2. Make sure that you're calling a Segment API method after the library is successfully installed—[Identify](#identify), [Track](#track), and so on. +2. Make sure that you're calling a Segment API method after the library is successfully installed: [Identify](#identify), [Track](#track), and so on. + +### Experiencing `5xx` errors + +If you're experiencing `5xx` errors, refresh the IP address you use to invoke Segment's HTTP API. From fa885015b6476fc794f104c04ee965c080aa3735 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Thu, 29 May 2025 13:39:22 -0400 Subject: [PATCH 2/7] [netlify-build] --- .../sources/catalog/libraries/server/http-api/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/libraries/server/http-api/index.md b/src/connections/sources/catalog/libraries/server/http-api/index.md index 6c487d12ff..47d417a464 100644 --- a/src/connections/sources/catalog/libraries/server/http-api/index.md +++ b/src/connections/sources/catalog/libraries/server/http-api/index.md @@ -487,4 +487,4 @@ Segment welcomes feedback on API responses and error messages. [Reach out to sup ### Experiencing `5xx` errors -If you're experiencing `5xx` errors, refresh the IP address you use to invoke Segment's HTTP API. +If you're experiencing `5xx` errors, refresh the IP address you use to invoke Segment's HTTP API. \ No newline at end of file From b6d1e0b0d1421a8e7dacc3005c3e71ee9d45c720 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 2 Jun 2025 12:27:16 -0400 Subject: [PATCH 3/7] [netlify-build] --- .../sources/catalog/libraries/server/http-api/index.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/connections/sources/catalog/libraries/server/http-api/index.md b/src/connections/sources/catalog/libraries/server/http-api/index.md index 47d417a464..39cacc153e 100644 --- a/src/connections/sources/catalog/libraries/server/http-api/index.md +++ b/src/connections/sources/catalog/libraries/server/http-api/index.md @@ -3,7 +3,7 @@ title: HTTP API Source redirect_from: '/connections/sources/catalog/libraries/server/http/' id: iUM16Md8P2 --- -The Segment HTTP Tracking API lets you record analytics data from any website or application. The requests hit Segment servers then Segment routes your data to any destination you want. +The Segment HTTP Tracking API lets you record analytics data from any website or application. The requests hit Segment servers then Segment routes your data to your destination. Segment has native [sources](/docs/connections/sources/) for most use cases (like JavaScript and iOS) that are open-source and built for high-performance. But for unsupported use cases, [blocked event forwarding](/docs/protocols/enforce/forward-blocked-events/) or when you're using [Segment-Managed Custom Domain](/docs/connections/sources/custom-domain/), you may want to send data to Segment's HTTP API directly. @@ -12,12 +12,13 @@ Segment has native [sources](/docs/connections/sources/) for most use cases (lik ## Headers +> warning "HTTP API public IP addresses are subject to change" +> The public IP addresses of the HTTP API service are not static and may change without notice. If you are caching the resolved IP address or directly using the IP for submission, you must implement a DNS refresh at least once every 24 hours. Failing to do so may result in submission failures if the underlying IPs change. To ensure long-term reliability, Segment **strongly recommends** using the DNS hostname rather than hardcoding IPs. + ### Authentication Choose between [writeKey authentication](#writeKey-authentication), [basic authentication](#basic-authentication) and [OAuth](#oauth) to authenticate requests. -When authenticating with the HTTP API, don't hard code the IP addresses used to invoke the API. You should refresh this IP address at least once a day or when you experience [5xx errors](#experiencing-5xx-errors). - #### writeKey authentication Authenticate to the Tracking API by sending your project's **Write Key** along with a request. The authentication writeKey should be sent as part of the body of the request. This will be encrypted over https. From f9fabbc0de1d4a89a77abbabf3fb962175c89fde Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 9 Jun 2025 09:56:10 -0400 Subject: [PATCH 4/7] update git sync page --- src/segment-app/extensions/git.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/segment-app/extensions/git.md b/src/segment-app/extensions/git.md index 5dae126d31..de01145e88 100644 --- a/src/segment-app/extensions/git.md +++ b/src/segment-app/extensions/git.md @@ -158,5 +158,5 @@ This error can occur if there are issues with your Git connection settings or pe - 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. +- Branch protections are disabled on the repository or you are using the Segment GitHub app integration and have allowlisted the integration to bypass your branch protection rules. From c203ec70a987563401b9aa75e28cbc9af357b7aa Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 9 Jun 2025 14:10:53 -0400 Subject: [PATCH 5/7] Update src/segment-app/extensions/git.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- src/segment-app/extensions/git.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/segment-app/extensions/git.md b/src/segment-app/extensions/git.md index de01145e88..9c2979cd32 100644 --- a/src/segment-app/extensions/git.md +++ b/src/segment-app/extensions/git.md @@ -158,5 +158,5 @@ This error can occur if there are issues with your Git connection settings or pe - 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 or you are using the Segment GitHub app integration and have allowlisted the integration to bypass your branch protection rules. +- Branch protections are disabled on the repository, or you're using the Segment GitHub app integration and have allowlisted the integration to bypass your branch protection rules. From 75d8fb40fcef3097113492b102be6ca4ff4d0b1c Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 9 Jun 2025 14:34:57 -0400 Subject: [PATCH 6/7] Braze A.js update --- src/connections/destinations/catalog/actions-braze-web/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/connections/destinations/catalog/actions-braze-web/index.md b/src/connections/destinations/catalog/actions-braze-web/index.md index 62f7d07f8f..d1420d8c4d 100644 --- a/src/connections/destinations/catalog/actions-braze-web/index.md +++ b/src/connections/destinations/catalog/actions-braze-web/index.md @@ -28,6 +28,8 @@ Braze Web Mode (Actions) provides the following benefits over Braze Classic: 2. Search for "Braze" in the Catalog, select **Braze Web Mode (Actions)**, and choose which of your sources to connect the destination to. 3. Configure the Connection Settings. **API Key** and **SDK Endpoint** are required settings. +After setting up your Braze Web Mode (Action) destination in the Segment app, Segment's Analytics.js library starts asynchronously loading the Braze SDK on your page and sending data. Data appears in the Segment CDN in about 45 minutes. + > info "" > If you're using a device-mode connection, Braze's SDK assigns a `device_id` and a backend identifier, `braze_id`, to every user. This allows Braze to capture anonymous activity from the device by matching on those identifiers instead of `userId`. This applies to _device-mode connections_. From 17c20cddc6aa2c420fd7fa6118c9d990c7274c09 Mon Sep 17 00:00:00 2001 From: stayseesong Date: Tue, 10 Jun 2025 12:15:13 -0700 Subject: [PATCH 7/7] hide Amazon S3 destination --- src/connections/storage/catalog/amazon-s3/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/connections/storage/catalog/amazon-s3/index.md b/src/connections/storage/catalog/amazon-s3/index.md index ac10597e3b..bad80cfdfa 100644 --- a/src/connections/storage/catalog/amazon-s3/index.md +++ b/src/connections/storage/catalog/amazon-s3/index.md @@ -4,6 +4,7 @@ redirect_from: - '/connections/destinations/catalog/amazon-s3/' - '/connections/waser/catalog/amazon-s3/' hide-personas-partial: true +hidden: true --- > warning "The Amazon S3 destination will enter Limited Access on February 8, 2022"