Reference · built on requestConnectorSupport & service desks

Hiver

Shared inboxes, conversations, users, tags, and notes from Hiver, the Gmail-based shared inbox, through its REST API v1.

About

Hiver turns a Gmail mailbox into a shared inbox for a team. Each inbox holds conversations, which are Gmail threads carrying a status, an assignee, and tags, plus the users who belong to the inbox and the notes they leave for one another. The API is served at api2.hiverhq.com/v1 and addresses a conversation by its Hiver id or its Gmail thread id.

Through Fibric, an operator lists the conversations in an inbox, reads their status, assignee, and tags, and proposes a note, a shared draft, an assignment, or a status or tag change for your approval. Requests are paced to one per second and to the daily quota. Each approved change runs once and leaves a record of what changed in the inbox, why, and how to reverse it.

This is a reference listing. It documents what Fibric would read from Hiver and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Inboxes through GET /inboxes, with display_name, channel_type, email, inbox_type, and is_authorised
  • Conversations in an inbox, with status, assignee_type, assignee_id, and tag_ids
  • A single conversation fetched by Hiver conversation id or Gmail thread id
  • Inbox users through GET /inboxes/{inbox_id}/users, with name, email, phone_number, and is_joined
  • Inbox tags through GET /inboxes/{inbox_id}/tags, with name, color_code, and type

Proposed actions

  • Target capability: propose a status, assignee, or tag change through PATCH /inbox/{inbox_id}/conversations/{conversation_id}
  • Target capability: propose a note with @mentions through POST /inboxes/{inboxId}/conversations/{conversationId}/notes
  • Target capability: propose a shared draft on a conversation for a teammate to review and send from Gmail
  • Target capability: propose a new tag in an inbox through POST /inboxes/{inbox_id}/tags

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Sweep the unassigned queue

    The operator lists open conversations with no assignee in each inbox and proposes an assignment to an inbox user, with a note that says why.

    With Backlog Sweep

  • Assemble an escalation

    When a conversation carries the escalation tag, the operator gathers its status, assignee, and tags and proposes a note that @mentions the owner with a summary.

    With Escalation Packet

  • Draft the first reply

    For conversations that have waited without an assignee, the operator proposes a shared draft and an assignment so a teammate can edit and send from Gmail.

    With First Response

Requirements

  • A Hiver shared inbox on a Gmail mailbox
  • An API key issued by an administrator; the key carries the access privileges of an admin user
  • The inbox_id of each shared inbox the operator should read
  • Retry with exponential backoff on 429 Too Many Requests, as the introduction recommends
Authentication
A Hiver API key created by an administrator under Developer settings, sent as a bearer token in the Authorization header.

Limits

  • One request per second per account and 5000 requests per day; a request over either limit returns 429 Too Many Requests
  • List endpoints return 10 items by default and at most 100 per page, followed through the next_page token until it is null
  • The reference documents no webhooks, so new mail is found by polling the conversations in each inbox
  • Gmail thread ids in responses are scoped to the user authenticated with the shared mailbox email address

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Hiver ↗

Questions and answers

What rate limits does the Hiver API apply?
One request per second per account, and 5000 requests per day. A request over either limit returns 429 Too Many Requests. The introduction recommends retrying with exponential backoff. List endpoints take a limit between 10 and 100 and return a next_page token.
Can a conversation be addressed by its Gmail thread id?
Yes. The conversation_id path parameter accepts either the Hiver conversation id or the Gmail thread id. Thread ids returned in responses are scoped to the user authenticated with the shared mailbox email address.
Does the Hiver API send email on its own?
The reference lists a POST that creates a shared draft on a conversation and a POST that adds a note with mentions, notify_all, and threaded replies through parent_note_id. It lists no endpoint that sends mail. A person sends the draft from Gmail.
Ask about Hiver

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.