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

Tools

Slug: HELP_SPOT_CREATE_REQUESTCreate a staff-side support request with an initial customer-visible or internal note. Configured HelpSpot automations may send notifications.

Input Parameters

string
required
Initial request note content.
string
Short request title or subject.
boolean
Whether the new request starts open.
boolean
Whether to mark the request urgent.
integer
Portal ID associated with the request when the installation has multiple portals.
integer
Initial status ID from HELP_SPOT_LIST_SUPPORT_OPTIONS.
integer
required
HelpSpot category ID from HELP_SPOT_LIST_SUPPORT_OPTIONS.
string
Existing customer’s HelpSpot user ID; provide at least one customer identity field.
array
Custom-field values keyed by IDs returned from HELP_SPOT_LIST_SUPPORT_OPTIONS.
string
Customer email address; provide at least one customer identity field.
string
Customer phone number; may serve as the required customer identity.
string ("customer" | "internal")
Whether the initial note is visible to the customer or only to staff.
integer
Active staff ID to assign, from HELP_SPOT_LIST_SUPPORT_OPTIONS.
string
Customer last name; may serve as the required customer identity.
string
Customer first name; may serve as the required customer identity.

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: HELP_SPOT_GET_CURRENT_USERReturn the connected HelpSpot staff user’s identity, defaults, and support capabilities without authentication tokens.

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: HELP_SPOT_GET_REQUESTReturn one support request with optional normalized history and time total. If the requested ID was merged, HelpSpot returns the merged request with a different ID.

Input Parameters

integer
required
Numeric HelpSpot request ID.
boolean
Include request notes and history; disable for a smaller response.
boolean
Include the request’s accumulated time total when available.

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: HELP_SPOT_LIST_FILTERSList the connected staff user’s saved and built-in queue filters, including symbolic selectors such as inbox and myq.

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: HELP_SPOT_LIST_SAVED_RESPONSESList reusable response templates available to the connected staff user, either all templates or the user’s ten most-used templates.

Input Parameters

string ("all" | "most_used")
Return every available template or only the connected user’s ten most-used templates.

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: HELP_SPOT_LIST_SUPPORT_OPTIONSList HelpSpot categories, statuses, custom fields, mailboxes, or active staff for request setup. Custom-field names may be returned as numeric IDs instead of labels.

Input Parameters

boolean
For statuses and mailboxes, omit inactive records; staff is already limited to active staff by HelpSpot.
integer
For custom_fields only, restrict definitions to one category.
string ("categories" | "statuses" | "custom_fields" | "mailboxes" | "staff")
required
Kind of request setup value to list.

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: HELP_SPOT_RUN_FILTERReturn one cursor-controlled page of request summaries from a saved or built-in HelpSpot queue filter.

Input Parameters

string
Offset cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue.
string
required
Numeric or symbolic filter selector returned by HELP_SPOT_LIST_FILTERS, such as inbox or myq.
integer
Requested number of requests in this page, from 1 to 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: HELP_SPOT_SEARCH_REQUESTSSearch support requests by text, customer, state, assignment, or date and return one concise cursor-controlled page.

Input Parameters

string ("all" | "any")
Require all supplied filters or allow any supplied filter to match.
string
Text to search across request content.
string
Continuation cursor returned by a previous call. It retains the search filters and page size; omit it for the first page.
boolean
Restrict results to open or closed requests.
integer
Requested number of results in this page, from 1 to 100.
integer
Restrict results to a HelpSpot status ID.
integer
Restrict results to one numeric HelpSpot request ID.
integer
Restrict results to a HelpSpot category ID.
string
Restrict results to a customer HelpSpot user ID.
integer
Return requests closed after this Unix timestamp.
integer
Return requests opened after this Unix timestamp.
integer
Return requests closed before this Unix timestamp.
integer
Return requests opened before this Unix timestamp.
string ("today" | "yesterday" | "past_7" | "past_14" | "past_30" | "past_90" | "past_365" | "this_week" | "this_month" | "this_year" | "last_week" | "last_month" | "last_year")
Apply one HelpSpot relative-date window instead of calculating timestamps.
string
Restrict results to a customer email address.
string
Match a customer phone number.
integer
Restrict results to the assigned HelpSpot staff ID.
string
Match a customer last name.
boolean
Include accumulated time totals in each result when available.
string
Match a customer first name.

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: HELP_SPOT_SET_REQUEST_SUBSCRIPTIONSubscribe or unsubscribe a staff user from updates to one support request.

Input Parameters

integer
required
Staff ID to subscribe or unsubscribe; use Get Current User or List Support Options to find it.
integer
required
Numeric HelpSpot request ID.
boolean
required
True to subscribe the staff user; false to unsubscribe them.

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: HELP_SPOT_UPDATE_REQUESTUpdate request, customer, assignment, and state fields and optionally append one customer-visible or internal note. Configured HelpSpot notifications may be sent.

Input Parameters

string
Note to append to the request.
string
Replacement request title or subject.
boolean
Set whether the request is open.
boolean
Set whether the request is urgent.
integer
Replacement status ID.
integer
required
Numeric HelpSpot request ID to update.
integer
Replacement category ID.
string
Replacement customer HelpSpot user ID.
array
Custom-field replacements keyed by numeric HelpSpot field ID.
string
Replacement customer email address.
string
Replacement customer phone number.
string ("customer" | "internal")
Visibility of the appended note; used only when note is supplied.
integer
Replacement assigned staff ID.
string
Replacement customer last name.
string
Replacement customer first name.

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