Skip to content

Commit afb183c

Browse files
author
markzegarelli
committed
Merge branch 'develop' of github.com:segmentio/segment-docs into develop
2 parents 2621e2f + 93fcb44 commit afb183c

File tree

14 files changed

+140
-26
lines changed

14 files changed

+140
-26
lines changed
Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
extends: substitution
2-
message: "Please use '%s' instead of '%s'."
3-
link: https://docs.microsoft.com/en-us/style-guide/punctuation/exclamation-points
4-
level: warning
5-
swap:
6-
'\w!\s': '\.'
1+
extends: existence
2+
message: "Don't use exclamation points in text."
3+
nonword: true
4+
level: error
5+
action:
6+
name: remove
7+
tokens:
8+
- '\w!(?:\s|$)'

.github/styles/segment/links copy.yml

Lines changed: 0 additions & 6 deletions
This file was deleted.

.github/styles/segment/links.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ message: "Write meaningful link text."
33
link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses
44
level: warning
55
raw:
6-
- '\[?here\]\('
6+
- '\[?here\]\(.*'
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
extends: existence
2-
message: 'Link to Segment docs "%s" must be relative.'
2+
message: 'Link to Segment docs "%s" should be relative.'
33
level: warning
44
scope: raw
55
raw:
6-
- '\[.+\]\(https://(www.)?segment.com/docs.*\)'
6+
- '(segment.com\/docs.[^)]*)'

src/_data/sidenav/main.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ sections:
4343
title: Replay
4444
- path: /guides/regional-segment
4545
title: Regional Segment
46+
- path: /guides/audiences-and-journeys
47+
title: Audiences and Journeys
4648

4749
- section_title: How-to Guides
4850
slug: guides/how-to-guides

