Helpwise

Learn how to use Helpwise with Composio

Overview

SLUG: HELPWISE

Description

Helpwise is an easy-to-use customer service platform that helps you manage all customer communication from a single place.

Authentication Details

generic_api_key
stringRequired
generic_secret
stringRequired

Connecting to Helpwise

Create an auth config

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

1

Select App

Navigate to Helpwise.

2

Configure Auth Config Settings

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

3

Create and Get auth config ID

Click “Create Helpwise 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

1from composio import Composio
2
3# Replace these with your actual values
4helpwise_auth_config_id = "ac_YOUR_HELPWISE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def 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 Helpwise for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, helpwise_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

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

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["HELPWISE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def 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
33invoke_llm()

Tool List

Tool Name: Create attachment

Description

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

Action Parameters

conversation_id
string
file
stringRequired
file_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add note to conversation

Description

Tool to add a note to a conversation. Use after obtaining the conversation_id to provide context.

Action Parameters

body
stringRequired
conversation_id
stringRequired
private
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Helpwise Team

Description

Tool to create a new team. Use when you need to group users under a team. Use after confirming unique team name.

Action Parameters

description
string
member_ids
array
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Helpwise Webhook

Description

Tool to create a new webhook in Helpwise. Use when you need to receive event notifications for conversations, messages, or other triggers.

Action Parameters

enabled
booleanDefaults to True
events
arrayRequired
secret
string
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Contact

Description

Tool to delete a contact. Use when you need to remove an existing contact by its unique identifier. Implements robust endpoint probing similar to DeleteWebhook: tries multiple paths and HTTP methods to accommodate dev-apis variations, with user-scoped fallbacks.

Action Parameters

contact_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Helpwise Conversation

Description

Tool to delete a conversation. Use when you need to permanently remove a conversation by its ID after confirming the ID is correct.

Action Parameters

conversation_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Mailbox

Description

Tool to delete a mailbox. Use when you need to remove an existing mailbox by its unique identifier.

Action Parameters

mailbox_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Helpwise Message

Description

Tool to delete a message. Use when you need to permanently remove a message by its ID after confirming the ID is correct.

Action Parameters

message_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Helpwise Note

Description

Tool 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.

Action Parameters

conversation_id
stringRequired
note_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Signature

Description

Tool to delete an email signature. Use when you need to remove a specific signature by its unique identifier after confirming its ID.

Action Parameters

signature_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Tag

Description

Tool to delete a tag. Use when you need to remove an existing tag by its unique identifier after confirming the ID.

Action Parameters

tag_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Team

Description

Tool to delete a team. Use when you need to remove an existing team by its unique identifier after confirming the ID and dependencies.

Action Parameters

team_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Template

Description

Tool to delete a template. Use when you need to permanently remove an email template by its ID after confirming the ID is correct.

Action Parameters

template_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Helpwise Webhook

Description

Tool to delete a webhook. Use when you need to remove a specific webhook by its ID after confirming the ID is correct.

Action Parameters

webhook_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Attachment

Description

Tool to retrieve a specific attachment. Use when you need to fetch an attachment by its ID; call after obtaining the attachment ID.

Action Parameters

attachment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Conversation Attachments

Description

Tool to retrieve attachments. Use when you need to list all files sent in a given conversation or across your account.

Action Parameters

conversation_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Helpwise Contact

Description

Tool to retrieve details of a specific contact. Use when you know the contact ID and need full contact information.

Action Parameters

contact_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Conversation

Description

Tool to retrieve details of a specific conversation. Use when you need full conversation context.

Action Parameters

conversation_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Conversations

Description

Tool to retrieve a list of conversations. Use when you need to list and paginate support conversations for display or analysis.

Action Parameters

assignee_id
string
page
integerDefaults to 1
per_page
integerDefaults to 20
requester_id
string
search
string
sort_by
string
sort_order
string
status
string
team_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Helpwise Mailbox

Description

Tool to retrieve details of a specific mailbox by its ID. Use when you know the mailbox ID and need full mailbox information.

Action Parameters

mailbox_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Helpwise Mailboxes

Description

Tool to retrieve mailboxes. Use when you need to list and paginate mailboxes after authenticating.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Get Helpwise Messages

Description

Tool to retrieve messages for a specific conversation. Use when you need to list and paginate messages within a conversation context.

Action Parameters

conversation_id
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Conversation Note

Description

Tool to retrieve details of a specific note. Use when you know the conversation and note IDs and need full note information.

Action Parameters

conversation_id
stringRequired
note_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Conversation Notes

Description

Tool to retrieve notes for a conversation. Use when you need to fetch all notes associated with a specific conversation after confirming the conversation ID is correct.

Action Parameters

conversation_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Helpwise Tag

Description

Tool to retrieve a specific tag. Use when you need to fetch the properties of a tag by its ID.

Action Parameters

tag_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Helpwise Team

Description

Tool to retrieve details of a specific team by its ID. Use after confirming the team_id.

Action Parameters

team_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Helpwise Teams

Description

Tool to retrieve Helpwise teams. Use when you need to list and paginate all teams for assignment or management.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Get Helpwise Templates

Description

Tool to retrieve Helpwise email templates. Use when you need to list and paginate all email templates for your account.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Get Helpwise Users

Description

Tool to retrieve Helpwise users list. Use when you need to fetch and paginate agents for assignment.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Get Helpwise Webhook

Description

Tool to retrieve details of a specific webhook. Use when you know the webhook ID and need full webhook configuration.

Action Parameters

webhook_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Helpwise Webhooks

Description

Tool to retrieve Helpwise webhooks. Use when you need to list and paginate all webhook configurations.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
arrayRequired
error
string
meta
objectRequired
successful
booleanRequired

Tool Name: Update Helpwise Contact

Description

Tool to update an existing Helpwise contact. Use when you need to modify contact details or custom attributes.

Action Parameters

contact_id
stringRequired
custom_attributes
object
email
string
name
string
organization
string
phone
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Mailbox

Description

Tool to update an existing mailbox. Use when you need to modify mailbox properties (for example name, address, or default status) after confirming the mailbox_id.

Action Parameters

address
string
is_default
boolean
mailbox_id
stringRequired
name
string
signature
string
team_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Helpwise Message

Description

Tool to update an existing message. Use when you need to modify message content by its ID.

Action Parameters

body
stringRequired
message_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Helpwise Tag

Description

Tool to update an existing tag. Use when you need to modify a tag's name or color after confirming the tag ID.

Action Parameters

color
string
name
stringRequired
tag_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Helpwise Template

Description

Tool to update an existing email template. Use when you need to modify template name, subject, or content after confirming the template ID.

Action Parameters

html
string
name
string
subject
string
template_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired