Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

HelpCrunch

Manage chats, customers, and messages in HelpCrunch customer support platform via the HelpCrunch REST API v1.

Operations

Operation	Description
`list-chats`	Fetch a paginated list of chats, sorted by most recent message
`get-chat`	Fetch full details of a single chat by ID
`list-customers`	Fetch a paginated list of customers
`create-customer`	Add a new customer record
`send-message`	Post a message to a chat on behalf of an agent or customer
`get-messages`	Fetch all messages from a specific chat

API Key Setup

Log in to your HelpCrunch account.
Go to Settings → Developers → Public API.
Copy your API key.
Paste it into the apiKey input field when configuring this tool.

Authentication uses a Bearer token: Authorization: Bearer <api_key>.

Rate limit: 120 requests per minute.

Parameters

Parameter	Required for	Description
`apiKey`	All	HelpCrunch API key
`operation`	All	Operation name (see table above)
`chatId`	get-chat, send-message, get-messages	Numeric chat ID
`messageText`	send-message	Text content of the message
`agentId`	send-message (optional)	Agent ID to attribute message to; omit for customer messages
`messageType`	send-message (optional)	`message` (default, customer-visible) or `private` (agent note)
`customerName`	create-customer	Customer full name
`customerEmail`	create-customer	Customer email address
`customerPhone`	create-customer	Customer phone number
`offset`	list-* operations	Pagination offset (default: 0)
`limit`	list-* operations	Records per page, max 100 (default: 20)

Examples

List recent chats

operation: list-chats
apiKey: hc_live_xxxxxxxxxxxx
limit: 10

Send a message to a chat

operation: send-message
apiKey: hc_live_xxxxxxxxxxxx
chatId: 542335
messageText: Hello! How can I help you today?
agentId: 12
messageType: message

Create a new customer

operation: create-customer
apiKey: hc_live_xxxxxxxxxxxx
customerName: Jane Smith
customerEmail: [email protected]
customerPhone: +14155552671

Get messages from a chat

operation: get-messages
apiKey: hc_live_xxxxxxxxxxxx
chatId: 542335
limit: 50

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	HelpCrunch API key from Settings → Developers → Public API.
`operation`	string	yes	—	One of: list-chats, get-chat, list-customers, create-customer, send-message, get-messages
`chatId`	string	no	—	Chat identifier (required for get-chat, send-message, get-messages).
`messageText`	string	no	—	Text of the message to send (required for send-message).
`agentId`	string	no	—	Agent ID to attribute the message to (optional for send-message; omit for customer messages).
`messageType`	string	no	`message`	Message type for send-message: 'message' (visible to customer) or 'private' (agent note). Default: message
`customerName`	string	no	—	Customer name (for create-customer).
`customerEmail`	string	no	—	Customer email (for create-customer).
`customerPhone`	string	no	—	Customer phone number (for create-customer).
`offset`	string	no	`0`	Pagination offset for list operations. Default 0.
`limit`	string	no	`20`	Maximum records to return for list operations (max 100). Default 20.