Skip to main content
Supportbee logo
  • Category: customer support
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 41
  • Triggers: 0
  • Slug: SUPPORTBEE
  • Version: 20261101_00

Tools

Slug: SUPPORTBEE_ADD_LABEL_TO_TICKETTool to add a label to a ticket. Use when you need to categorize or tag a ticket with a specific label. The label must already exist in your SupportBee account before adding it to a ticket.

Input Parameters

integer
required
The unique ID of the ticket to add the label to
string
required
The name of the label to add to the ticket. The label must already exist in your SupportBee account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_ARCHIVE_TICKETTool to archive a SupportBee ticket by its ID. Use when you want to move resolved tickets to the archive.

Input Parameters

string
required
Unique identifier of the ticket to archive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_ASSIGN_TICKET_TO_TEAMAssigns a ticket to a team in SupportBee. Use when you need to route a support ticket to a specific team for handling. Note: If the ticket is already assigned to a team and a user, reassigning to another team will remove the user assignee.

Input Parameters

integer
required
The unique ID of the team to assign the ticket to
integer
required
The unique ID of the ticket to assign to a team

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_CREATE_COMMENTCreates an internal comment on a ticket in SupportBee. Comments are private notes visible only to agents, not to customers. Use this to add internal notes, observations, or collaborate with team members on a ticket.

Input Parameters

object
required
Content of the comment. Provide either text or html (or both).
string
required
The unique identifier of the ticket to add a comment to. Obtain this from list_tickets or search_tickets actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_CREATE_CONSEQUENCECreates a new consequence for rules automation in SupportBee. Use when setting up automated actions that should be triggered by rules (e.g., auto-assign tickets, archive, or mark as spam).

Input Parameters

boolean
Set to true to automatically mark the ticket as spam when this consequence is triggered
string
A descriptive label for the consequence to identify its purpose
boolean
Set to true to automatically archive the ticket when this consequence is triggered
string
Team ID to assign the ticket to. Mutually exclusive with assign_user - cannot be used together.
string
User ID to assign the ticket to. Mutually exclusive with assign_team - cannot be used together.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_CREATE_EMAILCreate a new forwarding email address for the company in SupportBee. Use this to add new support email addresses that will forward incoming emails to your SupportBee account as tickets.

Input Parameters

string
Display name for the email address. This name will be used when sending replies from this address.
string
required
The email address to create as a forwarding address. This is the address that will forward emails to SupportBee.
boolean
Whether to filter spam emails. When enabled, suspected spam emails will be automatically filtered.
boolean
Whether to use the agent’s name instead of the company name when sending replies from this address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_CREATE_FILTERCreates a SupportBee filter by linking an existing rule with a consequence. The rule defines which tickets match, and the consequence defines the action taken on matching tickets.

Input Parameters

string
required
ID of the rule to match. This rule defines the conditions under which the filter will be triggered. Use the Create Rule action to generate a rule and obtain its ID.
string
required
ID of the consequence to apply when the rule matches. The consequence defines the actions that will be executed when the filter conditions are met.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_CREATE_RULESubmits a SupportBee automation rule with conditions and action entries and returns the rule ID. SupportBee documents rules as matching criteria and requires a separate consequence and filter to associate actions with them.

Input Parameters

string
required
Name of the rule to be created
boolean
Flag indicating if the rule should be active upon creation
array
required
List of one or more actions to execute when conditions match
array
required
List of one or more conditions that trigger the rule
integer
Optional sort order for the rule, non-negative
string
Optional description for the rule

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_CREATE_SNIPPETCreate a reusable snippet (canned response) in SupportBee. Snippets are pre-written text templates that agents can quickly insert into ticket replies. Use this to create standard responses for common customer inquiries like refunds, FAQs, or welcome messages.

Input Parameters

string
The HTML formatted content of the snippet. If not provided, the plain text will be used. Supports basic HTML formatting like <b>, <i>, <a>,
, etc.
string
required
The name/title for the snippet. This will be displayed when selecting snippets.
string
Comma-separated tags to categorize the snippet (e.g., ‘refund, policy, billing’).
string
required
The plain text content of the snippet. Used in text-only email responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_CREATE_TICKETCreates a new support ticket in SupportBee with a subject, content, and requester details. Use this action to: - Create tickets from customer inquiries or issues - Assign tickets to specific agents or teams during creation - Add tags and labels for better ticket organization - Include CC recipients to keep stakeholders informed The ticket will be created in an unanswered state and will appear in the inbox unless marked as spam.

