Manage shared-inbox conversations and contacts in Helpwise via the Helpwise REST API v1.

Helpwise

Manage shared-inbox conversations and contacts in Helpwise via the official Helpwise REST API v1.

What it does

Operation	Description
`list_conversations`	List conversations across your inboxes, optionally filtered by inbox IDs, label, limit, and pagination token
`get_conversation`	Fetch a single conversation by inbox ID and conversation ID
`list_contacts`	Page through all contacts in your Helpwise account
`search_contacts`	Search contacts by name, email, or phone number

API key setup

Log in to Helpwise.
Go to Settings > API.
Copy your API Key and API Secret.
Supply them as apiKey and apiSecret inputs to this tool.

Authentication uses HTTP Basic auth: Basic BASE64(API_KEY:API_SECRET).

Examples

List recent conversations from two inboxes

- name: fetch
  tool: helpwise
  input:
    apiKey: "{{creds.helpwiseKey}}"
    apiSecret: "{{creds.helpwiseSecret}}"
    operation: list_conversations
    inboxIds: "204568,204700"
    limit: "50"

Get a specific conversation

- name: convo
  tool: helpwise
  input:
    apiKey: "{{creds.helpwiseKey}}"
    apiSecret: "{{creds.helpwiseSecret}}"
    operation: get_conversation
    inboxId: "227136"
    conversationId: "116851645"

Search contacts by email

- name: find
  tool: helpwise
  input:
    apiKey: "{{creds.helpwiseKey}}"
    apiSecret: "{{creds.helpwiseSecret}}"
    operation: search_contacts
    searchTerm: "[email protected]"
    limit: "10"

List all contacts (paginated)

- name: contacts
  tool: helpwise
  input:
    apiKey: "{{creds.helpwiseKey}}"
    apiSecret: "{{creds.helpwiseSecret}}"
    operation: list_contacts
    limit: "100"
    offset: "0"

Outputs

Key	Description
`result`	Raw JSON response body from the Helpwise API
`status`	HTTP status code as a string (e.g. `"200"`)

Rate limits

100 requests per minute per API key. The API returns 429 when the limit is exceeded.

Notes

Base URL: https://apis.helpwise.io
API documentation: https://documenter.getpostman.com/view/29744652/2s9YC5yYKf
inboxIds for list_conversations accepts a comma-separated string of integer IDs.
limit for list_conversations must be 100 or fewer.