src/api/public-api/index.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,25 @@ The Public API includes the following benefits over the Config API:
2424
| Improved architecture | The Public API is built with improved security, checks for authentication, authorization, input validation, HTTPS exposed services, auto-scaling, and more in mind. |
2525
| Cleaner mapping | The Public API uses unique IDs for reference, in place of slugs in the Config API. Unique IDs are, by design, unique. |
2626
| Available in Europe | The Public API is accessible to both US and EU-based workspaces. |
27-
| Increased reliability | The Public API features more stable endpoints, and a 99.8% success rate |
27+
| Increased reliability | The Public API features more stable endpoints, and a 99.8% success rate |
28+
29+
## API Token Security
30+
31+
To enhance API token security, Segment partners with GitHub to prevent fraudulent use of exposed API tokens found in public git repositories. This helps to prevent malicious actors from using exposed tokens to perform unauthorized actions in your Segment workspace.
32+
33+
Within seconds, GitHub scans each commit in public repositories for Public API tokens, and sends detected tokens to Segment. Valid tokens are automatically revoked and workspace owners are notified.
34+
35+
Learn more about [GitHub's secret scanning program](https://docs.github.com/en/developers/overview/secret-scanning-partner-program){:target="_blank"}.
36+
37+
### Frequently Asked Questions
38+
#### What should I do if I see a notification that my token was exposed?
39+
In most cases, identifying and revoking an exposed token takes seconds. Segment recommends you check the [audit trail](/docs/segment-app/iam/audit-trail/) to ensure no unauthorized actions were taken with the token.
40+
41+
#### How did my token get exposed?
42+
Developers can accidentally commit tokens to public repositories, exposing them to the public. This can happen when developers use a token in a local development environment and forget to remove it before committing their code.
43+
44+
#### Why are exposed tokens automatically revoked?
45+
By automatically revoking the exposed token, Segment helps keep your workspace secure and prevents potential abuse of the token.
46+
47+
#### How do I enable this feature?
48+
This feature is automatically enabled for all workspaces on Team or Business tier plans.

src/connections/destinations/catalog/clearbit-reveal/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Setup within Clearbit:
2222

2323
To verify that the destination has been set up correctly, send a page event **that includes an IP address**, check the Debugger section of your Segment Source. Assuming everything is as it should be, you should start seeing Clearbit Reveal data populate in an `identify` event – click on the specific event you're interested in to see Clearbit Reveal traits. These traits will now be available to other Segment destinations in your account. Notice that all Clearbit Reveal traits are prefixed with `reveal_` to ensure they don't conflict with existing traits. Clearbit will also send a `track` event for 'enrichment_provider'.
2424

25+
When you make requests to Clearbit, Clearbit send events with its own data back to your Segment source server-side using Segment's analytics-ruby library. If you see unexpected traffic from analytics-ruby in your Debugger, that traffic represents the events that Clearbit sends back.
26+
2527

2628
## Page
2729

src/connections/destinations/catalog/customer-io/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ redirect_from: "/connections/destinations/catalog/customer.io/"
55
hide-personas-partial: true
66
maintenance: true
77
id: 54521fd525e721e32a72eea8
8+
actions-slug: "customer-io-actions"
89
---
910
[Customer.io](https://customer.io/) helps you send automated email, push, SMS, and webhooks based on your customers' activities in your app or product. It makes conversion tracking, optimization and re-marketing easier. The `analytics.js` Customer.io Destination is open-source. You can browse the code [on GitHub](https://github.com/segmentio/analytics.js-integrations/tree/master/integrations/customerio).
1011

src/connections/destinations/catalog/posthog/index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: PostHog Destination
33
rewrite: true
44
id: 5ece242d61055a0b1bb2e103
55
---
6-
[PostHog](https://posthog.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is self-hosted, open-source analytics product. Get the same powerful features as other product analytics software but keep full control over your data.
6+
[PostHog](https://posthog.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a self-hosted, open-source analytics product. Get the same powerful features as other product analytics software but keep full control over your data.
77

8-
This destination is maintained by PostHog. For any issues with the destination, [contact the PostHog Support team](mailto:[email protected]).
8+
This destination is maintained by PostHog. For any issues with the destination, check out the [PostHog users slack](https://posthog.com/slack){:target="_blank"} or [contact the PostHog Support team](mailto:[email protected]).
99

1010
## Getting Started
1111

@@ -14,11 +14,12 @@ This destination is maintained by PostHog. For any issues with the destination,
1414
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
1515
2. Search for "PostHog" in the Destinations Catalog, and select the PostHog destination.
1616
3. Choose which Source should send data to the PostHog destination.
17-
4. Go to your [PostHog set up page](https://app.posthog.com/setup), and find and copy the **API key**.
17+
4. Go to your [PostHog set up page](https://app.posthog.com/setup){:target="_blank"}, and copy the **API key**.
1818
5. Enter the PostHog API Key that you copied in the PostHog destination settings in Segment.
19-
20-
> note ""
21-
> **Note**: If you're hosting your own PostHog instance, add the URL of your instance without the trailing slash in the **PostHog instance** setting. For example, `https://posthog-example.herokuapp.com`
19+
6. Enter your PostHog instance URL as the address to your instance **without any trailing slash**, for example:
20+
- `https://app.posthog.com` if you use PostHog Cloud US
21+
- `https://eu.posthog.com` if you use PostHog Cloud EU
22+
- `https://posthog-example.herokuapp.com` if you self-host on Heroku
2223

2324
## Page
2425

src/connections/sources/catalog/libraries/mobile/react-native/index.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -595,7 +595,19 @@ No, only the plugins listed above are supported in device-mode for Analytics Rea
595595
### Will I still see device-mode integrations listed as `false` in the integrations object?
596596
When you successfully package a plugin in device-mode, you won't see the integration listed as `false` in the integrations object for a Segment event. This logic is packaged in the event metadata, and isn't surfaced in the Segment debugger.
597597
### Why are my IDs not set in UUID format?
598-
Due to [limitations](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/uuid.ts#L5){:target="_blank"} with the React Native bridge, Segment doesn't use UUID format for `anonymousId`s and `messageId`s in local development. These IDs will be set in UUID format for your live app.
598+
Due to [limitations](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/uuid.ts#L5){:target="_blank"} with the React Native bridge, Segment doesn't use UUID format for `anonymousId` and `messageId` values in local development. These IDs will be set in UUID format for your live app.
599+
### How do I set a distinct writeKey for iOS and android?
600+
You can set different writeKeys for iOS and Android. This is helpful if you want to send data to different destinations based on the client side platform. To set different writeKeys, you can dynamically set the writeKey when you initialize the Segment client:
599601
602+
```js
603+
import {Platform} from 'react-native';
604+
import { createClient } from '@segment/analytics-react-native';
605+
606+
const segmentWriteKey = Platform.iOS ? 'ios-writekey' : 'android-writekey';
607+
608+
const segmentClient = createClient({
609+
writeKey: segmentWriteKey
610+
});
611+
```
600612
## Changelog
601613
[View the Analytics React Native 2.0 changelog on GitHub](https://github.com/segmentio/analytics-react-native/releases){:target="_blank"}.

0 commit comments

Comments
 (0)