The Helpwise connector lets your AI agent act in each user's Helpwise account. Each user connects their own Helpwise API key and secret once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 26 tools.
- Tools
- 26
- What they doRead · write · destructive
- 12 · 10 · 412 read10 write4 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Helpwise connection
In AgentKit > Connections, create a Helpwise connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolhelpwise_contact_getGet one contact by ID with emails, phones, company and custom fields.Read-onlyGet Contact
Get one contact by ID with emails, phones, company and custom fields. Returns the contact.
Inputs
contact_idintegerrequired- Contact ID, from helpwise_contacts_list or helpwise_contacts_search. Example: 24621644.
helpwise_contacts_listList contacts in the account with limit and offset paging.Read-onlyList Contacts
List contacts in the account with limit and offset paging. Returns contacts with names, emails, phones and custom fields. Use helpwise_contacts_search to find by text.
Inputs
limitinteger- Number of contacts to return. Example: 50.
offsetinteger- Number of contacts to skip. Example: 0.
helpwise_contacts_searchSearch contacts by name, email, phone or company text.Read-onlySearch Contacts
Search contacts by name, email, phone or company text. Returns matching contacts.
Inputs
termstringrequired- Text to search for. Example: john.doe@acme.com.
limitinteger- Number of contacts to return. Example: 20.
offsetinteger- Number of contacts to skip. Example: 0.
helpwise_conversation_getGet the messages of one conversation in an inbox, with token paging.Read-onlyGet Conversation
Get the messages of one conversation in an inbox, with token paging. Returns messages with sender, body and time, and the next page token.
Inputs
conversation_idintegerrequired- Conversation ID, from helpwise_conversations_list. Example: 116851645.
inbox_idintegerrequired- Inbox (mailbox) ID; it appears in the inbox URL in Helpwise. Example: 227136.
label_idinteger- Folder to read: 14 all (default), 0 assigned, 10 unassigned, 11 starred, 9 snoozed, 2 draft, 1 sent, 7 closed, 8 spam, 5 trash, 6 scheduled. Example: 14.one of
14010119217856 limitinteger- Number of messages to return. Example: 20.
page_tokenstring- Page token from the previous response, to get the next page. Example: 2026-01-15+11:06:54.
helpwise_conversations_listList conversations in an inbox, optionally in one folder (assigned, unassigned, closed, spam and so on), with token paging.Read-onlyList Conversations
List conversations in an inbox, optionally in one folder (assigned, unassigned, closed, spam and so on), with token paging. Returns conversations with subject, contact, assignee, status and the next page token. Use helpwise_conversation_get for a conversation's messages.
Inputs
inbox_idintegerrequired- Inbox (mailbox) ID to list conversations from. Example: 204568.
label_idinteger- Folder to read: 14 all (default), 0 assigned, 10 unassigned, 11 starred, 9 snoozed, 2 draft, 1 sent, 7 closed, 8 spam, 5 trash, 6 scheduled. Example: 14.one of
14010119217856 limitinteger- Number of conversations to return, up to 100. Example: 50.
page_tokenstring- Page token from the previous response, to get the next page. Example: 2026-01-15+11:06:54.
helpwise_custom_field_getGet one custom field by ID.Read-onlyGet Custom Field
Get one custom field by ID. Returns the field.
Inputs
custom_field_idintegerrequired- Custom field ID, from helpwise_custom_fields_list. Example: 204514.
helpwise_custom_fields_listList the account's contact custom fields.Read-onlyList Custom Fields
List the account's contact custom fields. Returns field IDs, names and descriptions. Use the IDs in contact custom_fields.
Inputs
This tool takes no inputs.
helpwise_inbox_custom_fields_listList the custom fields of one inbox with whether each is shown or hidden there.Read-onlyList Inbox Custom Fields
List the custom fields of one inbox with whether each is shown or hidden there. Returns fields.
Inputs
inbox_idintegerrequired- Inbox (mailbox) ID; it appears in the inbox URL in Helpwise. Example: 227136.
helpwise_overall_report_getGet the overall and team performance report for a period, optionally for one inbox or tag: emails per day, new, closed and assigned conversations, busiest hours, resolution and response times, CSAT and per-agent figures.Read-onlyGet Overall Report
Get the overall and team performance report for a period, optionally for one inbox or tag: emails per day, new, closed and assigned conversations, busiest hours, resolution and response times, CSAT and per-agent figures. Returns the report.
Inputs
endstringrequired- End of the period, YYYY-MM-DD HH:MM:SS. Example: 2026-01-31 23:59:59.
startstringrequired- Start of the period, YYYY-MM-DD HH:MM:SS. Example: 2026-01-01 00:00:00.
inbox_idinteger- Only this inbox; all inboxes when empty. Example: 23456.
is_business_hoursinteger- 1 to count only working hours, 0 (default) for all hours. Example: 0.one of
01 tag_idinteger- Only conversations with this tag ID. Example: 87865.
helpwise_tag_getGet one tag by ID.Read-onlyGet Tag
Get one tag by ID. Returns the tag.
Inputs
tag_idintegerrequired- Tag ID, from helpwise_tags_list. Example: 333333.
helpwise_contact_createCreate a contact with name, company, job title, emails, phones and custom field values.WriteCreate Contact
Create a contact with name, company, job title, emails, phones and custom field values. Returns the new contact.
Inputs
companystring- Company name. Example: Acme Inc.
custom_fieldsarray- Custom field values, each with id, name and value; field IDs from helpwise_custom_fields_list. Example: [{"id": 204513, "name": "City", "value": "San Francisco"}]
emailsarray- Email addresses. Example: ["john.doe@acme.com"]
firstnamestring- First name. Example: John.
job_titlestring- Job title. Example: Operations Manager.
lastnamestring- Last name. Example: Doe.
phonesarray- Phone numbers, each with phoneTxt, phoneNo and type. Example: [{"phoneTxt": "+14155550123", "phoneNo": "+14155550123", "type": "0"}]
helpwise_contact_updateUpdate a contact's name, company, job title, emails, phones or custom field values.WriteUpdate Contact
Update a contact's name, company, job title, emails, phones or custom field values. Returns the updated contact.
- Idempotent
Inputs
contact_idintegerrequired- Contact ID, from helpwise_contacts_list or helpwise_contacts_search. Example: 24621644.
companystring- Company name. Example: Acme Inc.
custom_fieldsarray- Custom field values, each with id, name and value; field IDs from helpwise_custom_fields_list. Example: [{"id": 204513, "name": "City", "value": "San Francisco"}]
emailsarray- Email addresses. Example: ["john.doe@acme.com"]
firstnamestring- First name. Example: John.
job_titlestring- Job title. Example: Operations Manager.
lastnamestring- Last name. Example: Doe.
phonesarray- Phone numbers, each with phoneTxt, phoneNo and type. Example: [{"phoneTxt": "+14155550123", "phoneNo": "+14155550123", "type": "0"}]
helpwise_conversations_closeClose up to 100 conversations.WriteClose Conversations
Close up to 100 conversations. Returns the result. Use helpwise_conversations_move_to_inbox to reopen them.
- Idempotent
Inputs
idsarrayrequired- Conversation IDs, up to 100, from helpwise_conversations_list. Example: [116851645, 116851702]
helpwise_conversations_move_to_inboxMove up to 100 conversations back to the inbox, reopening closed, spam or trashed ones.WriteMove Conversations to Inbox
Move up to 100 conversations back to the inbox, reopening closed, spam or trashed ones. Returns the result.
- Idempotent
Inputs
idsarrayrequired- Conversation IDs, up to 100, from helpwise_conversations_list. Example: [116851645, 116851702]
helpwise_custom_field_createCreate a contact custom field.WriteCreate Custom Field
Create a contact custom field. Returns the new field ID.
Inputs
namestringrequired- Name of the custom field. Example: Pin Code.
descriptionstring- Description of the custom field. Example: Postal code of the customer's location.
helpwise_custom_field_updateRename a custom field or change its description.WriteUpdate Custom Field
Rename a custom field or change its description. Returns the result.
- Idempotent
Inputs
custom_field_idintegerrequired- Custom field ID, from helpwise_custom_fields_list. Example: 204514.
descriptionstring- New description. Example: Postal code of the billing address.
namestring- New name. Example: Postal Code.
helpwise_inbox_custom_fields_updateHide and/or show custom fields in one inbox.WriteShow or Hide Inbox Custom Fields
Hide and/or show custom fields in one inbox. Returns the result.
- Idempotent
Inputs
inbox_idintegerrequired- Inbox (mailbox) ID; it appears in the inbox URL in Helpwise. Example: 227136.
hide_idsarray- Custom field IDs to hide in the inbox. Example: [204513]
unhide_idsarray- Custom field IDs to show in the inbox. Example: [204522]
helpwise_sms_whatsapp_message_sendSend an SMS or WhatsApp message to a customer's phone number from an SMS or WhatsApp inbox, now or scheduled; WhatsApp can use an approved template.WriteSend SMS or WhatsApp Message
Send an SMS or WhatsApp message to a customer's phone number from an SMS or WhatsApp inbox, now or scheduled; WhatsApp can use an approved template. Optionally close, assign or move the conversation in the same call. Returns the sent message. The customer receives it.
Inputs
bodystringrequired- Message text. Example: Hi John, your order has shipped.
client_numberstringrequired- Customer's phone number in international format. Example: +14155550123.
inbox_idintegerrequired- ID of the SMS or WhatsApp inbox to send from. Example: 256785.
actionobject- Conversation action to apply with the message, for example {"assignTo": 0, "name": "unassign"}; name can be unassign, close, spam, trash or moveToInbox. Example: {"name": "close"}
hashstring- Your own identifier for this request, to match parallel calls. Example: h7hfjk8khjl99kngq.
schedule_msgboolean- Set to true to schedule the message for send_at. Example: true.
send_atstring- When to send a scheduled message, ISO 8601 UTC. Example: 2026-02-01T09:46:00.000Z.
templateobject- WhatsApp template: templateId and templateVariables, plus headerVariables or locationVariables when the template needs them. Example: {"templateId": 245670, "templateVariables": ["John", "112233", "Shipped"]}
helpwise_conversations_deletePermanently delete up to 100 conversations.DestructiveDelete Conversations
Permanently delete up to 100 conversations. Returns the result. Use helpwise_conversations_trash to keep them recoverable.
- Idempotent
Inputs
idsarrayrequired- Conversation IDs, up to 100, from helpwise_conversations_list. Example: [116851645, 116851702]
helpwise_conversations_mark_spamMove up to 100 conversations to spam.DestructiveMark Conversations as Spam
Move up to 100 conversations to spam. Returns the result. Reverse it with helpwise_conversations_move_to_inbox.
- Idempotent
Inputs
idsarrayrequired- Conversation IDs, up to 100, from helpwise_conversations_list. Example: [116851645, 116851702]
helpwise_conversations_trashMove up to 100 conversations to trash.DestructiveTrash Conversations
Move up to 100 conversations to trash. Returns the result. Reverse it with helpwise_conversations_move_to_inbox.
- Idempotent
Inputs
idsarrayrequired- Conversation IDs, up to 100, from helpwise_conversations_list. Example: [116851645, 116851702]
helpwise_custom_field_deleteDelete a custom field and its values on contacts.DestructiveDelete Custom Field
Delete a custom field and its values on contacts. Returns the result.
- Idempotent
Inputs
custom_field_idintegerrequired- Custom field ID, from helpwise_custom_fields_list. Example: 204514.
No tools match.