Input Parameters

array
Email addresses to CC on the ticket. These recipients will receive updates.
boolean
Set to true to mark the ticket as spam. Note: The API may not honor this during creation.
array
Tags to categorize the ticket (e.g., ‘urgent’, ‘billing’, ‘bug’).
array
Custom labels for the ticket. Use label names from your SupportBee account.
string
required
Main content/body of the ticket. Describe the issue or request in detail.
string
required
Subject line of the ticket. Should be concise and descriptive.
integer
Team ID to assign this ticket to. Use Fetch Teams to get valid team IDs.
integer
Agent ID to assign this ticket to. Use Fetch Teams/Users to get valid agent IDs.
object
required
Requester information. Email is required; name is optional but recommended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_CREATE_TICKET_REPLYCreate a reply to a support ticket in SupportBee. Replies are sent to customers via email and are visible to them. Use this when you need to respond to a customer’s ticket with information, updates, or solutions. Provide the ticket ID and HTML-formatted content for your reply.

Input Parameters

string
required
Content of the reply in HTML format
integer
ID of the user replying; if omitted, the current user is used
string
required
ID of the ticket to reply to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_CREATE_USER_OR_CUSTOMER_GROUPInvites a new user to your SupportBee account. The user will receive an email invitation and can be assigned as an agent (handles tickets), admin (full access), or collaborator (view/comment only). Use this when you need to add team members to your helpdesk programmatically.

Input Parameters

string
Full name of the user to display in SupportBee.
string ("agent" | "admin" | "collaborator")
Role to assign to the user. ‘admin’ has full account access, ‘agent’ can handle tickets, ‘collaborator’ can view and comment only. Defaults to ‘agent’.
string
required
Email address of the user to invite. An invitation email will be sent to this address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_DELETE_SNIPPETPermanently delete a snippet by its ID from SupportBee. Use this action when you need to remove an unwanted or outdated snippet (canned response template). This action is destructive and cannot be undone. To find snippet IDs, use the ‘Fetch Snippets’ action first.

Input Parameters

integer
required
The unique numeric ID of the snippet to delete. You can obtain snippet IDs by calling the ‘Fetch Snippets’ action first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_DELETE_TICKETPermanently delete a trashed ticket from SupportBee. The ticket must first be moved to trash using the Trash Ticket action before it can be permanently deleted. Only admins can delete trashed tickets. This action is irreversible.

Input Parameters

integer
required
Unique numeric ID of the trashed ticket to permanently delete. The ticket must be in the trash before it can be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_FETCH_EMAILSRetrieves the company’s forwarding email addresses configured in SupportBee. Use it to list the support addresses that forward email to the company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_FETCH_LABELSTool to retrieve all custom labels. Use when you need to list labels for ticket categorization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_FETCH_SNIPPETSFetches saved response snippets (canned responses/templates) from SupportBee. Snippets are reusable text templates that can be inserted into ticket replies. Use this to list available snippets for quick responses.

Input Parameters

