SDKs, MCP, and events for AI agents

Give your agents the facts behind the answer.

Add support to your app, verify who is asking, and connect the tools an agent needs. The Echo agent can check permitted account facts, while coding agents work from real reports.

Open source · Self-host free, or let us run it

OOrbitDesk/Connected workspace

Your app starts the conversation. Agents work with the tools you connect.

Support inside your product

Put the Echo agent inside your product.

Open chat from your own interface and link it to the signed-in customer and company. The Echo agent and your team can pick up the conversation in Helpin.

npm install @helpin-ai/[email protected]

Open a conversation from your app.

support.ts
import { helpinClient } from '@helpin-ai/sdk-js';

const client = helpinClient({
  widgetKey: 'YOUR_PUBLIC_WIDGET_KEY',
  host: 'https://client.helpin.ai',
  autoBoot: false,
});

client?.openNewMessage(
  'My export is missing contacts. Can you help?'
);
A QUESTION FROM INSIDE YOUR PRODUCT
Talk to your team

Open a conversation from your application, then keep talking in the Helpin widget.

Use your widget’s public key and host. For self-hosting, set host to your installation’s public widget URL.

Start from your own interface.

Use a custom launcher, prepare an opening message, or reopen an existing conversation.

Connect the person and company.

Identify signed-in customers so the conversation has a clear account context.

Open the relevant guide.

Bring an article into the widget from your product’s help menu or interface.

Know who’s asking

Verify the customer. Limit the lookup.

Verify the person behind the conversation and choose which tools agents can use to investigate. Customer identity and permission to access data are separate controls.

How does identity verification work?

Your backend signs an identity proof with HMAC-SHA256. Helpin validates the proof when the widget identifies the customer. Keep the signing secret on your server, and turn on “Require server-signed identities” to reject unsigned ones. Set up customer identity →

Does verification unlock access to customer data?

No. You choose the agent’s tools and approval rules separately. Your connected tool server must also enforce which customer’s data it can return. Configure tool access →

OOrbitDesk · Illustrative workflow
Connect your AI tools · Controlled beta

Connect your AI tools in either direction.

AI clients and integrations work with Helpin through OAuth or a scoped service token. Helpin agents can use tools from other MCP servers.

Use Helpin from your AI client.

Let an authorized AI client or integration search your docs and use the workspace capabilities you grant. A workspace manager turns it on.

OOrbitDesk/Helpin MCP
Find our contact export guide.
Claude CodeThinking…
Set up public MCP

Give agents a way to check the facts.

Connect an external MCP server and select the tools each agent can use, with approvals where required. The deployment must enable external servers first.

OOrbitDesk/External MCP
Check the issue before I update Maya.
Helpin AIWorkspace assistantThinking…
Connect an external tool server
From an event to the next step

Start an agent when work changes.

A pull request opens. A task changes stage. A scheduled check is due. Use a matching automation rule to start the agent with the tools and approvals you selected.

Inspect trigger activity, including skipped events, separately from agent runs.

Explore agents and automation
OOrbitDesk/Pull request automation
PR #728 opened · Fix incomplete exportsGitHub · Matching rule
LensReview agentRun started by automation
Questions, answered

FAQs about Helpin’s developer tools

Where should I start?

Use an SDK to put support inside your product. Use MCP to connect AI clients and integrations to your workspace, or to give Helpin agents tools from other systems.

Which SDK should I use?

@helpin-ai/sdk-js for any web app, @helpin-ai/react for React, @helpin-ai/nextjs for Next.js, and @helpin-ai/vue for Vue 3 and Nuxt. Install the framework package alongside @helpin-ai/sdk-js.

Can I use the SDK with self-hosted Helpin?

Yes. Set host to your installation’s public widget URL and add your site to the permitted website origins.

Is my widget key also an API credential?

No. The widget key is public and only identifies your widget. Integrations reach your workspace through MCP, with OAuth or a scoped service token, and identity signing uses a separate server secret.

How does Helpin verify a customer?

Your backend signs an identity proof with HMAC-SHA256, and Helpin checks it when the widget identifies the customer. Turn on “Require server-signed identities” to reject unsigned identities; until then, they’re accepted as unverified. Verification doesn’t grant access to connected tools.

What is the difference between the two MCP connections?

Public MCP lets an external AI client or integration work with Helpin. External MCP lets a Helpin agent use tools from another system.

Is MCP available in every workspace?

Both connections are in controlled beta. A workspace manager turns on public MCP; external MCP servers must first be enabled for the deployment. What each connection can do depends on granted scopes, user permissions, and enabled modules.

Which events can start agent work?

GitHub and GitLab repository events, such as a pull request opened, merged, or closed, or a review requested, plus workspace events and schedules. A matching automation rule starts the selected agent with its tools and approvals. Outbound webhooks aren’t available yet.

Start building

Connect one useful tool. Give an agent a real job.

Start a free Cloud trial, or self-host the open-source edition and build against your own installation.

Open source · Self-host free, or let us run it