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

Tools

Slug: HELPWISE_CREATE_ATTACHMENTTool to upload a new attachment. Use when you need to send a file to Helpwise and receive its attachment metadata.

Input Parameters

object
required
File to upload to Helpwise.
string
ID of the conversation to associate this attachment with. If provided, the attachment will be linked to the specified conversation. Leave empty to create an unattached attachment.

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: HELPWISE_CREATE_NOTETool to add a note to a conversation. Use after obtaining the conversation_id to provide context.

Input Parameters

string
required
Content of the note
boolean
Flag indicating if the note is internal (private) and not visible to the customer
string
required
Unique identifier of the conversation to which the note will be added

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: HELPWISE_CREATE_TEAMCreates a new team in Helpwise to group users for collaboration and assignment purposes. Use this tool when you need to: - Create a new team with a unique name - Optionally add a description for the team - Optionally assign initial members by their user IDs IMPORTANT: Team creation via API is not available in the current Helpwise API. All tested endpoints (/api/v1/teams, /dev-apis/teams, /api/v1/team, /dev-apis/team) return 404. Team management appears to be limited to the Helpwise web interface. If you need to create teams, please: 1. Use the Helpwise web interface at https://app.helpwise.io 2. Contact Helpwise support at dev@helpwise.io to request API endpoint availability This action is implemented speculatively for future API support and follows standard patterns used in other Helpwise actions.

Input Parameters

