Supportbee | Composio Docs

Overview

SLUG: SUPPORTBEE

Description

SupportBee is a web-based email support tool that helps businesses organize their customer support emails efficiently.

Authentication Details

API Key

subdomain

stringRequired

generic_token

stringRequired

Connecting to Supportbee

Create an auth config

Use the dashboard to create an auth config for the Supportbee toolkit. This allows you to connect multiple Supportbee accounts to Composio for agents to use.

Select App

Navigate to Supportbee.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Supportbee Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 supportbee_auth_config_id = "ac_YOUR_SUPPORTBEE_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Supportbee for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, supportbee_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Supportbee toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["SUPPORTBEE"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

SUPPORTBEE_ARCHIVE_TICKET

Tool Name: Archive SupportBee Ticket

Description

Tool to archive a supportbee ticket by its id. use when you want to move resolved tickets to the archive.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_ASSIGN_TICKET_TO_TEAM

Tool Name: Assign Ticket to Team

Description

Tool to assign a ticket to a team. use after confirming ticket and team ids are valid.

Action Parameters

team_id

integerRequired

ticket_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_CREATE_RULE

Tool Name: Create Rule

Description

Tool to create a new routing or automation rule in supportbee. use after defining rule conditions and actions.

Action Parameters

actions

arrayRequired

active

booleanDefaults to True

conditions

arrayRequired

description

string

name

stringRequired

sort_order

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_CREATE_SNIPPET

Tool Name: Create Snippet

Description

Tool to create a reusable snippet for ticket responses. use when you need to store and reuse response templates.

Action Parameters

body

stringRequired

position

integer

team_id

integer

title

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_CREATE_TICKET

Tool Name: Create SupportBee Ticket

Description

Tool to create a new support ticket. use when you need to open a ticket with subject, requester email, and content.

Action Parameters

agent_id

integer

array

content

stringRequired

labels

array

requester

objectRequired

spam

boolean

subject

stringRequired

SUPPORTBEE_CREATE_TICKET_REPLY

Tool Name: Create Ticket Reply

Description

Tool to post a reply to a ticket. use after retrieving ticket details to respond to customers.

Action Parameters

content

stringRequired

ticket_id

stringRequired

user_id

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_CREATE_USER_OR_CUSTOMER_GROUP

Tool Name: Create SupportBee User

Description

Tool to create a new user in supportbee. use when you need to provision an agent or admin via api.

Action Parameters

stringRequired

name

string

role

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_DELETE_SNIPPET

Tool Name: Delete Snippet

Description

Tool to delete a snippet by its id. use when you need to permanently remove an unwanted snippet.

Action Parameters

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_DELETE_TICKET

Tool Name: Delete SupportBee Ticket

Description

Tool to permanently delete a trashed ticket. use when you need to remove a ticket from trash permanently.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_FETCH_EMAILS

Tool Name: Fetch Emails

Description

Tool to retrieve all forwarding email addresses for the company. use when you need to view or manage forwarding emails.

Action Parameters

label

string

max_id

integer

page

integerDefaults to 1

per_page

integerDefaults to 15

since_id

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_FETCH_LABELS

Tool Name: Fetch SupportBee Labels

Description

Tool to retrieve all custom labels. use when you need to list labels for ticket categorization.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_FETCH_SNIPPETS

Tool Name: Fetch Snippets

Description

Tool to fetch all saved snippets. use when you need to list available snippets for the company.

Action Parameters

page

integerDefaults to 1

per_page

integerDefaults to 15

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_FETCH_TEAM_BY_ID

Tool Name: Fetch SupportBee Team by ID

Description

Tool to fetch a supportbee team by its id. use when you need to retrieve details of a specific team after confirming its id is valid.

Action Parameters

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_FETCH_TEAMS

Tool Name: Fetch SupportBee Teams

Description

Tool to retrieve all teams in the company. use when you need to list teams for organizing tickets by team.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_GET_AVG_FIRST_RESPONSE_TIME_REPORT

Tool Name: Get Avg First Response Time Report

Description

Tool to retrieve average first response time data points. use when analyzing first-response performance metrics within a given period.

Action Parameters

