Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Bird (BYOK) — connector documentation

  • MCP endpoint: https://byok-bird-messaging.connectorbay.com/mcp
  • REST API: POST https://byok-bird-messaging.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-bird-messaging.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Bird Bird workspace API key (bk_...), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-bird-messaging.connectorbay.com/health · Tool schemas: https://byok-bird-messaging.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-bird-messaging · agent@connectorbay.com

What Bird (BYOK) is for

Bird (BYOK) lets an AI assistant read your own Bird data through the Bird API with a key you supply (Bird workspace API key (bk_...)). Read-only: 12 tools (get_workspace, list_whatsapp_numbers, list_whatsapp_number_events, list_whatsapp_business_accounts, list_whatsapp_templates, get_whatsapp_template, get_whatsapp_stats_summary, get_whatsapp_stats_daily, get_whatsapp_stats_by_template, get_whatsapp_stats_error_codes, get_sms_stats_summary, list_sms_templates). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to us1.platform.bird.com, eu1.platform.bird.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Bird. Bird and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Bird workspace is this API key for?"
  • "What is the quality rating and messaging limit of my WhatsApp numbers on Bird?"
  • "What changed recently on my WhatsApp number wan_1 in Bird?"
  • "Are my WhatsApp Business Accounts on Bird verified and healthy?"
  • "Which WhatsApp templates do I have on Bird and which are approved?"
  • "What is the approval status of the WhatsApp template order_shipped?"

What it does

  • get_workspace: Show the Bird workspace the key belongs to: id, organization id, name and creation time.
  • list_whatsapp_numbers: List WhatsApp business numbers with connection status, quality rating, messaging limit tier, throughput level and official-account flag.
  • list_whatsapp_number_events: List the status-change events of one WhatsApp number (for example quality or limit changes), newest first: type, summary and time.
  • list_whatsapp_business_accounts: List connected WhatsApp Business Accounts with status, account review status, business verification status and Meta health.
  • list_whatsapp_templates: List WhatsApp message templates with category, approval status, default language and available languages. Template body text is not included in this list.
  • get_whatsapp_template: Get one WhatsApp template by id or slug: category, status, default language, available languages and version ids.
  • get_whatsapp_stats_summary: Get aggregate outbound WhatsApp counts and rates (accepted, sent, delivered, failed, rejected, delivery and failure rate, read count) for a period.
  • get_whatsapp_stats_daily: Get outbound WhatsApp delivery and read counts per day for a period.
  • get_whatsapp_stats_by_template: Get outbound WhatsApp statistics per template, ranked by accepted volume.
  • get_whatsapp_stats_error_codes: Get outbound WhatsApp failures grouped by error code, most frequent first.
  • get_sms_stats_summary: Get aggregate outbound SMS counts and rates (accepted, sent, delivered, undelivered, failed, rejected, expired) for a period.
  • list_sms_templates: List SMS templates with category, status, default language and available languages.

BYOK key

You bring your own Bird Bird workspace API key (bk_...) (https://bird.com/docs/guides/authentication). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to us1.platform.bird.com, eu1.platform.bird.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Bird API (us1.platform.bird.com, eu1.platform.bird.com) with a BYOK key; documentation: https://bird.com/docs/api. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Bird. Bird and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Bird account.

Built for: Worldwide. Languages: English.