string
required
Name of the team to create (must be unique within your workspace)
array
List of user IDs to add to the team upon creation
string
Optional description for the 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: HELPWISE_CREATE_WEBHOOKCreates a new webhook subscription in Helpwise to receive real-time event notifications. Use this action to programmatically subscribe to Helpwise events like conversation creation, message replies, conversation assignments, status changes, and tag applications. Webhooks deliver JSON payloads to your specified callback URL when subscribed events occur. IMPORTANT: Helpwise webhook management is primarily done through the UI at: Settings > Automation > Integrations > Webhooks (https://app.helpwise.io/settings/integrations) This action attempts to use programmatic API endpoints, but if they’re unavailable in your Helpwise plan or environment, you’ll need to create webhooks manually via the UI.

Input Parameters

string
required
Target URL for receiving webhook events (must return 200 status, not 404)
array
required
List of event names to subscribe to. Common events: ‘conversation.created’, ‘conversation.assigned’, ‘conversation.closed’, ‘message.created’
string
Optional secret key to validate webhook authenticity and ignore unauthorized requests
boolean
Whether the webhook should be active immediately upon creation

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: HELPWISE_DELETE_CONTACTDeletes a contact from Helpwise by its unique identifier (ID). Use this action when you need to permanently remove a contact from your Helpwise account. Returns an empty response (HTTP 204 No Content) on successful deletion. Note: This action is idempotent - deleting a non-existent contact will return an appropriate error.

Input Parameters

string
required
The unique identifier (ID) of the contact to delete. This can be obtained from contact listing endpoints or contact creation 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: HELPWISE_DELETE_CONVERSATIONAttempts to delete a conversation by ID from Helpwise. Note: The Helpwise API may not support conversation deletion via the REST API. If deletion is not supported, this action will return an error indicating that the endpoint was not found or the method is not allowed. Use this action when you need to attempt to permanently remove a conversation by its ID.

Input Parameters

string
required
Unique ID of the conversation to delete

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: HELPWISE_DELETE_MAILBOXTool to delete a mailbox by its unique identifier. NOTE: As of 2026, the Helpwise API may not support mailbox deletion via API. This action attempts deletion but will fail if the endpoint is not available (405 Method Not Allowed). Consider managing mailboxes through the Helpwise web interface if API deletion is unsupported.

Input Parameters

string
required
The unique identifier (ID) of the Helpwise mailbox to delete. This should be a numeric or alphanumeric string obtained from mailbox listing endpoints.

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: HELPWISE_DELETE_MESSAGEAttempts to delete a message from Helpwise. Note: The Helpwise API may not support message deletion via the REST API. If deletion is not supported, this action will return an error indicating that the DELETE method is not allowed (HTTP 405). Use this action when you need to attempt to permanently remove a message by its ID.

Input Parameters

string
required
Unique identifier of the Helpwise message to delete

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: HELPWISE_DELETE_NOTETool to delete a note from a conversation. Use when you need to permanently remove a note by its ID from a specific conversation after confirming the IDs.

Input Parameters

string
required
Unique ID of the note to delete
string
required
Unique ID of the conversation containing the note

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: HELPWISE_DELETE_SIGNATUREDeletes an email signature from Helpwise. Email signatures are text/HTML templates that automatically append to outgoing emails from specific mailboxes or users. This action permanently removes the signature identified by the signature_id. Returns an empty response on successful deletion (204 No Content).

Input Parameters

string
required
Unique identifier of the email signature to delete. Email signatures are templates that automatically append to outgoing emails. The ID can be obtained from the signature management interface in Helpwise settings.

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: HELPWISE_DELETE_TAGPermanently deletes a tag from Helpwise. This action removes the tag from all conversations where it was applied and cannot be undone. Use this when you need to permanently remove a tag that is no longer needed. Note: Deleting a tag will automatically remove it from all existing conversations that use this tag.

Input Parameters

string
required
The unique identifier (ID) of the tag to permanently delete. You can obtain tag IDs from the HELPWISE_GET_TAG action, from conversation responses, or from the Helpwise web interface.

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: HELPWISE_DELETE_TEAMTool to delete a team. Use when you need to remove an existing team by its unique identifier after confirming the ID and dependencies.

Input Parameters

string
required
Unique identifier of the Helpwise team to delete

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: HELPWISE_DELETE_TEMPLATEDeletes a Helpwise email template (saved reply) by its ID. Returns empty response on success (HTTP 204). Use this tool when you need to permanently remove a template that is no longer needed. Ensure the template_id is valid before deletion - this operation cannot be undone. Common responses: - Success (204): Template deleted successfully - Not Found (404): Template ID does not exist or was already deleted - Forbidden (403): No permission to delete this template

Input Parameters

string
required
Unique identifier of the Helpwise template to delete

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: HELPWISE_DELETE_WEBHOOKDelete a Helpwise webhook by its ID. Use this tool when you need to permanently remove a webhook configuration. Returns an empty response on successful deletion (HTTP 204 No Content).

Input Parameters

string
required
Unique identifier of the Helpwise webhook to delete

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: HELPWISE_GET_ATTACHMENTRetrieves metadata for a Helpwise attachment by its ID, such as its file name, download URL, content type, and timestamps.

Input Parameters

string
required
The unique ID of the attachment you want to retrieve. Obtain this from conversations, messages, or by listing attachments.

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: HELPWISE_GET_ATTACHMENTSRetrieves attachment metadata from messages for a specified conversation. Attachment entries containing only IDs are skipped, so the result may not include every attachment.

Input Parameters

string
required
Unique identifier of the conversation to fetch attachments for. Required - Helpwise retrieves attachments through messages, which must be scoped to a conversation.

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: HELPWISE_GET_CONTACTRetrieves detailed information for a specific contact by ID. Use this when you need to fetch complete contact details including name, email, phone, company, and timestamps for a known contact ID.

Input Parameters

string
required
Unique identifier of the contact 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: HELPWISE_GET_CONVERSATIONRetrieves a specific Helpwise conversation by ID, returning selected metadata such as subject, status, participants, and timestamps when available.

Input Parameters

string
required
Unique identifier of the conversation 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: HELPWISE_GET_CONVERSATIONSLists Helpwise support conversations for display or analysis, with pagination and optional mailbox, status, assignment, requester, and search filters. Results can be sorted by creation or update time.

Input Parameters

integer
Page number to retrieve, must be >= 1
Search term to filter conversations
string ("open" | "closed" | "pending" | "draft")
Filter by conversation status
string ("created_at" | "updated_at")
Field to sort by
string
Filter by team ID handling the conversation
integer
Items per page, must be >= 1
string
Mailbox ID to retrieve conversations from. If not provided, retrieves conversations across all mailboxes.
string ("asc" | "desc")
Sort order: asc or desc
string
Filter by assignee user ID
string
Filter by requester user 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: HELPWISE_GET_CUSTOM_FIELDRetrieves details of a specific custom field by its ID. Use this when you need to fetch custom field properties such as name, description, value, associated inboxes, and creator information.

Input Parameters

integer
required
Unique identifier of the custom field 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: HELPWISE_GET_MAILBOXRetrieves details of a Helpwise mailbox using its mailbox ID.

Input Parameters

string
required
Unique identifier of the mailbox 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: HELPWISE_GET_MAILBOXESLists Helpwise mailboxes with page-based pagination. The requested page size can be up to 100 mailboxes.

Input Parameters

integer
Page number to fetch, must be 1 or greater
integer
Number of mailboxes per page, maximum 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: HELPWISE_GET_NOTERetrieves details of a Helpwise conversation note using the conversation ID and note ID.

Input Parameters

string
required
Unique ID of the note to retrieve
string
required
Unique ID of the conversation containing the note

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: HELPWISE_GET_NOTESRetrieves notes associated with a specified conversation for collaboration and context. Results reflect the response from a single request and may not include every note.

Input Parameters

string
required
Unique identifier of the conversation. Obtain this from conversation listing or creation endpoints.

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: HELPWISE_GET_TAGRetrieves detailed information about a specific tag in Helpwise. Use this action when you need to: - Get the full properties of a tag including its name, color, and timestamps - Verify that a tag exists before performing operations on it - Retrieve tag details for display or processing Tags in Helpwise are labels that can be applied to conversations for organization and filtering.

Input Parameters

string
required
The unique identifier of the tag to retrieve. This ID is returned when listing tags or can be found in tag-related responses from other endpoints.

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: HELPWISE_GET_TEAMRetrieves a Helpwise team by ID, including its name and available timestamps. If the response omits a name, a placeholder name is supplied.

Input Parameters

string
required
Unique identifier of the Helpwise team 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: HELPWISE_GET_TEAMSLists Helpwise teams for assignment or management, with page-based pagination. The requested page size can be up to 100 teams.

Input Parameters

integer
Page number to fetch, must be 1 or greater
integer
Number of teams per page, maximum 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: HELPWISE_GET_TEMPLATESLists Helpwise WhatsApp message templates for a mailbox. If no mailbox is specified, the tool attempts to use the first available mailbox.

Input Parameters

integer
WhatsApp mailbox ID to fetch templates for. If not provided, will attempt to fetch from any available mailbox.

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: HELPWISE_GET_USERSLists Helpwise users with page-based pagination, for example to find agents for assignment.

Input Parameters

integer
Page number to fetch, must be >= 1
integer
Number of users per page, must be >= 1

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: HELPWISE_GET_WEBHOOKRetrieve detailed configuration for a specific Helpwise webhook by its ID. Use this action when you: - Need to inspect the configuration of an existing webhook - Want to verify webhook settings (URL, events, active status) - Need to check webhook creation/update timestamps Prerequisites: You must have a valid webhook ID, which can be obtained from the ‘Get Webhooks’ action or when creating a webhook.

Input Parameters

string
required
The unique identifier of the webhook to retrieve. This is typically a numeric ID (e.g., ‘123’) returned when creating a webhook or from the list webhooks endpoint.

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: HELPWISE_GET_WEBHOOKSLists Helpwise webhook configurations with page-based pagination. The requested page size can be up to 100 webhooks.

Input Parameters

integer
Page number to fetch, must be 1 or greater
integer
Number of webhooks per page, maximum 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: HELPWISE_SEARCH_CONTACTSSearches Helpwise contacts by term, with optional limit and offset pagination. When the API does not provide a total, the returned total is the number of contacts in the response.

Input Parameters

string
required
Search term to find contacts by name, email, phone, or other contact fields
integer
Number of results per page (1-100)
integer
Offset for pagination (starting from 0)

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: HELPWISE_UPDATE_CONTACTTool to update an existing Helpwise contact. Use when you need to modify contact details or custom attributes.

Input Parameters

string
Full name of the contact
string
Email address of the contact
string
Phone number of the contact
string
required
The unique identifier of the contact to update
string
Organization or company name of the contact
object
A dictionary of custom key-value attributes for the contact

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: HELPWISE_UPDATE_MAILBOXUpdate an existing Helpwise mailbox by ID, changing its display name, address, team assignment, signature, or default status. At least one setting must be provided.

Input Parameters

string
New display name for the mailbox. If provided, updates the mailbox’s visible name.
string
Email address associated with the mailbox. Updates the email address used for this mailbox.
string
Team ID to assign this mailbox to. Use the Get Teams action to retrieve valid team IDs.
string
Email signature to append to outgoing emails from this mailbox. Supports multi-line text.
boolean
Set to true to make this the default mailbox for sending emails, or false to remove default status.
string
required
Unique identifier of the mailbox to update. Can be obtained from the Get Mailboxes 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: HELPWISE_UPDATE_MESSAGETool to update an existing message. Use when you need to modify message content by its ID.

Input Parameters

string
required
Updated content of the message
string
required
Unique identifier of the message to update

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: HELPWISE_UPDATE_TAGUpdates a Helpwise tag by ID, supplying its name and optionally its color.

Input Parameters

string
required
Updated name for the tag. This will replace the existing tag name.
string
Optional hex color code for the tag (e.g., #FF0000 for red, #00FF00 for green). If not provided, the existing color will be preserved.
string
required
Unique identifier of the tag to update. Obtain this from HELPWISE_GET_TAG or by listing tags through the Helpwise UI.

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: HELPWISE_UPDATE_TEMPLATEUpdates an existing Helpwise email template by modifying its name, subject, and/or HTML content. Use this action when you need to: - Change the display name of a template - Update the subject line (including placeholders) - Modify the HTML content/body of the template Prerequisites: - You must have the template_id (obtain via Get Templates action or Helpwise UI) - At least one field (name, subject, or html) must be provided for update Note: This action performs a partial update - only provided fields will be modified.

Input Parameters

string
Updated HTML content/body of the template. Supports placeholders like {{variable_name}}. If not provided, the existing content will remain unchanged.
string
New display name for the template. If not provided, the existing name will remain unchanged.
string
New subject line for emails sent using this template. Supports placeholders like {{customer_name}}. If not provided, the existing subject will remain unchanged.
string
required
Unique identifier of the template to update. Obtain this from the Get Templates action or from the Helpwise UI.

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