supportbee({ company: 'acme' }) or store it with keys.set_company(company). The host on its own (acme.supportbee.com) and a pasted desk address (https://acme.supportbee.com/tickets) are accepted too. Requests only go to https://<company>.supportbee.com: another domain, an IP address or a port is rejected before anything is sent. Without a company the plugin throws before it sends anything.
Credentials are one API token, found on the desk under the profile picture, then API Token. Store it as the account’s api_key, or pass it as supportbee({ key }).
Things to know before you call:
- Every request needs
Accept: application/json, which the client sends. Without it the desk answers HTML. - Ticket search takes
query, notq. The route is/tickets/search, and a blank query is rejected before the request. tickets.deleteonly works on a trashed ticket, and only an admin can call it. Trash first, then delete.- The list route answers unarchived tickets only unless
archivednames another scope, and it returns 15 tickets a page in last-activity order. - A reply leaves SupportBee.
replies.createmail reaches the real customer;comments.createis the internal note only staff see. - A ticket takes a user assignee or a team assignee, not both. Reassigning to another team clears the user assignee.
- A filter is three calls.
filters.createRuleandfilters.createConsequenceeach return an id, andfilters.createlinks them. Until the link exists, nothing happens. emailsmanages forwarding addresses, not mail. SupportBee generates theforward_toaddress an existing mailbox forwards into.- The flag routes answer 204 with no body, so the plugin reports
{ id, updated: true }rather than returning nothing. - A customer group is a user with
type: customer_group, and its members are added withusers.addMember. There is no route to remove a member.
- 50 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the Supportbee API key before the first call: More: API Key
pnpm corsair setup --plugin=supportbee --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
List recent ticketsWhat’s next
API reference
Every
supportbee.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.