Skip to content

Commit 308e73a

Browse files
committed
update main readme
1 parent c5a9020 commit 308e73a

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This library allows you the following,
66

77
- Track events happening on your site to [Hellotext](https://www.hellotext.com) in real-time.
88
- Use Hellotext Forms to dynamically collect data from your customers based on your specific business requirements.
9+
- Use Hellotext Webchat to interact with your customers in real-time.
910

1011
## Installation
1112

@@ -76,6 +77,7 @@ Hellotext.removeEventListener(eventName, callback)
7677
- `session-set`: This event is fired when the session value for `Hellotext.session` is set. Either through an API request, or if the session was found in the cookie.
7778
- `forms:collected` This event is fired when forms are collected. The callback will receive the array of forms collected.
7879
- `form:completed` This event is fired when a form has been completed. A form is completed when the user fills all required inputs and verifies their OTP(One-Time Password). The callback will receive the form object that was completed, alongside the data the user filled in the form.
80+
- View Webchat events [here](/docs/webchat.md#events)
7981

8082
## Understanding Sessions
8183

@@ -136,3 +138,4 @@ Hellotext.initialize('HELLOTEXT_BUSINESS_ID', configurationOptions)
136138
| session | A valid Hellotext session which was stored previously. When not set, Hellotext attempts to retrieve the stored value from `document.cookie` when available, otherwise it creates a new session. | String | null |
137139
| autoGenerateSession | Whether the library should automatically generate a session when no session is found in the query or the cookies | Boolean | true |
138140
| forms | An object that controls how Hellotext should control the forms on the page. See [Forms](/docs/forms.md) documentation for more information. | Object | { autoMount: true, successMessage: true } |
141+
| webchat | An object that controls how Hellotext should control the webchat on the page. See [Webchat](/docs/webchat.md) documentation for more information. | Object | { autoMount: true, successMessage: true } |

0 commit comments

Comments
 (0)