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