canonical: https://jentic.com/apis/newreleasesio/newreleases

# Newreleasesio NewReleases API

NewReleases API tracks software release notifications across 75+ package providers including GitHub, npm, PyPI, Docker Hub, and Maven Central. It manages tracked projects, retrieves release history and notes, and routes alerts to chat integrations like Slack, Discord, Microsoft Teams, Mattermost, and Telegram. The API enforces rate limits of 1 GET request per hour and 10 mutating requests per hour, exposed through X-Ratelimit-Limit, X-Ratelimit-Remaining, and X-Ratelimit-Reset response headers.

## For AI agents

Track software release notifications across package registries and route them to chat tools. Manage projects, releases, tags, and integrations like Slack, Discord, and Microsoft Teams.

## Scope

Does not handle vulnerability scanning, dependency installation, or code patching - use for release tracking and notification routing only.

## Capabilities

- Track new releases for packages across GitHub, npm, PyPI, Docker Hub, and 70+ other providers
- Retrieve full release history and release notes for any tracked project
- Route release notifications to Slack, Discord, Microsoft Teams, Mattermost, Rocket.Chat, and Telegram channels
- Organise tracked projects with custom tags and per-project notification settings
- Search the providers catalogue to find any open-source project before adding it to tracking
- Inspect the latest release for any project to drive downstream upgrade automation

## Use cases

### Dependency Update Monitoring

Engineering teams use NewReleases to receive alerts when upstream packages publish new versions across npm, PyPI, Maven, NuGet, and Docker Hub. Add projects via POST `/v1/projects`, list current trackers with GET `/v1/projects`, and read release notes through GET `/v1/projects/{id}/releases/{version}/note.` This replaces ad-hoc RSS or watch lists and gives a single feed for every dependency a team cares about.

Example prompt: Add the github/kubernetes/kubernetes project to tracking and configure a Slack channel notification when a new release is published

### ChatOps Release Notifications

DevOps teams pipe release events into Slack, Microsoft Teams, Discord, Mattermost, or Rocket.Chat so engineers see new versions where they already work. List wired channels through GET `/v1/slack-channels`, GET `/v1/discord-channels`, and GET `/v1/microsoft-teams-webhooks`, then update per-project settings with POST `/v1/projects/{id}` to specify which integration receives that project's alerts.

Example prompt: Configure the project with id abc123 to push release notifications to a specific Slack channel and Microsoft Teams webhook

### Tag-Based Release Organisation

Platform teams managing dozens or hundreds of tracked projects organise them with tags representing team ownership, criticality, or technology stack. Create tags through POST `/v1/tags`, list existing tags via GET `/v1/tags`, and apply them when adding or updating projects. This makes filtering and reporting on release velocity per team practical at scale.

Example prompt: Create a tag named security-critical and apply it to the openssl, log4j, and curl project trackers

### Agent-Driven Release Triage

An AI agent can call NewReleases through Jentic to monitor the dependency tree of a codebase, fetch release notes when new versions appear, and summarise breaking changes for a human reviewer. The agent uses GET `/v1/projects/{id}/latest-release` to detect new versions and GET `/v1/projects/{id}/releases/{version}/note` to pull the changelog without scraping vendor sites.

Example prompt: For every tracked project, fetch the latest release and its release note, then summarise breaking changes for the engineering lead

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/projects` | List all tracked projects |
| POST | `/v1/projects` | Add a project to tracking |
| GET | `/v1/projects/{id}/releases` | List releases for a project |
| GET | `/v1/projects/{id}/latest-release` | Get the latest release for a project |
| GET | `/v1/projects/{id}/releases/{version}/note` | Get release notes for a specific version |
| POST | `/v1/tags` | Create a tag for grouping projects |
| GET | `/v1/slack-channels` | List configured Slack notification channels |

## Key resources

- **Projects** — Add, search, list, update, and delete tracked open-source projects across 75+ providers
- **Releases** — List historical releases, fetch a specific version, get the latest release, and read release notes
- **Providers** — Enumerate the package providers and registries NewReleases supports
- **Tags** — Create, update, and apply tags to organise tracked projects
- **Integrations** — List configured Slack, Discord, Telegram, Microsoft Teams, Mattermost, Rocket.Chat, and Hangouts Chat destinations

## Why Jentic

- **Setup:** Wiring NewReleases by hand means learning its X-Key header auth, tracking project and release resources, and routing alerts to Slack channels yourself. Through Jentic you install once, import the NewReleases API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** NewReleases puts the project id in the URL path (`/v1/projects/{id}/releases`), so a rule can pin your agent to one project: it can read releases and latest-release notes for that project and nothing else. You choose the operations it may call, so creating projects or tags is not included unless you add it.
- **Credential handling:** Your NewReleases API key is stored once, encrypted, by your own Jentic One instance and injected into the X-Key header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'track a new package release' or 'send a release alert to Slack', and Jentic returns the matching NewReleases operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **GitHub API** — GitHub Releases endpoint provides release data for GitHub-hosted projects only, without cross-registry coverage
- **Snyk API** — Snyk reports security vulnerabilities in dependencies; NewReleases reports new releases of those dependencies
- **Slack API** — Slack receives the release notifications NewReleases routes through its Slack integration

## FAQ

### What authentication does the NewReleases API use?

The NewReleases API uses an API key passed in the X-Key header, with HTTP Basic auth as an alternate scheme. Through Jentic the key is stored in the encrypted vault and never enters the agent's prompt context - agents call the API with a scoped Jentic credential reference instead.

### Can I track releases from private GitHub repositories with the NewReleases API?

The API tracks any project that has been added through POST `/v1/projects` and is supported by one of the providers returned by GET `/v1/providers.` Public package registries and public repositories work directly; private repository support depends on your NewReleases account plan and the provider integration.

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

GET requests are limited to 1 per hour and other requests to 10 per hour, enforced per API key. Every response includes X-Ratelimit-Limit, X-Ratelimit-Remaining, and X-Ratelimit-Reset headers so callers can pace their requests; agents calling through Jentic should batch project additions and tag changes rather than issuing them one at a time.

### How do I send NewReleases alerts to Slack through Jentic?

Connect Slack inside the NewReleases dashboard so its workspace appears under GET `/v1/slack-channels`, then use POST `/v1/projects/{id}` to attach that channel to a project's notification settings. Through Jentic, the agent searches for 'configure slack release notification', loads the schema, and executes the call with the project id and channel id.

### Is the NewReleases API free to use?

NewReleases offers a free tier suitable for individual developers and paid tiers for teams with more tracked projects and integrations. The API surface itself is the same across plans - what changes is the number of trackable projects and which chat integrations are unlocked.

### Can I retrieve release notes without scraping the GitHub or npm page?

Yes. GET `/v1/projects/{id}/releases/{version}/note` returns the structured release note that NewReleases captured at publish time, which is what makes this API useful for AI agents that summarise changelogs across a dependency tree.

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

Yes. Because you run Jentic One yourself, you decide which NewReleases operations and which stored API key your agent may use. Since NewReleases puts the project id in the URL path (for example `/v1/projects/{id}/releases`), your own rules can pin the agent to a single project so it only reads that project's release history and latest-release notes and nothing else. Write operations like POST `/v1/projects` to add a project or POST `/v1/tags` to create a tag are excluded unless you explicitly allow them.