canonical: https://jentic.com/apis/heysegment.com/heysegment

# Heysegment Segment API

The Segment API from Heysegment builds and deploys websites and runs the platform behind them: it starts and commits site pushes, reports deploy status and logs, creates and invokes serverless functions, and collects form submissions. Alongside the site surface it manages accounts, organizations, and businesses, and tracks each business's online reputation through Google reviews and review-request messaging. Every resource call authenticates with a bearer credential whose account, business, or site is named by id in the path.

## For AI agents

Deploy Heysegment sites with pushes and commits, run serverless functions, collect form submissions, and read a business's Google reviews, all over a bearer-authenticated REST API scoped by account, business, and site id.

## Scope

Does not host a customer data platform, run ad campaigns, or process payments. Use for managing Heysegment accounts, sites and deploys, form submissions, functions, and business reputation only.

## Capabilities

- Deploy a site by starting a push, committing it, and watching the deploy status and logs
- Create serverless functions for a site and publish, invoke, and version them
- Collect form submissions on a site and route them to email or text recipients
- Manage accounts, organizations, and businesses, and their provider and Google connections
- Track a business's online reputation, including Google reviews, feedback, and review-request sequences
- Group schema changes into mutation groups and submit them for review and approval

## Use cases

### Agent-Driven Site Deployment

An AI agent managing a client's website uses the Segment API through Jentic to deploy changes end to end: it starts a push, commits it, and polls the site's deploy status and logs until the deploy finishes. The same surface lets the agent create and invoke serverless functions and manage a site's assets and secrets. Every call is a bearer-authenticated request scoped to the credential's account.

Example prompt: Start a push for a site, commit it, then poll the deploy status until it reports success and read the logs

### Form Submissions and Notifications

A site collects form submissions and routes them to the right people. The Segment API lists and reads submissions, toggles their email on or off, manages email recipients and templates, and can text a number about a submission's entries. This lets an application wire a contact form to email and SMS notifications without custom plumbing.

Example prompt: List a site's submissions, enable email on one, and add a recipient address to it

### Reputation and Review Management

An agency tracks a client business's online reputation by reading its Google reviews, private feedback, and review-request messaging sequences. The Segment API exposes reputation metrics, review listings and replies, and the automation and destination behind review requests, scoped to a business by id. This gives a reporting agent a full read of how a business is performing on reviews.

Example prompt: For a business id, read the reputation metrics and list the latest Google reviews and private feedback

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/account` | Retrieve the credential's account |
| GET | `/v1/account/sites` | List sites |
| POST | `/v1/sites/{siteId}/pushes` | Start a deploy push for a site |
| POST | `/v1/sites/{siteId}/pushes/{snapshotId}/commit` | Commit a push |
| GET | `/v1/sites/{siteId}/status` | Get the site's deploy status |
| POST | `/v1/sites/{siteId}/functions/{functionId}/invoke` | Invoke a published function |
| POST | `/v1/sites/{siteId}/submissions` | Create a form submission |
| GET | `/v1/businesses/{businessId}/reputation/reviews` | List Google reviews and replies for a business |

## Key resources

- **Account and businesses** — Account, organizations, businesses, features, onboarding invites, and provider and Google connections
- **Sites** — Sites, pushes and snapshots, deploy status and logs, assets, and SDK generation
- **Submissions and functions** — Form submissions with email and text routing, and serverless functions with publish, invoke, and secrets
- **Reputation** — Google reviews, private feedback, metrics, and review-request messaging sequences for a business
- **Mutation groups** — Grouped change proposals submitted for review and approval

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 42 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 98 / 100
  - Developer Experience & Jentic Compatibility: 62 / 100
  - AI-Readiness & Agent Experience: 18 / 100
  - Agent Usability: 81 / 100
  - Security: 60 / 100
  - AI Discoverability: 68 / 100
- **View full report:** https://jentic.com/apis/heysegment.com/heysegment/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Segment API by hand means handling its bearer credential, validating it with an explicit pre-authentication call, and threading account, business, and site ids through its many endpoints. Through Jentic you install once, import it from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Segment puts the account, business, and site ids in the URL path (`/v1/sites/{siteId}/...`, `/v1/businesses/{businessId}/...`), so a rule can pin your agent to one site or one business and the operations you pick. You choose the operations it may call, so destructive ones like deleting a submission or a secret are not included unless you add them.
- **Credential handling:** Your Segment credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'deploy a site' or 'list Google reviews', and Jentic returns the matching Segment operation with its input schema so the agent sends the right siteId or businessId without reading the reference docs.

## Related APIs

- **Netlify** — A site deploy platform with builds, serverless functions, and form handling, versus Heysegment's sites plus reputation features.
- **Vercel** — A deployment platform for front-end sites and serverless functions, versus Heysegment's broader agency platform.
- **Webflow** — A visual website builder whose designs can be published and hosted elsewhere.

## FAQ

### What authentication does the Segment API use?

Most resource operations authenticate with a bearer credential in the Authorization header, per its OpenAPI spec, where `/v1/account` is the credential's own account and an organization, business, or site beneath it is named by id in the path. A few endpoints, such as the ping and credential validation, need no credential. Through Jentic the credential is stored encrypted by your own Jentic One instance and injected at call time.

### Can I deploy a site and run functions with the Segment API?

Yes. You start a push, commit it, and read the deploy status and logs, and you create, publish, and invoke serverless functions on a site. The same API also manages a site's assets, secrets, and form submissions, all scoped to the site by its siteId.

### What are the rate limits for the Segment API?

The OpenAPI spec does not specify rate limits. For current limits, see the Heysegment documentation at https://www.heysegment.com.

### How do I deploy a site through Jentic?

Search Jentic with a query like 'deploy a site', add the Segment API from the directory, and store your bearer credential once. Your agent starts a push for the site, commits it, and polls the deploy status until it succeeds. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I limit what my agent is allowed to do with the Segment API?

Yes. Because the site and business ids live in the URL path, a Jentic rule can pin your agent to one site or one business, and you choose which operations it may call, such as reading reviews or deploy status while leaving delete operations out, with every call logged. That keeps an agent that only reports on reputation from ever touching a site deploy.

### Is there a Segment API MCP server?

You don't need an MCP server to give your agent the Segment API. Jentic connects it directly from the API Directory: import it, store your bearer credential once, and your agent calls the site, submission, function, and reputation operations it needs on demand without loading another server's tool definitions into its context.