API Integration

Build custom applications and automate workflows using Zenhub's GraphQL API.

The Zenhub API allows you to create custom integrations, generate tailored reports, and automate project management workflows. Using GraphQL, you can read workspace data, manipulate issues, and build applications that extend Zenhub's functionality for your specific needs.

For comprehensive API documentation, examples, and detailed endpoint information, visit developers.zenhub.com.

API authentication

Accessing the Zenhub API requires an API token generated from your account. Click your username at the bottom of the left sidebar, select Account management, and look for the API section. Generate a token from there — each token is tied to your user account and inherits your permissions for accessing workspaces, repositories, and data.

Making API requests

GraphQL APIs use standard HTTP POST requests, so most programming languages and frameworks can interact with the API without specialized libraries. Start with simple queries that retrieve workspace information or issue data to understand the API response structure before building complex integrations. Use Zenhub's API Explorer to validate your queries against the API schema during development.

Building robust integrations

Implement proper error handling for authentication failures, rate limit exceeded responses, and network connectivity problems. Respect API rate limits by implementing appropriate request throttling — check the API documentation for current limits. Use efficient GraphQL queries that request only the data your application needs, and implement data caching where appropriate to reduce API calls and improve responsiveness.

Webhook integration

Webhooks provide real-time notifications when issues are created, modified, or moved between pipelines. This event-driven approach is more efficient than polling the API for changes. Verify webhook authenticity using provided signature validation to ensure your applications only process legitimate webhook deliveries. Handle webhook delivery failures gracefully by implementing retry logic and fallback mechanisms.

The Zenhub MCP server

Zenhub's MCP server lets you query and interact with your Zenhub data through AI clients like Claude Code, Cursor, Windsurf, Gemini CLI, and Claude Desktop. It wraps the Zenhub GraphQL API and exposes tools to search and modify issues, understand your current sprint, and more.

To connect, you'll need a Zenhub API token from app.zenhub.com/settings/tokens, a Zenhub workspace ID (the 24-character ID in your workspace URL), and Node.js installed. Full configuration guidance is at developers.zenhub.com/mcp.

FAQ

Q: Can I use the Zenhub API without programming experience?
A: The API is designed for developers and requires programming knowledge. Consider using Zenhub's built-in export features or third-party integration platforms if you need data access without custom development.

Q: Are there rate limits on API usage?
A: Yes. The Zenhub API includes rate limiting to ensure consistent performance. Check the API documentation for specific limits and implement appropriate request throttling in your applications.

Q: Can I modify Zenhub data through the API?
A: Yes. The API supports both read and write operations, allowing you to create, update, and delete issues and other workspace content. Write operations require appropriate permissions for the target repositories.

Q: How do I handle API authentication in team applications?
A: Use service account tokens or implement proper token management systems for team applications. Avoid sharing personal API tokens across team members, as this creates security and access management problems.

Q: Can I integrate Zenhub with third-party services using the API?
A: Yes. Many teams use the API to sync Zenhub data with CRM systems, time tracking tools, and reporting platforms.