integer
Page of results to fetch (default is 1).
integer
Number of snippets per page (default is 15, max is 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_FETCH_TEAMSRetrieves all teams in the SupportBee account. Use this to list available teams before assigning tickets to teams or filtering tickets by team. Returns team IDs, names, descriptions, and timestamps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_GET_AVG_FIRST_RESPONSE_TIME_REPORTTool to retrieve average first response time data points over time. Use when analyzing first-response performance metrics for support tickets. Returns time-series data with response times in seconds and Unix timestamps. Reports require admin API token access. Data is limited to a maximum 30-day window per request.

Input Parameters

integer
Filter data points by team ID. Only reports for the specified team will be returned.
integer
Filter data points by agent ID. Only reports for the specified agent will be returned.
string
Filter data points by label name. Only tickets with this label will be included in the report.
string
Start of reporting period. Accepts various date formats: ISO 8601 (e.g., ‘2023-01-01T00:00:00Z’), YYYY-MM-DD (e.g., ‘2023-01-01’), or verbose formats (e.g., ‘15th Feb 2023’). Data points returned for max 30 days window.
string
End of reporting period. Accepts various date formats: ISO 8601 (e.g., ‘2023-01-31T23:59:59Z’), YYYY-MM-DD (e.g., ‘2023-01-31’), or verbose formats. Data points returned for max 30 days window.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_GET_REPLIES_COUNT_REPORTRetrieves replies count report data for the company. Returns time-series data points showing the number of replies over time. The report provides aggregate metrics for the entire company account and includes type information (company/user/team), the entity ID, and the metric name. Requires admin-level API access. Use this to analyze reply volume trends and patterns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_GET_TICKETTool to retrieve a specific SupportBee ticket by its ID. Returns complete ticket details including subject, content, requester, assignee, labels, and reply/comment counts. Use when you need to fetch full details of a single ticket.

Input Parameters

string
required
The unique identifier of the ticket to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_GET_TICKETS_COUNT_REPORTRequests a SupportBee ticket count report for a specified date range, with optional agent, team, and label parameters. Reports are available only to admins; the result includes a total and may include a report.

Input Parameters

string
Filter results by label name (optional)
integer
Filter results by team ID (optional)
string
required
End date of the report period in YYYY-MM-DD format
integer
Filter results by agent ID (optional)
string
required
Start date of the report period in YYYY-MM-DD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_LIST_TICKET_COMMENTSRetrieves all internal comments (private agent notes) for a specific ticket. Comments are visible only to agents within the helpdesk, not to customers. Use this to review internal discussion history on a ticket.

Input Parameters

string
required
The unique identifier of the ticket to retrieve comments for. Obtain this from list_tickets or search_tickets actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_LIST_TICKET_REPLIESLists all replies on a specific support ticket in SupportBee. Returns reply content, replier details, timestamps, and attachments. Use this to view the conversation history on a ticket. Returns an empty list if the ticket has no replies yet.

Input Parameters

integer
Page number to retrieve (1-indexed). Use with per_page for paginated results.
integer
Number of replies to return per page. Useful for pagination when a ticket has many replies.
string
required
The unique ID of the ticket to fetch replies for. Use SUPPORTBEE_LIST_TICKETS or SUPPORTBEE_SEARCH_TICKETS to find valid ticket IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_LIST_TICKETSTool to list tickets from SupportBee. Returns a paginated list of tickets with optional filters for spam, trash, archived, assigned user/group, labels, and more. Use when you need to retrieve and browse tickets in the helpdesk.

Input Parameters

integer
Page number for pagination (default is 1).
boolean
If true, retrieves tickets marked as spam. Defaults to false.
string
Filter tickets by a specific label name.
boolean
If true, retrieves tickets marked as trash. Defaults to false.
boolean
If true, filter tickets that have replies. If false, filter tickets without replies.
boolean
If true, retrieves only starred tickets.
boolean
If true, retrieves archived tickets. Defaults to false.
integer
Number of tickets per page (default is 15, max is 100).
integer
Return tickets with ID greater than this value.
string
Filter by assigned user. Use ‘me’ for current user, ‘none’ for unassigned, or provide agent ID.
string
Filter by assigned group/team. Use ‘mine’ for current user’s groups or provide group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_LIST_USERSLists SupportBee users or customer groups, with options to select the type and include invited agents. By default, the provider selects users and the admin, agent, and collaborator roles.

Input Parameters

string
Filter users by type. Use ‘user’ to get only agents/admins, or ‘customer_group’ to get only customer groups. Omit to get all types.
boolean
If true, includes role information for each user in the response. Defaults to false.
boolean
If true, returns all agents including invited (unconfirmed) agents who haven’t accepted their invitation yet. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_MARK_TICKET_AS_ANSWEREDMarks a SupportBee ticket as answered by adding the ‘answered’ status. Use this after sending a response to a customer to indicate the ticket has been addressed. This action is idempotent - calling it on an already answered ticket has no adverse effect.

Input Parameters

string
required
The unique numeric ID of the ticket to mark as answered. Obtain this from list_tickets or create_ticket actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_MARK_TICKET_AS_SPAMTool to mark a SupportBee ticket as spam. Use when you need to flag unwanted or malicious ticket submissions after obtaining the ticket ID.

Input Parameters

string
required
The numeric ID of the SupportBee ticket to mark as spam. Can be provided as string or integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_MARK_TICKET_AS_UNANSWEREDMarks a SupportBee ticket as unanswered by removing its ‘answered’ status. Use this to revert a ticket’s status after it was previously marked as answered, typically when additional follow-up is needed from the support team. This action is idempotent - calling it on an already unanswered ticket has no adverse effect.

Input Parameters

string
required
The unique numeric ID of the ticket to mark as unanswered. Obtain this from list_tickets or create_ticket actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_REMOVE_LABEL_FROM_TICKETTool to remove a label from a ticket. Use when you need to unlabel or uncategorize a ticket by removing an existing label.

Input Parameters

integer
required
Unique numeric ID of the ticket to remove the label from.
string
required
Name of the label to remove from the ticket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_SEARCH_TICKETSTool to search SupportBee tickets. Use when you need to find tickets by query with pagination.

Input Parameters

integer
Page number for pagination. Defaults to 1.
boolean
If true, include tickets marked as spam. Defaults to false.
string
Search query string to match tickets. Searches in ticket subject, content, and requester info.
boolean
If true, include tickets that are trashed. Defaults to false.
boolean
If true, return only tickets with replies.
string ("true" | "false" | "any")
Filter by archived status: ‘true’ for only archived, ‘false’ for non-archived (default), ‘any’ to include all.
integer
Number of tickets per page (1-100). Defaults to 15.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_SHOW_TICKET_REPLYRequests a specific SupportBee ticket reply by ticket and reply IDs. The response must contain a nested reply object; a top-level reply response is rejected.

Input Parameters

integer
required
ID of the reply to retrieve
string
required
ID of the ticket to fetch the reply for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_SHOW_USER_OR_CUSTOMER_GROUPRetrieves details of a SupportBee user (agent/admin) or customer group by their ID. Use this action when you need to fetch profile information like name, email, role, or timestamps for a specific user whose ID you already have (e.g., from a ticket response).

Input Parameters

integer
required
The numeric ID of the SupportBee user or customer group. You can obtain this ID from ticket responses, team member lists, or the SUPPORTBEE_CREATE_USER_OR_CUSTOMER_GROUP action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_TRASH_TICKETTool to trash a SupportBee ticket by its ID. Use when you need to remove a ticket into the trash folder.

Input Parameters

integer
required
The numeric ID of the ticket to trash. The ticket will be moved to the trash folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_UNARCHIVE_TICKETTool to unarchive a SupportBee ticket by its ID. Use when you need to restore an archived ticket back to active status.

Input Parameters

integer
required
The numeric ID of the ticket to unarchive. If the ticket is already unarchived, the operation succeeds idempotently.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_UNASSIGN_TICKET_FROM_TEAMTool 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.

Input Parameters

integer
required
ID of the ticket to remove from its assigned team

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_UNASSIGN_TICKET_FROM_USERTool to un-assign a ticket from its assigned user/agent. Use when you need to remove the current user ownership before reassigning to a different user or closing the ticket.

Input Parameters

integer
required
ID of the ticket to remove the assigned user from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_UNMARK_TICKET_AS_SPAMTool to unmark a SupportBee ticket as spam. Use when a ticket was incorrectly flagged as spam.

Input Parameters

string
required
The numeric ID of the SupportBee ticket to unmark as spam. Can be provided as string or integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_UNTRASH_TICKETRestores a trashed SupportBee ticket back to active status. Use when you need to recover a ticket that was previously moved to trash.

Input Parameters

integer
required
The numeric ID of the trashed ticket to restore. The ticket must currently be in the trash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_UPDATE_SNIPPETUpdate an existing SupportBee snippet (canned response) by ID. The request requires a name and content with text or HTML, and can also include tags.

Input Parameters

string
required
The unique ID of the snippet to update. You can obtain snippet IDs by calling the ‘Fetch Snippets’ action first.
string
required
The name/title for the snippet. This will be displayed when selecting snippets.
string
Comma-separated tags to categorize the snippet (e.g., ‘refund, policy, updated’).
object
required
The content of the snippet. Must include at least text or html.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPPORTBEE_UPDATE_USERUpdate an existing SupportBee user’s name, email, role, avatar, or signature by ID. One or more fields can be submitted; the user whose API token is in use cannot be updated through this action.

Input Parameters

integer
required
The unique numeric ID of the SupportBee user to update. Required.
string
Updated display name for the user. If provided, replaces the current name.
string ("agent" | "admin")
Updated role for the user. Use ‘agent’ for regular team members or ‘admin’ for administrators with full permissions.
string
Updated email address for the user. Must be a valid email format.
string
Updated email signature for the user. This will appear at the end of their support replies.
string
URL to an image to use as the user’s avatar. Must be a publicly accessible URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not