Engammo REST API Documentation
Programmatically generate, manage, and publish release notes using the Engammo API. Build custom integrations, automate your release workflow, and embed release notes anywhere.
API Fundamentals
Authentication
The Engammo API uses Bearer token authentication. Generate an API key from your organization settings in the Engammo dashboard. Include the key in the Authorization header of every request. API keys are scoped to your organization and inherit the permissions of the user who created them.
Authorization: Bearer YOUR_API_KEYRequest and Response Format
All API requests and responses use JSON. Set the Content-Type header to application/json for POST and PATCH requests. Responses include a data field containing the result, and a meta field with pagination information where applicable.
Content-Type: application/jsonRate Limiting
API requests are rate limited to 100 requests per minute per organization on the Pro plan and 1,000 per minute on the Enterprise plan. The response headers include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset to help you manage your usage.
X-RateLimit-Remaining: 95Webhooks
Engammo can send webhook notifications when release notes are generated, updated, or published. Configure webhook endpoints in your organization settings. Each webhook delivery includes a signature header for verification.
X-Engammo-Signature: sha256=...Endpoints Overview
The Engammo API is organized around REST principles. All endpoints are relative to the base URLhttps://api.engammo.com.
/api/v1/repositoriesList all connected repositories for the authenticated organization. Returns repository name, ID, connection status, and configuration.
Use case: Build dashboards that show which repositories are monitored by Engammo and their current status.
/api/v1/notesRetrieve release notes with filtering by repository, category, date range, and publication status. Supports pagination for large result sets.
Use case: Display release notes on your own website, populate internal dashboards, or sync notes to external systems.
/api/v1/notes/generateTrigger release note generation for a specific pull request or tag range. Returns the generated note content and metadata.
Use case: Integrate release note generation into CI/CD pipelines, custom workflows, or automated deployment scripts.
/api/v1/notes/:idUpdate a release note's content, category, or publication status. Use this to programmatically edit or publish notes.
Use case: Build custom review workflows where notes are edited and published through automation rather than the dashboard.
/api/v1/notes/:id/regenerateRegenerate the AI summary for an existing release note. The original note is preserved as a draft with the new content.
Use case: Retry AI generation when PR descriptions are updated after the initial generation, or when you want a fresh summary.
/api/v1/tags/:repoIdList available Git tags for a repository. Returns tag name, commit SHA, and creation date.
Use case: Build tag selection interfaces for versioned release note generation.
Example Use Cases
CI/CD Pipeline Integration
Call the generate endpoint from your deployment script to create release notes automatically when a new version is deployed. Combine with the tags endpoint to generate notes for the changes between the previous and current release tags.
Custom Changelog Widget
Use the notes endpoint to fetch published release notes and display them in a custom widget on your website or application. Filter by category to show only features and improvements, or display all changes in a timeline view.
Internal Release Dashboard
Combine the repositories and notes endpoints to build an internal dashboard that shows release activity across all projects. Track generation counts, publication rates, and category breakdowns in real time.
Slack Bot Integration
Use webhooks to receive notifications when release notes are published, then format and post them to Slack channels using the Slack API. This allows custom message formatting beyond what the built-in Slack integration provides.
Related Resources
Frequently Asked Questions
Who should use the Engammo API?
The API is designed for engineering teams that want to integrate release note generation into their existing workflows, CI/CD pipelines, or internal tools. It is also useful for teams that want to display release notes on their own website rather than using the hosted changelog.
How do I get an API key?
Sign in to the Engammo dashboard, navigate to Organization Settings, and select the API Keys tab. Click "Create API Key" to generate a new key. You can create multiple keys with descriptive names for different use cases.
What is the rate limit for API requests?
Pro plan organizations are limited to 100 requests per minute. Enterprise plan organizations have a limit of 1,000 requests per minute. Rate limit headers are included in every response so you can monitor your usage.
Is the API available on the free plan?
API access is available on the Pro and Enterprise plans. The free plan provides full dashboard access but does not include API key generation or programmatic access.
What programming languages are supported?
The Engammo API is a standard REST API that works with any programming language or HTTP client. We provide code examples in JavaScript, Python, Go, and cURL. Community-maintained SDKs are also available for popular languages.
Can I use the API to generate release notes without the dashboard?
Yes. The API supports the full release note lifecycle: generation, editing, and publishing. You can build entirely custom workflows that never require logging into the Engammo dashboard.
How do I verify webhook signatures?
Each webhook delivery includes an X-Engammo-Signature header containing a SHA-256 HMAC of the request body, signed with your webhook secret. Compute the HMAC on your end and compare it to the header value to verify authenticity.
Is there a sandbox environment for testing?
Yes. You can generate API keys with a "test" scope that operate against a sandbox environment. Test API calls do not affect your production data or count against your usage limits.
Start building with the Engammo API
Get programmatic access to automated release note generation. Available on Pro and Enterprise plans.