View as Markdown
Hiver for Gmail icon

Hiver for Gmail ACTION

Get Inbox

Get an inbox by ID. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Hiver for Gmail account once, then configure and run Get Inbox from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "hiver-get-inbox",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hiver: { authProvisionId: "apn_xxxxxxx" },
    inboxId: "Inbox ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Inbox inputs
Property Type Description
inboxId Inbox ID string
The ID of the Hiver inbox
Required Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
hiver-get-inbox
Version
0.0.1
App
Hiver for Gmail
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes