Developers
MCP server
Connect AI assistants such as Claude to your account. Tools are generated from the REST API: every endpoint is a tool when your scopes allow it.
Server address
It uses Streamable HTTP and keeps no session. The assistant only sees tools within the API key's scopes or the access you granted: a read-only key can't send messages.
https://hiboty.com/api/mcpWays to connect
- OAuth (recommended): give an OAuth-capable client just the address, then sign in, choose an organization and allow access in your browser. Remove the connection any time under Settings → API.
- API key: send an
Authorization: Bearer hb_live_…header. The key's role and scopes apply as they are.
Setup in clients
claude mcp add --transport http hiboty https://hiboty.com/api/mcpAfter the command, type /mcp inside Claude Code, select the hiboty server and sign in through your browser.
claude mcp add --transport http hiboty https://hiboty.com/api/mcp --header "Authorization: Bearer $HIBOTY_API_KEY"Claude web and desktop: enter the server address under Settings → Connectors → Add custom connector, then allow access in your browser.
{
"mcpServers": {
"hiboty": { "url": "https://hiboty.com/api/mcp" }
}
}{
"servers": {
"hiboty": { "type": "http", "url": "https://hiboty.com/api/mcp" }
}
}{
"url": "https://hiboty.com/api/mcp",
"headers": { "Authorization": "Bearer hb_live_YOUR_API_KEY" }
}curl -X POST "https://hiboty.com/api/mcp" \
-H "Authorization: Bearer $HIBOTY_API_KEY" \
-H "Content-Type: application/json" \
-H "Accept: application/json, text/event-stream" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'Security
- Take care when handing out a key that can message your customers; grant only the scopes needed.
- An assistant or the API can create campaigns, but sending only starts after an admin approves them in the dashboard.
- Message contents, contact names and Mini App submissions are customer data; the server tells the assistant not to follow instructions inside them.
- Assistants see tools with external effects and irreversible tools through hints; keep approval prompts on for these tools in your client.
Tools with external effects
These tools message customers, call external systems or change something on the channel.
- sendMessage
- retryMessage
- createBotDraft
- deleteBot
- connectBot
- disconnectBot
- pauseBot
- resumeBot
- createKnowledgeSource
- refreshKnowledgeSource
- createBotTool
- updateBotTool
- testBotTool
- getBotProfile
- updateBotProfile
- listWhatsAppTemplates
- createWhatsAppTemplate
- deleteWhatsAppTemplate
- refreshBotWebhook
- setBotCommands
- bulkBotAction
- updateConversationStatus
- assignConversation
- replyToConversation
- bulkConversations
- createCampaign
- addGrowthCampaignSource
- updateOrder
- deleteMiniApp
- publishMiniApp
- unpublishMiniApp
- rollbackMiniApp
- setMiniAppMenuButton
- importMiniAppFeed
- approveMiniAppVersion
- createWebhook
- updateWebhook
- enableWebhook
- testWebhook
- createCustomMiniAppRequest
- acceptCustomMiniAppQuote
- approveCustomMiniAppPreview
- cancelCustomMiniAppRequest
- refreshCommunityMembers
- createCommunityInviteLink
- revokeCommunityInviteLink
- createScheduledPost
- publishScheduledPost
- approveScheduledPost
- resendUncertainPost
- updateOrganization
- updateAiSettings
- saveStore
- testStore
- saveCrmConnection
- testCrmConnection
- createTeamInvitation
- revokeApiKey
- revokeConnectedApp
Tool list
228 tools. The tool name is the OpenAPI operationId; the input schema comes from the endpoint (path and query parameters are flat, the body goes under body, Idempotency-Key becomes idempotency_key).
See the API reference for parameters and samples.
Messages
| Tool | What it does | Scope | Type |
|---|---|---|---|
| sendMessage | Sends a message to a contact | messages:send | write, external effect |
| listMessages | Lists a conversation's messages from newest to oldest | read | read-only |
| retryMessage | Retries a failed message | conversations:write | write, external effect |
| rateAiReply | Rates an AI reply | conversations:write | write |
Bots
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listBots | Lists the organization's bots | read | read-only |
| createBot | Creates a bot | bots:write | write |
| listBotTemplates | Lists gallery templates | bots:read | read-only |
| createBotDraft | Generates a bot draft with AI (saves nothing) | bots:write | write, external effect |
| importBot | Creates a new draft bot from a bot file | bots:write | write |
| previewBotImport | Validates a bot file without saving | bots:write | write |
| getBot | Bot details | bots:read | read-only |
| updateBot | Updates bot and AI settings | bots:write | write |
| deleteBot | Deletes a bot | bots:write | write, external effect, irreversible |
| connectBot | Connects a bot to its channel | bots:write | write, external effect |
| disconnectBot | Removes the channel connection | bots:write | write, external effect, irreversible |
| pauseBot | Pauses a bot | bots:write | write, external effect |
| resumeBot | Resumes a bot | bots:write | write, external effect |
| getBotReadiness | Go-live readiness check | bots:read | read-only |
| exportBot | Exports the bot file | bots:read | read-only |
| testBotReply | Tries an AI reply | bots:write | write |
| listKnowledgeSources | Lists knowledge sources | bots:read | read-only |
| createKnowledgeSource | Adds a knowledge source | bots:write | write, external effect |
| getKnowledgeSource | A knowledge source's content | bots:read | read-only |
| updateKnowledgeSource | Updates a knowledge source | bots:write | write |
| deleteKnowledgeSource | Deletes a knowledge source | bots:write | write, irreversible |
| refreshKnowledgeSource | Fetches a URL source again | bots:write | write, external effect |
| listBotTools | Lists custom AI tools | bots:read | read-only |
| createBotTool | Adds a custom AI tool | bots:write | write, external effect |
| updateBotTool | Updates a custom AI tool | bots:write | write, external effect |
| deleteBotTool | Deletes a custom AI tool | bots:write | write, irreversible |
| testBotTool | Calls a custom tool with sample input | bots:write | write, external effect |
| listBotVersions | Lists configuration versions | bots:read | read-only |
| getBotVersion | Version diff and restore preview | bots:read | read-only |
| restoreBotVersion | Restores a version | bots:write | write, irreversible |
| getBotProfile | Channel profile texts | bots:read | read-only, external effect |
| updateBotProfile | Writes profile texts to the channel | bots:write | write, external effect, irreversible |
| suggestBotProfile | Generates a profile suggestion with AI | bots:write | write |
| listBotEvalCases | Lists AI evaluation cases | bots:read | read-only |
| createBotEvalCase | Adds an evaluation case | bots:write | write |
| updateBotEvalCase | Updates an evaluation case | bots:write | write |
| deleteBotEvalCase | Deletes an evaluation case | bots:write | write, irreversible |
| listBotEvalRuns | Lists evaluation runs | bots:read | read-only |
| runBotEval | Runs an evaluation | bots:write | write |
| getBotEvalRun | Run results | bots:read | read-only |
| listAcquisitionLinks | Lists acquisition links | bots:read | read-only |
| createAcquisitionLink | Creates an acquisition link | bots:write | write |
| deleteAcquisitionLink | Deletes an acquisition link | bots:write | write, irreversible |
| listWhatsAppTemplates | All WhatsApp templates | bots:read | read-only, external effect |
| createWhatsAppTemplate | Creates a WhatsApp template | bots:write | write, external effect |
| deleteWhatsAppTemplate | Deletes a WhatsApp template | bots:write | write, external effect, irreversible |
| listAiFeedback | Lists disliked AI replies | bots:read | read-only |
| resolveAiFeedback | Resolves a disliked reply | bots:write | write |
| listTemplates | A WhatsApp bot's approved templates | read | read-only |
| refreshBotWebhook | Sets up the Telegram webhook again | bots:write | write, external effect |
| setBotCommands | Sets up the Telegram command menu | bots:write | write, external effect |
| getBotPaymentSettings | Gets the card payment setting | bots:read | read-only |
| updateBotPaymentSettings | Saves the card payment provider token | bots:write | write |
| listPublishApprovals | Lists changes awaiting approval | bots:read | read-only |
| approveBotVersion | Approves a pending bot change | bots:write | write |
| rejectBotVersion | Rejects a pending bot change | bots:write | write |
| bulkBotAction | Bulk action on several bots | bots:write | write, external effect |
| runAllBotEvaluations | Runs the evaluation set on all bots | bots:write | write |
| getFleetEvaluation | Fleet evaluation summary | bots:read | read-only |
| listOrgBotTemplates | Lists the organization's bot templates | bots:read | read-only |
| createOrgBotTemplate | Saves a bot as a template | bots:write | write |
| getOrgBotTemplate | Gets an organization template | bots:read | read-only |
| updateOrgBotTemplate | Renames a template or changes its description | bots:write | write |
| deleteOrgBotTemplate | Deletes a template | bots:write | write, irreversible |
| createBotFromOrgTemplate | Creates a bot from a template | bots:write | write |
| listWhatsAppAccounts | Lists WhatsApp accounts | bots:read | read-only |
| getWhatsAppAccount | Gets a WhatsApp account | bots:read | read-only |
| listWhatsAppAccountTemplates | Lists a WhatsApp account's templates | bots:read | read-only |
Contacts
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listContacts | Lists contacts from newest to oldest | read | read-only |
| createContact | Creates a contact | contacts:write | write |
| getContact | Returns a single contact (including tags, notes and custom fields) | read | read-only |
| updateContact | Updates name, notes, tags and custom fields | write | write |
| deleteContact | Permanently deletes a contact (GDPR) | contacts:write | write, irreversible |
| getContactConsent | Current consent and consent history (newest first, up to 50) | read | read-only |
| updateContactConsent | Updates messaging consent (and optional tags) | write | write, irreversible |
| importContacts | Imports contacts from CSV text | contacts:write | write |
| exportContacts | Exports contacts as CSV chunks | contacts:read | read-only |
| bulkContacts | Applies a bulk action to contacts | contacts:write | write, irreversible |
| clearContactMemory | Clears the contact's AI memory | contacts:write | write, irreversible |
| revokeContactLinks | Revokes links sent to the contact | contacts:write | write, irreversible |
| linkContactProfile | Links the record to another record's customer profile | contacts:write | write |
| unlinkContactProfile | Removes the record from its customer profile | contacts:write | write, irreversible |
| listContactTags | Lists tags with usage counts | contacts:read | read-only |
| renameContactTag | Renames a tag | contacts:write | write, irreversible |
| mergeContactTags | Merges tags into one | contacts:write | write, irreversible |
| deleteContactTags | Removes tags from all contacts | contacts:write | write, irreversible |
| listContactFields | Lists custom field definitions | contacts:read | read-only |
| createContactField | Creates a custom field | contacts:write | write |
| updateContactField | Updates a custom field | contacts:write | write, irreversible |
| deleteContactField | Deletes a custom field | contacts:write | write, irreversible |
Conversations
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listConversations | Lists conversations by latest message | read | read-only |
| updateConversationStatus | Changes the conversation status | write | write, external effect |
| getConversation | Conversation details | conversations:read | read-only |
| assignConversation | Assigns a conversation to a team member | conversations:write | write, external effect |
| markConversationRead | Marks a conversation as read | conversations:write | write |
| snoozeConversation | Snoozes a conversation | conversations:write | write |
| clearConversationFlood | Clears the message flood pause | conversations:write | write |
| replyToConversation | Sends an agent reply | messages:send | write, external effect |
| listConversationNotes | Lists internal notes | conversations:read | read-only |
| createConversationNote | Adds an internal note | conversations:write | write |
| deleteConversationNote | Deletes an internal note | conversations:write | write, irreversible |
| bulkConversations | Runs a bulk action on conversations | conversations:write | write, external effect |
Campaigns
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listCampaigns | Lists campaigns | read | read-only |
| createCampaign | Creates a campaign (awaits approval) | write | write, external effect |
| getCampaign | Campaign and variant results | read | read-only |
| updateCampaign | Updates a campaign that hasn't started | campaigns:write | write |
| deleteCampaign | Deletes a campaign that was never sent | campaigns:write | write, irreversible |
| cancelCampaign | Cancels an unfinished campaign | write | write, irreversible |
| getCampaignResults | Variant results and the A/B decision | campaigns:read | read-only |
| countCampaignAudience | Counts opted-in contacts matching a segment | campaigns:read | read-only |
| getCampaignBestTime | Suggested send time | campaigns:read | read-only |
| listGrowthCampaigns | Lists growth campaigns | campaigns:read | read-only |
| createGrowthCampaign | Creates a growth campaign | campaigns:write | write |
| getGrowthCampaign | Gets a growth campaign | campaigns:read | read-only |
| updateGrowthCampaign | Updates a growth campaign | campaigns:write | write |
| deleteGrowthCampaign | Deletes a growth campaign | campaigns:write | write, irreversible |
| getGrowthCampaignReport | Growth campaign funnel and source comparison | campaigns:read | read-only |
| addGrowthCampaignSource | Links a source to the campaign or opens a new link | campaigns:write | write, external effect |
| removeGrowthCampaignSource | Removes a source from the campaign | campaigns:write | write, irreversible |
Mini Apps
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listMiniApps | Lists Mini Apps | read | read-only |
| createMiniApp | Creates a Mini App | miniapps:write | write |
| listMiniAppSubmissions | Mini App submissions and orders | read | read-only |
| getOrder | Order details | miniapps:read | read-only |
| updateOrder | Changes the order status | write | write, external effect |
| getMiniApp | Mini App details | miniapps:read | read-only |
| updateMiniAppDraft | Updates the draft | miniapps:write | write |
| deleteMiniApp | Deletes a Mini App | miniapps:write | write, external effect, irreversible |
| publishMiniApp | Publishes the draft | miniapps:write | write, external effect |
| unpublishMiniApp | Unpublishes the app | miniapps:write | write, external effect |
| rollbackMiniApp | Rolls back to an earlier version | miniapps:write | write, external effect |
| setMiniAppMenuButton | Sets the Telegram menu button | miniapps:write | write, external effect |
| listMiniAppVersions | Lists versions | miniapps:read | read-only |
| getMiniAppPreview | Draft preview | miniapps:read | read-only |
| listOrders | Lists orders | miniapps:read | read-only |
| importMiniAppFeed | Imports a product feed into the catalog | miniapps:write | write, external effect, irreversible |
| approveMiniAppVersion | Publishes a Mini App version awaiting approval | miniapps:write | write, external effect |
| rejectMiniAppVersion | Rejects a Mini App version awaiting approval | miniapps:write | write |
Automations
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listAutomations | Lists automations | read | read-only |
| createAutomation | Creates an automation | automations:write | write |
| getAutomation | Automation details | automations:read | read-only |
| saveAutomation | Saves an automation | automations:write | write |
| updateAutomation | Activates or stops an automation | write | write, irreversible |
| deleteAutomation | Deletes an automation | automations:write | write, irreversible |
| listAutomationRuns | Lists an automation's runs | automations:read | read-only |
Webhooks
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listWebhooks | Lists webhooks | read | read-only |
| createWebhook | Creates a webhook | write | write, external effect |
| getWebhook | Webhook details | webhooks:read | read-only |
| updateWebhook | Updates a webhook | webhooks:write | write, external effect |
| deleteWebhook | Deletes a webhook | write | write, irreversible |
| enableWebhook | Turns a disabled webhook back on | write | write, external effect |
| listWebhookDeliveries | Lists delivery history | webhooks:read | read-only |
| testWebhook | Sends a test event (ping) | webhooks:write | write, external effect |
System
| Tool | What it does | Scope | Type |
|---|---|---|---|
| getUsage | Plan and this month's usage | read | read-only |
Custom Mini Apps
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listCustomMiniAppRequests | Lists custom Mini App requests | miniapps:read | read-only |
| createCustomMiniAppRequest | Opens a custom Mini App request | miniapps:write | write, external effect |
| getCustomMiniAppRequest | Custom Mini App request details | miniapps:read | read-only |
| acceptCustomMiniAppQuote | Accepts the quote | miniapps:write | write, external effect, irreversible |
| approveCustomMiniAppPreview | Approves the preview | miniapps:write | write, external effect, irreversible |
| cancelCustomMiniAppRequest | Cancels the request | miniapps:write | write, external effect, irreversible |
Saved replies
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listSavedReplies | Lists saved replies | conversations:read | read-only |
| createSavedReply | Adds a saved reply | conversations:write | write |
| getSavedReply | Saved reply details | conversations:read | read-only |
| updateSavedReply | Updates a saved reply | conversations:write | write |
| deleteSavedReply | Deletes a saved reply | conversations:write | write, irreversible |
Reports
| Tool | What it does | Scope | Type |
|---|---|---|---|
| getReportOverview | Report overview | reports:read | read-only |
| getDeliveryTelemetry | Delivery telemetry | reports:read | read-only |
| getAgentReport | Agent performance | reports:read | read-only |
| getCsatReport | Satisfaction report | reports:read | read-only |
| getAiQualityReport | AI quality report | reports:read | read-only |
| getCohortReport | Audience cohorts | reports:read | read-only |
| getRevenueReport | Revenue attribution and ROI | reports:read | read-only |
| getUsageReport | Plan and usage | reports:read | read-only |
| setReportCost | Sets the cost of a campaign or link | campaigns:write | write |
| importReportCosts | Imports ad costs | campaigns:write | write |
Communities
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listCommunities | Lists Telegram communities | communities:read | read-only |
| getCommunity | Community details | communities:read | read-only |
| updateCommunity | Updates community settings | communities:write | write |
| removeCommunity | Removes a community | communities:write | write, irreversible |
| refreshCommunityMembers | Refreshes the member count from Telegram | communities:write | write, external effect |
| listCommunityInviteLinks | Lists invite links | communities:read | read-only |
| createCommunityInviteLink | Creates an invite link | communities:write | write, external effect |
| revokeCommunityInviteLink | Revokes an invite link | communities:write | write, external effect, irreversible |
Scheduled posts
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listScheduledPosts | Lists scheduled posts | communities:read | read-only |
| createScheduledPost | Schedules a post or publishes it now | communities:write | write, external effect |
| getPostCalendar | Returns a month's calendar with its posts | communities:read | read-only |
| getScheduledPost | Scheduled post details | communities:read | read-only |
| updateScheduledPost | Edits a scheduled post | communities:write | write |
| cancelScheduledPost | Cancels a scheduled post | communities:write | write, irreversible |
| publishScheduledPost | Publishes a post now | communities:write | write, external effect |
| approveScheduledPost | Approves a pending post | communities:write | write, external effect |
| rejectScheduledPost | Rejects a pending post | communities:write | write |
| resendUncertainPost | Resends a post with an unknown outcome | communities:write | write, external effect |
Organization
| Tool | What it does | Scope | Type |
|---|---|---|---|
| getOrganization | Gets the organization settings | organization:read | read-only |
| updateOrganization | Updates the organization settings | organization:write | write, external effect, irreversible |
| getContentPolicy | Gets the content policy | organization:read | read-only |
| updateContentPolicy | Replaces the content policy | organization:write | write |
| getAiSettings | Gets the AI settings | organization:read | read-only |
| updateAiSettings | Updates the AI settings | organization:write | write, external effect |
| listStores | Lists store connections | organization:read | read-only |
| saveStore | Saves a store connection | organization:write | write, external effect |
| deleteStore | Removes a store connection | organization:write | write, irreversible |
| testStore | Tests a store connection | organization:write | write, external effect |
| listCrmConnections | Lists CRM connections | organization:read | read-only |
| saveCrmConnection | Saves a CRM connection | organization:write | write, external effect |
| deleteCrmConnection | Removes a CRM connection | organization:write | write, irreversible |
| testCrmConnection | Tests a CRM connection | organization:write | write, external effect |
| listConnections | Lists connections | organization:read | read-only |
Media
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listMedia | Lists the media library | organization:read | read-only |
| uploadMedia | Uploads an image | organization:write | write |
| getMediaUsage | Gets where an image is used | organization:read | read-only |
| deleteMedia | Deletes an image | organization:write | write, irreversible |
Audit log
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listAuditLogs | Lists the audit log | organization:read | read-only |
Team
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listTeamMembers | Lists team members | team:read | read-only |
| updateTeamMember | Changes a member's role and bot access | team:write | write, irreversible |
| removeTeamMember | Removes a member from the team | team:write | write, irreversible |
| listTeamInvitations | Lists pending invitations | team:read | read-only |
| createTeamInvitation | Sends a team invitation | team:write | write, external effect |
| cancelTeamInvitation | Cancels an invitation | team:write | write, irreversible |
API keys
| Tool | What it does | Scope | Type |
|---|---|---|---|
| listApiKeys | Lists API keys | api_keys:read | read-only |
| revokeApiKey | Revokes an API key | api_keys:write | write, external effect, irreversible |
| listConnectedApps | Lists apps connected with OAuth | api_keys:read | read-only |
| revokeConnectedApp | Removes a connected app's access | api_keys:write | write, external effect, irreversible |
| getApiRequestLog | API request log | api_keys:read | read-only |
Billing
| Tool | What it does | Scope | Type |
|---|---|---|---|
| getBilling | Gets the plan, limits, usage and subscription state | organization:read | read-only |