Skip to content

Commit 0671d7b

Browse files
author
markzegarelli
committed
Merge branch 'develop' of github.com:segmentio/segment-docs into develop
2 parents afb183c + 19558a2 commit 0671d7b

File tree

15 files changed

+242
-169
lines changed

15 files changed

+242
-169
lines changed

‎src/_data/catalog/destination_categories.yml‎

Lines changed: 1 addition & 1 deletion
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 2023-01-12
2+
# destination categories last updated 2023-01-17
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

‎src/_data/catalog/destinations.yml‎

Lines changed: 139 additions & 137 deletions
Large diffs are not rendered by default.

‎src/_data/catalog/destinations_private.yml‎

Lines changed: 1 addition & 1 deletion
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 2023-01-12
2+
# destination data last updated 2023-01-17
33
items:
44
- id: 62b256147cbb49302d1486d0
55
display_name: Heap Web (Actions)

‎src/_data/catalog/regional-supported.yml‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL
2-
# Last updated 2023-01-12
2+
# Last updated 2023-01-17
33
warehouses:
44
- id: WcjBCzUGff
55
display_name: Azure SQL Data Warehouse
@@ -743,6 +743,22 @@ sources:
743743
- us
744744
endpoints:
745745
- us
746+
- id: vOlNDkP5qR
747+
display_name: Thomas Gilbert Test
748+
slug: thomas-gilbert-test
749+
url: connections/sources/catalog/cloud-apps/thomas-gilbert-test
750+
regions:
751+
- us
752+
endpoints:
753+
- us
754+
- id: 6nGX8vnUpM
755+
display_name: Thomas Source Test Portal
756+
slug: thomas-source-test-portal
757+
url: connections/sources/catalog/cloud-apps/thomas-source-test-portal
758+
regions:
759+
- us
760+
endpoints:
761+
- us
746762
- id: StjIoJAuBT
747763
display_name: Thomas Test Source
748764
slug: thomas-test-source

‎src/_data/catalog/source_categories.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# source cateogries last updated 2023-01-12
2+
# source cateogries last updated 2023-01-17
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

‎src/_data/catalog/sources.yml‎

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# sources last updated 2023-01-12
2+
# sources last updated 2023-01-17
33
items:
44
- id: 8HWbgPTt3k
55
display_name: .NET
@@ -1102,7 +1102,7 @@ items:
11021102
isCloudEventSource: true
11031103
slug: paytronix
11041104
url: connections/sources/catalog/cloud-apps/paytronix
1105-
hidden: false
1105+
hidden: true
11061106
regions:
11071107
- us
11081108
endpoints:
@@ -1537,6 +1537,38 @@ items:
15371537
url: https://cdn.filepicker.io/api/file/s6u7GXDeRBq7chdP2Vet
15381538
categories:
15391539
- A/B Testing
1540+
- id: vOlNDkP5qR
1541+
display_name: Thomas Gilbert Test
1542+
isCloudEventSource: true
1543+
slug: thomas-gilbert-test
1544+
url: connections/sources/catalog/cloud-apps/thomas-gilbert-test
1545+
hidden: false
1546+
regions:
1547+
- us
1548+
endpoints:
1549+
- us
1550+
source_type: cloud-app
1551+
description: ''
1552+
logo:
1553+
url: ''
1554+
categories: []
1555+
- id: 6nGX8vnUpM
1556+
display_name: Thomas Source Test Portal
1557+
isCloudEventSource: true
1558+
slug: thomas-source-test-portal
1559+
url: connections/sources/catalog/cloud-apps/thomas-source-test-portal
1560+
hidden: false
1561+
regions:
1562+
- us
1563+
endpoints:
1564+
- us
1565+
source_type: cloud-app
1566+
description: This is a description
1567+
logo:
1568+
url: https://cdn.filepicker.io/api/file/1SsbNbflStyRV9E0euoi
1569+
categories:
1570+
- Advertising
1571+
- Customer Success
15401572
- id: StjIoJAuBT
15411573
display_name: Thomas Test Source
15421574
isCloudEventSource: false

‎src/_data/products.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,3 +145,12 @@ items:
145145
team: false
146146
business: true
147147
add-on: false
148+
149+
- product_display_name: Public API
150+
slug: papi
151+
plan-note: "The Public API is available to customers on Team or Business plans."
152+
plans:
153+
free: false
154+
team: true
155+
business: true
156+
add-on: false

