Supportbee
supportbeeSupportBee is a web-based email support tool that helps businesses organize their customer support emails efficiently.
Acciones disponibles (33)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Archive SupportBee TicketSUPPORTBEE_ARCHIVE_TICKETAcciónTool to archive a supportbee ticket by its id. use when you want to move resolved tickets to the archive.
SUPPORTBEE_ARCHIVE_TICKETAcciónTool to archive a supportbee ticket by its id. use when you want to move resolved tickets to the archive.
Parámetros de entrada
idstringObligatorioUnique identifier of the ticket to archive
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Assign Ticket to TeamSUPPORTBEE_ASSIGN_TICKET_TO_TEAMAcciónTool to assign a ticket to a team. use after confirming ticket and team ids are valid.
SUPPORTBEE_ASSIGN_TICKET_TO_TEAMAcciónTool to assign a ticket to a team. use after confirming ticket and team ids are valid.
Parámetros de entrada
team_idintegerObligatorioID of the team to assign the ticket to (must be ≥ 1)
ticket_idintegerObligatorioID of the ticket to assign (must be ≥ 1)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create RuleSUPPORTBEE_CREATE_RULEAcciónTool to create a new routing or automation rule in supportbee. use after defining rule conditions and actions.
SUPPORTBEE_CREATE_RULEAcciónTool to create a new routing or automation rule in supportbee. use after defining rule conditions and actions.
Parámetros de entrada
namestringObligatorioName of the rule to be created
activebooleanFlag indicating if the rule should be active upon creation
actionsobject[]ObligatorioList of one or more actions to execute when conditions match
conditionsobject[]ObligatorioList of one or more conditions that trigger the rule
sort_orderintegerOptional sort order for the rule, non-negative
descriptionstringOptional description for the rule
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create SnippetSUPPORTBEE_CREATE_SNIPPETAcciónTool to create a reusable snippet for ticket responses. use when you need to store and reuse response templates.
SUPPORTBEE_CREATE_SNIPPETAcciónTool to create a reusable snippet for ticket responses. use when you need to store and reuse response templates.
Parámetros de entrada
bodystringObligatorioThe content/body of the snippet.
titlestringObligatorioThe title for the snippet.
team_idintegerThe Team ID to associate the snippet with.
positionintegerThe position order for the snippet (non-negative integer).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create SupportBee TicketSUPPORTBEE_CREATE_TICKETAcciónTool to create a new support ticket. use when you need to open a ticket with subject, requester email, and content.
SUPPORTBEE_CREATE_TICKETAcciónTool to create a new support ticket. use when you need to open a ticket with subject, requester email, and content.
Parámetros de entrada
ccarrayList of CC email addresses.
spambooleanFlag to mark ticket as spam (true/false). Example: false
tagsstring[]List of tags to assign to the ticket.
labelsstring[]Additional labels for the ticket.
contentstringObligatorioBody content of the ticket.
subjectstringObligatorioSubject of the ticket.
team_idintegerID of the team to assign.
agent_idintegerID of the agent to assign.
requesterobjectObligatorioRequester details for the ticket.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Ticket ReplySUPPORTBEE_CREATE_TICKET_REPLYAcciónTool to post a reply to a ticket. use after retrieving ticket details to respond to customers.
SUPPORTBEE_CREATE_TICKET_REPLYAcciónTool to post a reply to a ticket. use after retrieving ticket details to respond to customers.
Parámetros de entrada
contentstringObligatorioContent of the reply in HTML format
user_idintegerID of the user replying; if omitted, the current user is used
ticket_idstringObligatorioID of the ticket to reply to
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create SupportBee UserSUPPORTBEE_CREATE_USER_OR_CUSTOMER_GROUPAcciónTool to create a new user in supportbee. use when you need to provision an agent or admin via api.
SUPPORTBEE_CREATE_USER_OR_CUSTOMER_GROUPAcciónTool to create a new user in supportbee. use when you need to provision an agent or admin via api.
Parámetros de entrada
namestringFull name of the user.
rolestringenumRole to assign to the user. Must be 'agent' or 'admin'.
agentadminemailstringObligatorioemailEmail of the new user (agent or admin). Must be a valid email address.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SnippetSUPPORTBEE_DELETE_SNIPPETAcciónTool to delete a snippet by its id. use when you need to permanently remove an unwanted snippet.
SUPPORTBEE_DELETE_SNIPPETAcciónTool to delete a snippet by its id. use when you need to permanently remove an unwanted snippet.
Parámetros de entrada
idintegerObligatorioUnique identifier of the snippet to delete (must be ≥ 1)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SupportBee TicketSUPPORTBEE_DELETE_TICKETAcciónTool to permanently delete a trashed ticket. use when you need to remove a ticket from trash permanently.
SUPPORTBEE_DELETE_TICKETAcciónTool to permanently delete a trashed ticket. use when you need to remove a ticket from trash permanently.
Parámetros de entrada
idstringObligatorioUnique identifier of the trashed ticket to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch EmailsSUPPORTBEE_FETCH_EMAILSAcciónTool to retrieve all forwarding email addresses for the company. use when you need to view or manage forwarding emails.
SUPPORTBEE_FETCH_EMAILSAcciónTool to retrieve all forwarding email addresses for the company. use when you need to view or manage forwarding emails.
Parámetros de entrada
pageintegerPage number to fetch.
labelstringFilter emails by label.
max_idintegerReturn emails with ID less than this value.
per_pageintegerNumber of emails per page (max 100).
since_idintegerReturn emails with ID greater than this value.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch SupportBee LabelsSUPPORTBEE_FETCH_LABELSAcciónTool to retrieve all custom labels. use when you need to list labels for ticket categorization.
SUPPORTBEE_FETCH_LABELSAcciónTool to retrieve all custom labels. use when you need to list labels for ticket categorization.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch SnippetsSUPPORTBEE_FETCH_SNIPPETSAcciónTool to fetch all saved snippets. use when you need to list available snippets for the company.
SUPPORTBEE_FETCH_SNIPPETSAcciónTool to fetch all saved snippets. use when you need to list available snippets for the company.
Parámetros de entrada
pageintegerPage of results to fetch (default is 1).
per_pageintegerNumber of snippets per page (default is 15, max is 100).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch SupportBee Team by IDSUPPORTBEE_FETCH_TEAM_BY_IDAcciónTool 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.
SUPPORTBEE_FETCH_TEAM_BY_IDAcciónTool 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.
Parámetros de entrada
idintegerObligatorioUnique identifier of the team to fetch
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch SupportBee TeamsSUPPORTBEE_FETCH_TEAMSAcciónTool to retrieve all teams in the company. use when you need to list teams for organizing tickets by team.
SUPPORTBEE_FETCH_TEAMSAcciónTool to retrieve all teams in the company. use when you need to list teams for organizing tickets by team.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Avg First Response Time ReportSUPPORTBEE_GET_AVG_FIRST_RESPONSE_TIME_REPORTAcciónTool to retrieve average first response time data points. use when analyzing first-response performance metrics within a given period.
SUPPORTBEE_GET_AVG_FIRST_RESPONSE_TIME_REPORTAcciónTool to retrieve average first response time data points. use when analyzing first-response performance metrics within a given period.
Parámetros de entrada
sincestringISO 8601 date string representing start of reporting period
untilstringISO 8601 date string representing end of reporting period
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Replies Count ReportSUPPORTBEE_GET_REPLIES_COUNT_REPORTAcciónTool to get replies count data points over time. use when analyzing agent reply performance over a date range.
SUPPORTBEE_GET_REPLIES_COUNT_REPORTAcciónTool to get replies count data points over time. use when analyzing agent reply performance over a date range.
Parámetros de entrada
to_datestringObligatorioEnd date in YYYY-MM-DD format
agent_idintegerFilter results by agent ID (optional)
from_datestringObligatorioStart date in YYYY-MM-DD format
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Tickets Count ReportSUPPORTBEE_GET_TICKETS_COUNT_REPORTAcciónTool to get ticket count data points over time. use when you need the total number of tickets for a given date range.
SUPPORTBEE_GET_TICKETS_COUNT_REPORTAcciónTool to get ticket count data points over time. use when you need the total number of tickets for a given date range.
Parámetros de entrada
end_datestringObligatorioEnd date of the report (YYYY-MM-DD)
start_datestringObligatorioStart date of the report (YYYY-MM-DD)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Ticket CommentsSUPPORTBEE_LIST_TICKET_COMMENTSAcciónTool to list all comments for a ticket. use after confirming the ticket id to retrieve its conversation history.
SUPPORTBEE_LIST_TICKET_COMMENTSAcciónTool to list all comments for a ticket. use after confirming the ticket id to retrieve its conversation history.
Parámetros de entrada
ticket_idstringObligatorioID of the ticket to list comments for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Ticket RepliesSUPPORTBEE_LIST_TICKET_REPLIESAcciónTool to list all replies for a specific ticket. use after confirming the ticket id is valid.
SUPPORTBEE_LIST_TICKET_REPLIESAcciónTool to list all replies for a specific ticket. use after confirming the ticket id is valid.
Parámetros de entrada
pageintegerPage number to retrieve (must be at least 1)
per_pageintegerNumber of replies per page (must be at least 1)
ticket_idstringObligatorioID of the ticket to fetch replies for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TicketsSUPPORTBEE_LIST_TICKETSAcciónTool to list tickets. use when you need a paginated view of tickets with optional filters.
SUPPORTBEE_LIST_TICKETSAcciónTool to list tickets. use when you need a paginated view of tickets with optional filters.
Parámetros de entrada
pageintegerPage number for pagination (default is 1).
labelsstringFilter by a single label.
statusstringenumFilter by ticket status.
inboxspamtrashedunassignedallper_pageintegerNumber of tickets per page (default is 30, max is 100).
since_idintegerReturn tickets with ID greater than this value.
assigned_tostringFilter by assigned user's ID or email.
requester_emailanyemailFilter by requester's email address.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Mark SupportBee Ticket as AnsweredSUPPORTBEE_MARK_TICKET_AS_ANSWEREDAcciónTool to mark a ticket as answered. use after sending response to update ticket status.
SUPPORTBEE_MARK_TICKET_AS_ANSWEREDAcciónTool to mark a ticket as answered. use after sending response to update ticket status.
Parámetros de entrada
idstringObligatorioUnique identifier of the ticket to mark as answered
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Mark SupportBee Ticket as SpamSUPPORTBEE_MARK_TICKET_AS_SPAMAcciónTool to mark a supportbee ticket as spam. use when you need to flag unwanted or malicious ticket submissions after obtaining the ticket id.
SUPPORTBEE_MARK_TICKET_AS_SPAMAcciónTool to mark a supportbee ticket as spam. use when you need to flag unwanted or malicious ticket submissions after obtaining the ticket id.
Parámetros de entrada
idstringObligatorioUnique identifier of the ticket to mark as spam
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Mark SupportBee Ticket as UnansweredSUPPORTBEE_MARK_TICKET_AS_UNANSWEREDAcciónTool to mark a ticket as unanswered. use after confirming the ticket was previously marked as answered to revert its status.
SUPPORTBEE_MARK_TICKET_AS_UNANSWEREDAcciónTool to mark a ticket as unanswered. use after confirming the ticket was previously marked as answered to revert its status.
Parámetros de entrada
idstringObligatorioUnique identifier of the ticket to mark as unanswered
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search SupportBee TicketsSUPPORTBEE_SEARCH_TICKETSAcciónTool to search supportbee tickets. use when you need to find tickets by query with pagination.
SUPPORTBEE_SEARCH_TICKETSAcciónTool to search supportbee tickets. use when you need to find tickets by query with pagination.
Parámetros de entrada
qstringSearch query string
pageintegerPage number of results
fieldsstringComma-separated list of ticket fields to include
archivebooleanWhether to include archived tickets in search
per_pageintegerNumber of tickets per page (1-100)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Show Ticket ReplySUPPORTBEE_SHOW_TICKET_REPLYAcciónTool to fetch a specific reply for a supportbee ticket. use when you need details of a single reply by ticket and reply ids.
SUPPORTBEE_SHOW_TICKET_REPLYAcciónTool to fetch a specific reply for a supportbee ticket. use when you need details of a single reply by ticket and reply ids.
Parámetros de entrada
reply_idintegerObligatorioID of the reply to retrieve
ticket_idstringObligatorioID of the ticket to fetch the reply for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Show SupportBee User or Customer GroupSUPPORTBEE_SHOW_USER_OR_CUSTOMER_GROUPAcciónTool to retrieve a user or customer group by id. use when you need details for a specific user or group after confirming the id.
SUPPORTBEE_SHOW_USER_OR_CUSTOMER_GROUPAcciónTool to retrieve a user or customer group by id. use when you need details for a specific user or group after confirming the id.
Parámetros de entrada
idintegerObligatorioUnique identifier of the user or customer group to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Trash SupportBee TicketSUPPORTBEE_TRASH_TICKETAcciónTool to trash a supportbee ticket by its id. use when you need to remove a ticket into the trash folder.
SUPPORTBEE_TRASH_TICKETAcciónTool to trash a supportbee ticket by its id. use when you need to remove a ticket into the trash folder.
Parámetros de entrada
idstringObligatorioUnique identifier of the ticket to trash
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unarchive SupportBee TicketSUPPORTBEE_UNARCHIVE_TICKETAcciónTool to unarchive a supportbee ticket by its id. use when you need to restore an archived ticket back to active status.
SUPPORTBEE_UNARCHIVE_TICKETAcciónTool to unarchive a supportbee ticket by its id. use when you need to restore an archived ticket back to active status.
Parámetros de entrada
idstringObligatorioUnique identifier of the ticket to unarchive
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unassign Ticket from TeamSUPPORTBEE_UNASSIGN_TICKET_FROM_TEAMAcciónTool 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.
SUPPORTBEE_UNASSIGN_TICKET_FROM_TEAMAcciónTool 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.
Parámetros de entrada
ticket_idintegerObligatorioID of the ticket to remove from its assigned team
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unassign User From TicketSUPPORTBEE_UNASSIGN_TICKET_FROM_USERAcciónTool to unassign the user from a ticket. use when you need to remove the assigned user before reassigning or closing a ticket.
SUPPORTBEE_UNASSIGN_TICKET_FROM_USERAcciónTool to unassign the user from a ticket. use when you need to remove the assigned user before reassigning or closing a ticket.
Parámetros de entrada
ticket_idstringObligatorioUnique identifier of the ticket to unassign the user from
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unmark SupportBee Ticket as SpamSUPPORTBEE_UNMARK_TICKET_AS_SPAMAcciónTool to unmark a supportbee ticket as spam. use when a ticket was incorrectly flagged as spam.
SUPPORTBEE_UNMARK_TICKET_AS_SPAMAcciónTool to unmark a supportbee ticket as spam. use when a ticket was incorrectly flagged as spam.
Parámetros de entrada
idstringObligatorioUnique identifier of the ticket to unmark as spam
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Untrash SupportBee TicketSUPPORTBEE_UNTRASH_TICKETAcciónTool to untrash (restore) a supportbee ticket by its id. use when you need to move a trashed ticket back to active status.
SUPPORTBEE_UNTRASH_TICKETAcciónTool to untrash (restore) a supportbee ticket by its id. use when you need to move a trashed ticket back to active status.
Parámetros de entrada
idstringObligatorioUnique identifier of the ticket to untrash
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update SupportBee UserSUPPORTBEE_UPDATE_USERAcciónUpdate supportbee user
SUPPORTBEE_UPDATE_USERAcciónUpdate supportbee user
Parámetros de entrada
idintegerObligatorioUnique ID of the user to update
namestringNew name for the user
rolestringenumNew role for the user
agentadminemailstringemailNew email for the user
signaturestringNew email signature for the user
avatar_urlstringURL to the user's new avatar
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not