survaii-chat-pulse
v0.0.9-beta
Published
Survaii Chat Pulse allows you to track specific events on your platform (click, hover, scroll, etc.) and receive real-time notifications ("pulses") in Slack channels. Mention the Survaii bot in the channel to instantly connect with the customer via live c
Downloads
31
Readme
Survaii Chat Pulse
Survaii Chat Pulse allows you to track specific events on your platform (click, hover, scroll, etc.) and receive real-time notifications ("pulses") in Slack channels. Mention the Survaii bot in the channel to instantly connect with the customer via live chat.
Getting Started
First, sign up on Survaii and request an API key by contacting us at [email protected].
Installation
To get started, install the survaii-chat-pulse
package. Run the following command in your terminal:
npm i survaii-chat-pulse
Usage
1. Import the Library
Import the initializeChat
function from the survaii-chat-pulse
package in your component file. Make sure the component is a client-side component, and check for window
availability before initializing the chat.
import { useEffect } from 'react';
import { initializeChat } from 'survaii-chat-pulse';
const MyComponent = () => {
useEffect(() => {
if (typeof window !== 'undefined') {
const chatInstance = initializeChat({
mountId: 'chat-mount', // mount id (e.g., chat-mount)
appKey: 'api-key',
});
// Example of sending a pulse
chatInstance.updateVisibility('My first pulse');
}
}, []);
return <div id="chat-mount"></div>;
};
export default MyComponent;
2. Initialize the Chat
Use the initializeChat
function with the required parameters such as mountId
and appKey
(API key).
const chatInstance = initializeChat({
mountId: 'chat-mount', // mount id (e.g., chat-mount)
appKey: 'api-key',
});
3. Send a Pulse
Every time you call the updateVisibility()
method, it will send a new pulse, resulting in the creation of a new Slack channel. You can pass a string parameter to provide context about this pulse.
chatInstance.updateVisibility('My first pulse');
Features
- Event Tracking: Monitor user interactions like clicks, hovers, and scrolls.
- Pulse Notifications: Receive real-time alerts for each event in dedicated Slack channels.
- Instant Live Chat: Connect with customers instantly by mentioning the Survaii bot in the Slack channel.
- Organized Communication: Each pulse creates a new Slack channel, keeping your team’s interactions clear and focused.
Benefits
- Immediate Response: Engage with customers as soon as they interact with your platform.
- Enhanced Support: Provide swift resolutions with real-time chat capabilities.
- Actionable Insights: Understand customer behavior to optimize your platform.
Enhance your customer engagement and support with real-time notifications and live chat using Survaii Chat Pulse. Install today and transform your customer interaction strategy!