CONNECT APP
Build with Hiver for Gmail
Help Desk & Support
- API key
MCP
Give your agent Hiver for Gmail tools
Every Hiver for Gmail action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Hiver for Gmail account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "hiver",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Get Inbox:
const result = await mcp.callTool({
name: "hiver-get-inbox",
arguments: {
inboxId: "Inbox ID",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "hiver",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Get Inbox:
result = await session.call_tool("hiver-get-inbox", {
"inboxId": "Inbox ID",
})API PROXY
Call the Hiver for Gmail API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Hiver for Gmail API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api2.hiverhq.com/v1/inboxes",
})
// Any allowed Hiver for Gmail endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api2.hiverhq.com/v1/inboxes
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkyLmhpdmVyaHEuY29tL3YxL2luYm94ZXM?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Hiver for Gmail actions from your backend
Connect a user's Hiver for Gmail account once, then run Get Inbox on their behalf from your own code — TypeScript, Python, or plain HTTP.
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",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="hiver-get-inbox",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"hiver": {"authProvisionId": "apn_xxxxxxx"},
"inboxId": "Inbox ID",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "hiver-get-inbox",
"configured_props": {
"hiver": { "authProvisionId": "apn_xxxxxxx" },
"inboxId": "Inbox ID"
}
}'TOOLS
Hiver for Gmail actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Get Inbox
actionGet an inbox by ID. See the documentationRead-onlyv0.0.1 -
List All Conversations In Inbox
actionGet all conversations in a Hiver inbox. See the documentationRead-onlyv0.0.2 -
List All Inboxes
actionList all the inboxes in your Hiver account. See the documentationRead-onlyv0.0.2 -
List All Tags In Inbox
actionGet all tags associated with a Hiver inbox. See the documentationRead-onlyv0.0.2 -
List All Users In Inbox
actionGet all users associated with a Hiver inbox. See the documentationRead-onlyv0.0.2
EVENTS
Hiver for Gmail triggers
Event sources your backend can deploy for users and receive through a webhook.
No Hiver for Gmail triggers are available yet.
- App slug
- hiver
- Authentication
- API key
- Categories
- Help Desk & Support
- Actions
- 5
- Triggers
- 0
- API proxy
- Available