Skip to content

Commit ad636b8

Browse files
Apply suggestions from code review
Co-authored-by: rchinn-segment <[email protected]>
1 parent a358696 commit ad636b8

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

src/connections/sources/catalog/libraries/server/node/index.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -637,13 +637,18 @@ const analytics = new Analytics({
637637
638638
### OAuth 2.0
639639
640-
In order to guarantee authorized communication between your server environment and Segment's Tracking API, you can enable [OAuth 2.0](/docs/connections/oauth/) in your Segment workspace. To support the non-interactive server environment, the OAuth workflow used is a signed client assertion JWT. You will need a public and private key pair where the public key is uploaded to the segment dashboard and the private key is kept in your server environment to be used by this SDK. Your server will verify its identity by signing a token request and will receive a token that is used to to authorize all communication with the Segment Tracking API.
640+
Enable [OAuth 2.0](/docs/connections/oauth/) in your Segment workspace to guarantee authorized communication between your server environment and Segment's Tracking API. To support the non-interactive server environment, the OAuth workflow used is a signed client assertion JWT.
641641
642-
You will also need to provide the OAuth Application ID and the public key's ID, both of which are provided in the Segment dashboard. There are also options available to specify the authorization server, custom scope, maximum number of retries, or a custom HTTP client if your environment has special rules for separate segment endpoints.
642+
You will need a public and private key pair where:
643+
- The public key is uploaded to the Segment dashboard.
644+
- The private key is kept in your server environment to be used by this SDK.
645+
Your server will verify its identity by signing a token request and will receive a token that is used to to authorize all communication with the Segment Tracking API.
643646
644-
You should ensure that you are implementing handling for Analytics SDK errors. Good logging will help distinguish any configuration issues.
647+
You'll need to provide the OAuth Application ID and the public key's ID, both of which are provided in the Segment dashboard. There are also options available to specify the authorization server, custom scope, maximum number of retries, or a custom HTTP client if your environment has special rules for separate segment endpoints.
645648
646-
For more information, see the [Segment OAuth 2.0 documentation](/docs/connections/oauth/)
649+
Be sure to implement handling for Analytics SDK errors. Good logging will help distinguish any configuration issues.
650+
651+
For more information, see the [Segment OAuth 2.0 documentation](/docs/connections/oauth/).
647652
648653
```ts
649654
import { Analytics, OAuthSettings } from '@segment/analytics-node';

src/connections/sources/catalog/libraries/server/python/index.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -562,13 +562,18 @@ Be sure to see the full [reference of supported keys](/docs/connections/spec/com
562562

563563
### OAuth 2.0
564564

565-
In order to guarantee authorized communication between your server environment and Segment's Tracking API, you can enable [OAuth 2.0](/docs/connections/oauth/) in your Segment workspace. To support the non-interactive server environment, the OAuth workflow used is a signed client assertion JWT. You will need a public and private key pair where the public key is uploaded to the segment dashboard and the private key is kept in your server environment to be used by this SDK. Your server will verify its identity by signing a token request and will receive a token that is used to to authorize all communication with the Segment Tracking API.
565+
Enable [OAuth 2.0](/docs/connections/oauth/) in your Segment workspace to guarantee authorized communication between your server environment and Segment's Tracking API. To support the non-interactive server environment, the OAuth workflow used is a signed client assertion JWT.
566566

567-
You will also need to provide the OAuth Application ID and the public key's ID, both of which are provided in the Segment dashboard. There are also options available to specify the authorization server, custom scope, maximum number of retries, or a custom HTTP client if your environment has special rules for separate segment endpoints.
567+
You will need a public and private key pair where:
568+
- The public key is uploaded to the Segment dashboard.
569+
- The private key is kept in your server environment to be used by this SDK.
570+
Your server will verify its identity by signing a token request and will receive a token that is used to to authorize all communication with the Segment Tracking API.
568571

569-
You should ensure that you are implementing handling for Analytics SDK errors. Good logging will help distinguish any configuration issues.
572+
You'll need to provide the OAuth Application ID and the public key's ID, both of which are provided in the Segment dashboard. There are also options available to specify the authorization server, custom scope, maximum number of retries, or a custom HTTP client if your environment has special rules for separate segment endpoints.
570573

571-
For more information, see the [Segment OAuth 2.0 documentation](/docs/connections/oauth/)
574+
Be sure to implement handling for Analytics SDK errors. Good logging will help distinguish any configuration issues.
575+
576+
For more information, see the [Segment OAuth 2.0 documentation](/docs/connections/oauth/).
572577

573578
```python
574579
import segment.analytics as analytics

0 commit comments

Comments
 (0)