InTouch Hub · Blue Isle Software

Hiver

Manage Gmail-based shared-inbox conversations and tags in Hiver via the Hiver REST API v1.

hivershared-inboxgmailhelpdesk

Hiver

Manage Gmail-based shared-inbox conversations and tags in Hiver via the Hiver REST API v1.

What it does

Hiver is a Gmail-based shared inbox and helpdesk platform. This tool lets you read and update conversations in any shared mailbox and discover the tags available in each inbox.

Operations

Operation Description
list_inboxes List all shared inboxes in the Hiver account
list_conversations List conversations in a shared inbox (paginated)
get_conversation Get a single conversation's full detail
update_conversation Update a conversation's status, assignee, and/or tags
search_tags List or search tags available in a shared inbox

Authentication — API Key setup

  1. Log in to Hiver as an admin.
  2. Go to Admin Panel → Developer section.
  3. Generate a new API key.
  4. Copy the key — it is shown only once.

The key is passed as a Bearer token: Authorization: Bearer <apiKey>.

Requires a Pro plan or higher.

Base URL

https://api2.hiverhq.com/v1

Examples

List all shared inboxes

{
  "apiKey": "YOUR_API_KEY",
  "operation": "list_inboxes"
}

List conversations in an inbox

{
  "apiKey": "YOUR_API_KEY",
  "operation": "list_conversations",
  "inboxId": "12345",
  "limit": "25"
}

Get a specific conversation

{
  "apiKey": "YOUR_API_KEY",
  "operation": "get_conversation",
  "inboxId": "12345",
  "conversationId": "67890"
}

Update a conversation (close it and assign to a user)

{
  "apiKey": "YOUR_API_KEY",
  "operation": "update_conversation",
  "inboxId": "12345",
  "conversationId": "67890",
  "status": "closed",
  "assigneeId": "user_abc"
}

Set tags on a conversation

{
  "apiKey": "YOUR_API_KEY",
  "operation": "update_conversation",
  "inboxId": "12345",
  "conversationId": "67890",
  "tags": "billing, urgent"
}

Search tags in an inbox

{
  "apiKey": "YOUR_API_KEY",
  "operation": "search_tags",
  "inboxId": "12345",
  "tagQuery": "billing"
}

Rate limits

Output

Both result and status are published as step outputs.