since

string

until

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_GET_REPLIES_COUNT_REPORT

Tool Name: Get Replies Count Report

Description

Tool to get replies count data points over time. use when analyzing agent reply performance over a date range.

Action Parameters

agent_id

integer

from_date

stringRequired

to_date

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_GET_TICKETS_COUNT_REPORT

Tool Name: Get Tickets Count Report

Description

Tool to get ticket count data points over time. use when you need the total number of tickets for a given date range.

Action Parameters

end_date

stringRequired

start_date

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_LIST_TICKET_COMMENTS

Tool Name: List Ticket Comments

Description

Tool to list all comments for a ticket. use after confirming the ticket id to retrieve its conversation history.

Action Parameters

ticket_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_LIST_TICKET_REPLIES

Tool Name: List Ticket Replies

Description

Tool to list all replies for a specific ticket. use after confirming the ticket id is valid.

Action Parameters

page

integer

per_page

integer

ticket_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_LIST_TICKETS

Tool Name: List Tickets

Description

Tool to list tickets. use when you need a paginated view of tickets with optional filters.

Action Parameters

assigned_to

string

labels

string

page

integerDefaults to 1

per_page

integerDefaults to 30

requester_email

since_id

integer

status

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_MARK_TICKET_AS_ANSWERED

Tool Name: Mark SupportBee Ticket as Answered

Description

Tool to mark a ticket as answered. use after sending response to update ticket status.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_MARK_TICKET_AS_SPAM

Tool Name: Mark SupportBee Ticket as Spam

Description

Tool to mark a supportbee ticket as spam. use when you need to flag unwanted or malicious ticket submissions after obtaining the ticket id.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_MARK_TICKET_AS_UNANSWERED

Tool Name: Mark SupportBee Ticket as Unanswered

Description

Tool to mark a ticket as unanswered. use after confirming the ticket was previously marked as answered to revert its status.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_SEARCH_TICKETS

Tool Name: Search SupportBee Tickets

Description

Tool to search supportbee tickets. use when you need to find tickets by query with pagination.

Action Parameters

SUPPORTBEE_SHOW_TICKET_REPLY

Tool Name: Show Ticket Reply

Description

Tool to fetch a specific reply for a supportbee ticket. use when you need details of a single reply by ticket and reply ids.

Action Parameters

reply_id

integerRequired

ticket_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_SHOW_USER_OR_CUSTOMER_GROUP

Tool Name: Show SupportBee User or Customer Group

Description

Tool to retrieve a user or customer group by id. use when you need details for a specific user or group after confirming the id.

Action Parameters

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_TRASH_TICKET

Tool Name: Trash SupportBee Ticket

Description

Tool to trash a supportbee ticket by its id. use when you need to remove a ticket into the trash folder.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_UNARCHIVE_TICKET

Tool Name: Unarchive SupportBee Ticket

Description

Tool to unarchive a supportbee ticket by its id. use when you need to restore an archived ticket back to active status.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_UNASSIGN_TICKET_FROM_TEAM

Tool Name: Unassign Ticket from Team

Description

Tool to un-assign a ticket from its assigned team. use when you need to remove the current team ownership before reassigning or closing the ticket.

Action Parameters

ticket_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_UNASSIGN_TICKET_FROM_USER

Tool Name: Unassign User From Ticket

Description

Tool to unassign the user from a ticket. use when you need to remove the assigned user before reassigning or closing a ticket.

Action Parameters

ticket_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_UNMARK_TICKET_AS_SPAM

Tool Name: Unmark SupportBee Ticket as Spam

Description

Tool to unmark a supportbee ticket as spam. use when a ticket was incorrectly flagged as spam.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_UNTRASH_TICKET

Tool Name: Untrash SupportBee Ticket

Description

Tool to untrash (restore) a supportbee ticket by its id. use when you need to move a trashed ticket back to active status.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SUPPORTBEE_UPDATE_USER

Tool Name: Update SupportBee User

Description

Update supportbee user

Action Parameters

avatar_url

string

integerRequired

name

string

role

string

signature

string

Action Response

data

objectRequired

error

string

successful

booleanRequired