For developers
Any developers here? This category is for you!JavaScript API
Integrate JavaScript code
Once again, about the installation.
Displaying the chat widget on your site
Advanced displaying options
Enable user authentication mode via JS API
Know everything about your registered customers.
Custom Data
Custom attributes for your users, like favorite color, pets' name, or number of purchases.
Track custom events
Know how users navigate in your web or mobile app, what pages users visit.
Track chat events with Google Analytics
Track chat events with GA.
Set up localization
Define widget language through the API.
Send proactive chat auto-messages with JS API
Trigger auto messages based on your events
JS API methods
showChatWidget, updateUser, setPhraseList and more usefull stuff
JS API events
You can bind callbacks to HelpCrunch chat events
JS API user entity format
Different data formats, explained.
Security signature
Generate secret and keep your data safe.
Turbolinks
Only for those who are using Turbolinks on their websites
Widget Debug mode
Debug installation problems in the debug mode.
Rest API
How to use Rest API
Generate the key and you're good to go.
Rest API limitations
Just some ground rules to be familiar with.
Add a new customer via Rest API
Use the following API request if you want to add a new customer to HelpCrunch.
Update a customer via Rest API
Update customer data using the following Rest API request.
Update multiple customers via Rest API
You can update multiple customers at once in HelpCrunch using Rest API.
Delete customer via Rest API
You can delete multiple customers from HelpCrunch at once using the following Rest API request.
Get full customer data via Rest API
You can retrieve all customer personal data using the following Rest API request.
Bulk request customers via Rest API
You can bulk request customers with the help of Rest API.
Find customers by tag via Rest API
Retrieve customers data by sending the GET request with a tag name.
Customer fields and format for the HelpCrunch Rest API
The full list of customer fields that you can send to HelpCrunch via Rest API.
Get your agents info via Rest API
You can get your team data from HelpCrunch using the following method.
Get team / organization status via Rest API
Retrieve information about whether your team is online or offline and other organization data.
Create customer events via Rest API
Create new customer events for the “User Actions” section.
iOS SDK
Introduction to the HelpCrunch iOS SDK
This tutorial provides you with a step-by-step guide to configuring the HelpCrunch iOS SDK in your mobile app.Â
Configure your iOS app in HelpCrunch
Here's how you can install the HelpCrunch iOS SDK via CocoaPods and configure your app in the HelpCrunch dashboard.
Add the HelpCrunch iOS SDK to your app
Here's how you can add and initialize the HelpCrunch iOS SDK in your app.
Enable push notifications for iOS
And stay in touch with your users even when the application is not in the foreground.
Track your iOS users' data
Here's how you can collect and track your iOS users' data in HelpCrunch.
Display unread messages' count in your iOS app
Use the following method to display the number of unread chat messages in your iOS app.
Change chat widget localizations for your iOS app
Follow this guide to change chat widget's texts and language for your iOS app.
Login/logout/user change methods
If you want to be sure that new registered users will have other chat than the previous ones, you can use the following methods.
Android SDK
Configure your Android app in HelpCrunch
Here's how you can add your Android app to HelpCrunch and configure everything in it.
Add the HelpCrunch Android SDK to your app
You can add the HelpCrunch SDK to your Android application with Gradle or Maven build systems, here's how.
Enable push notifications for Android
Push notifications are great for real-time messaging and informing your app users that there is a new message for them.
Track Android users' data
Here's how you can collect and track your Android users' data in HelpCrunch.
Display unread messages' count in your Android app
Use the following method to display the number of unread chat messages in your Android app.
Change chat widget localizations for your Android app
Follow this guide to change your chat widget's texts and language.
Change push notifications' icons and texts for your Android app
Make your push notifications as beautiful as a rose.
Changing users
Use the following method to start a new chat or change a user.