Public API

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.

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

Config API vs Public API

The Public API includes the following benefits over the Config API:

Create a Public API token

To create a Public API token in your Segment workspace:

1. Navigate to Settings > Workspace settings > Access Management > Tokens.
2. Click the + Create Token button.
3. Create a description for the token and assign it either Workspace Owner or Workspace Member access.
4. Click Create.
5. Copy your workspace token somewhere secure and click Done.

To begin sending requests to the Public API, make sure to include the Public API Token into your HTTP requests with the Authorization Header and configured with Bearer Token and the value of the newly generated Public API token.

API Token Security

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.

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.

Learn more about GitHub’s secret scanning program.

OAuth 2.0

FAQs

What should I do if I see a notification that my token was exposed?

In most cases, identifying and revoking an exposed token takes seconds. Segment recommends you check the audit trail to ensure no unauthorized actions were taken with the token.

How did my token get exposed?

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.

Why are exposed tokens automatically revoked?

By automatically revoking the exposed token, Segment helps keep your workspace secure and prevents potential abuse of the token.

How do I enable this feature?

This feature is automatically enabled for all workspaces on Team or Business tier plans.

What should I do when I see a CORS error?

If you see a CORS error, this means you’re attempting to make a request to the Public API on the front-end. The Public API is used for server-side only. To get rid of the error, move all Public API requests to a server.

What User Role / Workspace permissions are required to generate Public API tokens?

Only users that have a Workspace Owner role can create Public API Tokens.

Troubleshooting

The Update Schema Settings in Source endpoint returns error for field forwardingViolationsTo and forwardingBlockedEventsTo

When you don’t have a source to forward violations or blocked events to, then exclude the fields forwardingViolationsTo or forwardingBlockedEventsTo entirely from the request and the setting will be disabled.

PATCH endpoint : https://api.segmentapis.com/sources/{sourceId}/settings

{
    "group": {
      "allowTraitsOnViolations": false,
      "allowUnplannedTraits": false,
      "commonEventOnViolations": "ALLOW"
    },
    "identify": {
      "allowTraitsOnViolations": true,
      "allowUnplannedTraits": true,
      "commonEventOnViolations": "Block"
    },
    "track": {
      "allowEventOnViolations": false,
      "allowPropertiesOnViolations": false,
      "allowUnplannedEventProperties": false,
      "allowUnplannedEvents": false,
      "commonEventOnViolations": "OMIT_PROPERTIES"
    }
  }

What is the difference between a destination’s Instance ID and Meta ID?

The destination’s Instance ID is specific to a single destination within your workspace. The destination’s Meta ID, which is returned by the delivery metrics endpoint, identifies which integration you’ve set up. For example, if you had a dev Mixpanel (Actions) destination and a prod Mixpanel (Actions) destination, they would have the same Meta ID but two different Instance IDs.