Developers

Changelog

A short summary of the main changes in API, MCP and SDK releases. The newest entry is on top.

1.10.0 · November 17, 2026

  • WhatsApp accounts (WABA): GET /api/v1/whatsapp-accounts, GET /api/v1/whatsapp-accounts/{id} (account status, last sync, and the quality, messaging limit and deliverability score of its numbers) and GET /api/v1/whatsapp-accounts/{id}/templates; the access token and App Secret are never returned, only access_token_set and app_secret_set.
  • The bot object gains whatsapp_account_id: the WhatsApp account record the number belongs to.
  • The POST /api/v1/bots/{id}/connect body accepts an optional business_id (Meta business portfolio ID), stored on the WhatsApp account record.
  • GET /api/v1/connections?kind=&status=: a secret-free unified list of connections for Telegram bots, WhatsApp numbers and accounts, stores, CRM, AI tools, webhooks, OAuth apps and product feeds, filtered by kind and status.
  • The new endpoints are available in the JavaScript and Python SDKs and the MCP server.

1.9.0 · November 17, 2026

  • The bot object gains WhatsApp number health: whatsapp_quality (GREEN, YELLOW, RED, UNKNOWN), whatsapp_messaging_limit and whatsapp_quality_at; campaigns don't start while quality is RED.
  • The bot object gains a deliverability score: delivery_score (0–100 from the last 30 days' delivery, read, error, block and opt-out rates; null with too little data), delivery_score_reasons and delivery_score_at.
  • The campaign object gains best_time (automatically scheduled at the best time), paused_at and pause_reason (automatic pause: hata_orani or kalite_red).
  • best_time: true in the POST /api/v1/campaigns body: the send time is chosen from the bot's past engagement with the organization's time zone, quiet hours and business-hours rules; combined with scheduled_at it returns 400, and with no suggestion 409 best_time_unavailable.
  • Organization bot templates: GET/POST /api/v1/bot-templates, GET/PATCH/DELETE /api/v1/bot-templates/{id} and POST /api/v1/bot-templates/{id}/bots to create a bot from a template; templates carry no secrets, and new tool signing secrets are returned once, only in the creation response.
  • Telegram growth campaigns: GET/POST /api/v1/growth-campaigns, GET/PATCH/DELETE /api/v1/growth-campaigns/{id}, GET /api/v1/growth-campaigns/{id}/report (clicks, starts, new and activated contacts, joins, cost), plus POST /api/v1/growth-campaigns/{id}/sources to link a source and DELETE /api/v1/growth-campaigns/{id}/sources/{source_id} to unlink it.
  • The new endpoints are available in the JavaScript and Python SDKs and the MCP server.

1.8.0 · November 17, 2026

  • GET /api/v1/reports/usage?group_by=bot|channel: this month's outgoing messages, AI replies, media and Meta estimate per bot or channel in a breakdown field; the rows add up to the overall total.
  • GET /api/v1/usage gains plan_limit (the plan's quota) and extra_credits (remaining extra message balance) in the messages object; limit is now this month's actual limit including the extra balance.
  • Source attribution: messages in GET /api/v1/messages/list carry ai_sources (the knowledge source chunks the reply relied on; an empty array is an out-of-source reply, null means no attribution record). With the bot field show_source_links on, a reply based on a URL source ends with a source link for the customer; voice replies don't read this line aloud.
  • GET /api/v1/reports/ai-quality gains the out-of-source rate: attributed_replies, unsourced_replies and unsourced_rate.
  • GET /api/v1/reports/revenue: click-to-WhatsApp ads appear in the ads list and totals.ads, store orders matched to a bot conversation in totals.store; costs in several currencies are returned in cost.mixed, and the manually entered value is in manual_cost.
  • POST /api/v1/reports/costs/import: imports period costs for campaigns, acquisition links and ads from CSV or a list of rows; invalid rows are returned in errors.
  • POST /api/v1/bots/bulk: pauses, resumes or bulk-updates the settings of selected bots; the response returns a result per bot (partial success).
  • POST /api/v1/bots/evaluations/run-all (estimate first with dry_run, then confirm the budget with max_responses) and GET /api/v1/bots/evaluations (each bot's latest run pass rate and the change from the previous run).
  • The new endpoints are available in the JavaScript and Python SDKs and the MCP server.

1.7.0 · November 17, 2026

  • Tiered rate limits: requests are limited per key, per user (OAuth) and by the organization's per-minute and daily totals. When a tier is exceeded, 429 rate_limited carries that tier's X-RateLimit-* values and an X-RateLimit-Scope header naming the exceeded tier (key, user, organization, organization_day); follow the Retry-After header.
  • Storage quota: the total size of uploaded images is limited by the plan's quota; once it is full, POST /api/v1/media returns 413 storage_quota_exceeded. GET /api/v1/usage gains storage (used_bytes, limit_bytes) and the billing view gains limits.storage_mb and usage.storage_bytes.
  • Python SDK: fixed the syntax that made import hiboty fail on Python 3.9–3.11 in published releases up to and including 1.6.0; the SDK runs on Python 3.9 and later again.

1.6.0 · November 17, 2026

  • Publish approval (four-eyes): GET /api/v1/publish-approvals, POST /api/v1/bots/{id}/versions/{version_id}/approve|reject and POST /api/v1/miniapps/{id}/versions/{version_id}/approve|reject. While approval is on, bot setting, tool and knowledge source changes return 202 pending_approval, a restore waits for approval with new_version: null and pending_approval: true, and a Mini App publish opens a pending version.
  • Version fields: tools_changed, sources_changed, tool_changes and source_changes on bot versions; config_sha256 and status (published, pending, rejected) on Mini App versions.
  • POST /api/v1/bots/{id}/commands (setBotCommands): sets the Telegram command menu. GET/PUT /api/v1/bots/{id}/payments: the Telegram card payment provider token; the token is never returned.
  • The order payment object gains method (telegram_stars, telegram_card), currency and amount (in the smallest unit).
  • POST /api/v1/miniapps/{id}/feed-import: imports a Google Merchant XML/RSS, CSV or JSON product feed into the catalog draft (dry_run, auto_refresh, ai_knowledge).
  • Scheduled posts: a whatsapp block opens a WhatsApp campaign draft from the same content, pending approval (whatsapp_campaign); posts return button clicks in clicks.
  • Bot fields reply_language (fixed reply language, null for automatic), appointment_tool and cancel_request_tool; these settings aren't part of version history. Mini App submission kind can now also be randevu or iptal_talebi.
  • The new endpoints are available in the JavaScript and Python SDKs and the MCP server.

1.5.0 · November 16, 2026

  • Every /api/v1 response carries a Hiboty-Api-Version header.
  • GET /api/v1/usage/requests: request count, error rate, p95 latency and recent requests for the last days (admin, api_keys:read).
  • CRM connections: GET/POST/DELETE /api/v1/integrations/crm and POST /api/v1/integrations/crm/test (HubSpot and Pipedrive, with the customer's own token).
  • Bot field voice_reply: voice replies to voice messages (kapali, sesliye_sesli, her_zaman).
  • Read-only legal_hold and legal_hold_at on the organization; while a legal hold is on, deleting contacts returns 409 legal_hold.
  • The new endpoints are available in the JavaScript and Python SDKs and the MCP server.

1.4.1 · November 14, 2026

  • JavaScript and Python SDK 1.4.1: type and documentation fixes only; behavior doesn't change. hiboty.d.ts includes the fields below and the WebhookOlayi type.
  • GET /api/v1/reports/overview: usage.ai_replies gained effective_limit (the AI cap in effect; null with an own key) and own_key (own AI key).
  • GET /api/v1/reports/usage and GET /api/v1/billing: limits.workspaces gives the plan's workspace allowance.
  • GET /api/v1/templates: returns the template body. POST /api/v1/bots/import/preview: returns bot settings, knowledge sources and tools in detail.
  • Webhook events fields are the WebhookOlayi enum in OpenAPI; an unknown event name returns 400.
  • Store connections gained a wa_template field: when the WhatsApp window is closed, order notifications go out with this template.
  • Sending from a bot over the plan limit returns 403 bot_plan_restricted.
  • Creating a campaign requires a verified email for whoever created the key; otherwise it returns 403 email_not_verified.

1.4.0 · November 6, 2026

  • New endpoint groups: organization, content policy, AI settings, stores, media, audit, subscription, team, communities, invite links, scheduled posts, conversations, canned replies and reports.
  • Campaign update, delete, results, audience count and best time endpoints; automation, Mini App, order and custom request endpoints were extended.
  • Resource scopes were added (such as contacts:read); existing keys don't gain permissions on their own.
  • GET /api/v1/bots is paginated with a cursor; POST /api/v1/bots/{id}/refresh-webhook was added.
  • All new endpoints are available in the JavaScript and Python SDKs and in the MCP server.

1.3.0 · November 5, 2026

  • Bot management opened up in the API, MCP and SDKs: creation, channel connection, AI settings, knowledge sources, custom tools, versions, showcase, transfer, evaluation, acquisition links, WhatsApp templates and AI feedback.
  • New scopes: bots:read and bots:write.

1.2.0 · November 5, 2026

  • POST /api/v1/messages and POST /api/v1/campaigns support Idempotency-Key; four list endpoints gained a cursor.
  • Write schemas became strict: unknown fields and wrong segment fields return 400, and limit is validated.
  • Error responses carry rate limit headers and the monthly quota returns Retry-After; MCP and the authentication path fall under rate limits.
  • A webhook re-enable endpoint was added and registering a localhost address returns 400; the SDKs accept hb_oat_ tokens.

1.1.0 · November 3, 2026

  • Campaign, Mini App, order, automation, template, webhook and usage endpoints were added. Campaign sending starts only in the dashboard with admin approval.
  • An MCP server at /api/mcp and OAuth 2.1 for MCP were added; tools are generated from OpenAPI.
  • The SDKs were packaged: npm @hiboty/sdk and PyPI hiboty. WhatsApp A/B campaigns opened up in the API.

1.0.0 · November 2, 2026

  • The OpenAPI 3.1 document was published at GET /api/v1/openapi.json.
  • A dependency-free JavaScript client /sdk/hiboty.js and a types file were added; every /api/v1 endpoint was tied to a response contract test.