‎src/api/public-api/index.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: Public API
3+
plan: papi
34
---
4-
The Segment Public API helps you manage your Segment workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs.
5+
The Segment Public API helps you manage your Segment workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. The Public API is available to Team and Business Tier customers.
56

67
All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a workspace.
78

@@ -26,6 +27,7 @@ The Public API includes the following benefits over the Config API:
2627
| Available in Europe | The Public API is accessible to both US and EU-based workspaces. |
2728
| Increased reliability | The Public API features more stable endpoints, and a 99.8% success rate |
2829

30+
2931
## API Token Security
3032

3133
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.
@@ -45,4 +47,5 @@ Developers can accidentally commit tokens to public repositories, exposing them
4547
By automatically revoking the exposed token, Segment helps keep your workspace secure and prevents potential abuse of the token.
4648

4749
#### How do I enable this feature?
48-
This feature is automatically enabled for all workspaces on Team or Business tier plans.
50+
This feature is automatically enabled for all workspaces on Team or Business tier plans.
51+

‎src/connections/destinations/catalog/braze/index.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,12 @@ The Braze Destination is open-sourced on GitHub. Source code for the following i
1717

1818
- [iOS](https://github.com/Appboy/appboy-segment-ios) (maintained by Braze)
1919
- [Android](https://github.com/Appboy/appboy-segment-android)(maintained by Braze)
20+
- [Swift](https://github.com/braze-inc/analytics-swift-braze)(maintained by Braze)
21+
- [Kotlin](https://github.com/braze-inc/braze-segment-kotlin)(maintained by Braze)
2022
- [Web](https://github.com/segment-integrations/analytics.js-integration-appboy) (maintained by Segment)
2123
- [Server](https://github.com/segmentio/integration-appboy) (maintained by Segment)
2224

23-
For issues with iOS or Android platforms, contact Braze support. For issues with Web or Server platforms, contact [Segment support](https://segment.com/help/contact).
25+
For issues with mobile platforms (iOS, Android, Swift, or Kotlin), contact Braze support. For issues with Web or Server platforms, contact [Segment support](https://segment.com/help/contact).
2426

2527
> info "The Braze SDK contains three major versions"
2628
> If you are migrating from version 1 to version 2, see information about [migration from Version 1 to Version 2](/docs/connections/destinations/catalog/braze/#migrating-to-v2-of-the-braze-web-sdk) below.

‎src/connections/destinations/catalog/zendesk/index.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,7 @@ id: 54521fdc25e721e32a72ef06
1313

1414
1. From the Segment web app, click **Catalog**.
1515
2. Search for "Zendesk" in the Catalog, select it, and choose which of your sources to connect the destination to.
16-
3. There are two ways to authenticate your Zendesk account with Segment:
17-
* Use the standard email and password you use to Sign In to your Zendesk account. In the Zendesk settings, add your email in the **Email** setting and your password in the **Password** setting.
18-
* Use Zendesk OAuth with a unique token. Get the corresponding token from your Zendesk account: **Settings > Channels > API** and under the Settings Tab choose the corresponding token from the "Active API Tokens" list. In the Zendesk settings, add your `email/token` in the **Email** setting (for example, `[email protected]/token` - use the actual word token in your email address) and add the actual token in the **Password** setting.
19-
4. Add your Zendesk subdomain in the **Subdomain** setting (not including `.zendesk.com`).
16+
3. Enter your Zendesk domain (not including `.zendesk.com`) and click **Connect**. The Zendesk OAuth login opens in a new tab. Sign in with your Zendesk credentials to authenticate and allow the Segment integration.
2017

2118
## Identify
2219

@@ -171,17 +168,6 @@ When you call `group` Segment inserts or update an organization in Zendesk and u
171168

172169
Here's an example:
173170

174-
{% comment %} api-example '{
175-
"action": "group",
176-
"groupId": "908172409",
177-
"userId": "6789",
178-
"traits": {
179-
"name": "LA Lakers",
180-
"url": "https://lakers.com",
181-
"deleted": false
182-
}
183-
}'}}} {% endcomment %}
184-
185171
```js
186172
{
187173
"action": "group",

0 commit comments

Comments
 (0)