Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Helpwise

Scalekit connector
Open markdown

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

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  3. Create the Helpwise connection

    In AgentKit > Connections, create a Helpwise connection. The name you give it is the connection_name your code passes. See Configure connections.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • helpwise_contact_getGet one contact by ID with emails, phones, company and custom fields.Read-only

    Get 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-only

    List 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_conversation_getGet the messages of one conversation in an inbox, with token paging.Read-only

    Get 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-only

    List 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-only

    Get 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-only

    List 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-only

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