💾 JavaScript and REST API
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.
Create customer events via REST API
Create new customer events for the “User Actions” section.
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.
Mobile SDK
HelpCrunch SDKs for iOS and Android
Check this very short introduction to HelpCrunch mobile SDKs.