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

# Hive API

Hive is a project management platform built around actions (tasks), projects, and team collaboration. The API exposes the action lifecycle (create, comment, attach, audit history), project structure, user and team membership, labels, and webhooks for real-time event delivery. It is intended for teams that need to programmatically read, create, and update work items across multiple Hive workspaces.

## For AI agents

Create and manage Hive actions, projects, comments, attachments, and labels, and subscribe to workspace events via webhooks.

## Scope

Does not handle time tracking, payroll, or invoicing - use for Hive action and project management only.

## Capabilities

- Create, update, and delete Hive actions with status transitions and assignees
- List and update projects within a workspace, including nested action collections
- Add comments and attachments to actions for collaborative review
- Audit action history to see status changes and ownership transitions
- Manage labels and custom fields applied to actions and projects
- Register webhooks to receive action and project events in real time

## Use cases

### Cross-Tool Task Sync

Operations teams keep Hive in sync with engineering tools by mirroring tasks from GitHub, Linear, or Jira into Hive actions. The API supports create, update-status, and comment endpoints so an agent can reflect external state without manual copy. Status changes propagate via webhook for real-time updates.

Example prompt: Create a Hive action titled 'Review PR #42' in project proj_123 with status 'in_progress' and assignee user_55.

### Status Reporting Automation

Project leads need weekly status digests across many actions and projects. The agent calls list endpoints across workspaces, summarises action status counts, and posts a digest to Slack or email. This replaces manual screenshot-based status reporting that consumes hours per week.

Example prompt: List all actions in workspace ws_abc grouped by status and return counts of open, in-progress, and completed for the week.

### Webhook-Driven Notifications

Teams want lightweight, real-time pings when specific Hive actions change. Webhook subscriptions deliver action events as they happen so agents can route notifications, update related systems, or kick off downstream automation. This avoids polling the action list endpoint on a timer.

Example prompt: Create a Hive webhook subscribed to action-status-changed events for workspace ws_abc pointing at the agent's ingestion URL.

### Agent-Driven Project Setup

An AI ops agent connected via Jentic spins up a new project - creates the project record, attaches the standard label set, and seeds the kickoff actions - all from a single instruction. Credentials remain in your Jentic One instance so the agent never holds the api_key or user_id headers. Setup time drops from a manual checklist to a single agent call.

Example prompt: Create a new Hive project 'Q3 Launch' in workspace ws_abc, attach labels 'launch' and 'priority', and create five seed actions.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/actions/create` | Create a new action |
| GET | `/workspaces/{workspaceId}/actions` | List actions in a workspace |
| PUT | `/actions/update-status` | Update action status |
| POST | `/actions/{actionId}/comments` | Add a comment to an action |
| GET | `/actions/{actionId}/history` | View action change history |

## Key resources

- **Actions** — Tasks with status, assignees, comments, attachments, and history
- **Projects** — Containers that group actions
- **Users** — Workspace user records
- **Teams** — User groupings inside a workspace
- **Labels** — Tags applied to actions and projects
- **Webhooks** — Event subscriptions for action and project events

## Why Jentic

- **Setup:** Wiring the Hive API by hand means sending two headers on every call, an api_key and a user_id, and walking its workspace, action, and project resources. Through Jentic you install once, import the Hive API from the API Directory, store both header values once, and your agent calls it.
- **Permission scoping:** Hive puts the workspace and action ids in the URL path (`/workspaces/{workspaceId}/actions`, `/actions/{actionId}/comments`), so a rule can pin your agent to one workspace and the actions within it. You choose the operations it may call, so destructive ones like deleting an action or a project are not included unless you add them.
- **Credential handling:** Your Hive api_key and user_id header values are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a Hive task', and Jentic returns the matching Hive operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Asana API** — Asana is a widely used project and task management API
- **monday.com API** — monday.com offers a board-centric work management API
- **ClickUp API** — ClickUp covers tasks, docs, goals, and chat in one workspace

## FAQ

### What authentication does the Hive API use?

Hive uses two header-based credentials together: api_key for the workspace key and user_id to identify the calling user. Both are required on every request. Through Jentic, both header values are stored encrypted in your Jentic One instance and injected at execution time.

### Can I create actions and assign them through the Hive API?

Yes. POST `/actions/create` accepts title, project, status, and assignee fields. After creation, PUT `/actions/update-status` moves the action through workflow stages, and POST `/actions/{actionId}/comments` adds collaborative notes.

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

Hive does not publish hard rate limits in its OpenAPI spec. Treat the API as moderate-volume - keep request rates below a few per second per workspace and back off on 429 responses.

### How do I receive real-time Hive events through Jentic?

Search Jentic for 'create hive webhook', load POST to the webhooks resource, and execute with your event types and target URL. Run pip install jentic and use the async SearchRequest, LoadRequest, ExecutionRequest pattern to wire the subscription.

### Can I view the change history for a Hive action?

Yes. GET `/actions/{actionId}/history` returns the audit log for an action, including status transitions, assignee changes, and label edits. Use it to reconstruct who changed what and when.

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

Yes. Because you self-host Jentic One, your own rules decide which Hive operations and credentials the agent may use. Hive puts workspace and action ids in the URL path, such as `/workspaces/{workspaceId}/actions` and `/actions/{actionId}/comments`, so you can pin the agent to a single workspace and the actions within it. You also choose the exact operations it may call, so you can allow reading actions and adding comments while leaving destructive calls like deleting an action or project out unless you add them.