Chatwoot Integration for
By Staff
By Staff
Help articles for the usage of Chatwoot Integration for
How to Install Chatwoot Integration for
First, download the addon package by visiting your license details page from the list of your licenses in the link below: https://dash.wevrlabs.net/clientarea.php?action=products&module=licensing Once you download the package, unzip the package file on your computer. Inside the package directory, choose the compressed addon zip file that corresponds to your environment. Upload this file to your installation inside the /modules/addons/ folder and unzip the contents there. In your dashboard, navigate to System Settings > Addon Modules. Locate the add-on (Chatwoot Integration for ) and activate it. Once you activate the add-on, obtain your license key from the license details page in the link above, enter it in the license key field, and then click to save the settings. To continue with configuring the addon settings, please follow the guides in the links below. How to Create the API Channel in Your Chatwoot Account
How to Create the API Channel in Your Chatwoot Account
To create the API channel that will handle tickets in your Chatwoot dashboard, access your Chatwoot dashboard, then go to Settings > Inboxes > Add Inbox Choose the API channel option, and once you are taken to enter the details, provide the name for the inbox, and enter the webhook URL To obtain the webhook URL, go back to System Settings > Addon Modules, then copy the URL displayed in the addon settings, and enter it in the step above. Also, tick the Enable API Channel option to activate ticket handling functionality. In the Chatwoot URL field, provide the URL for your Chatwoot install (this can be the cloud version or a self-hosted instance). Go back to Chatwoot and click the Create button to create the API channel inbox. Once created click the More Settings button to obtain the API Channel Inbox Identifier and HMAC key. Go to the Configuration tab, and copy the Inbox Identifier and the User Identity Validation key. Also, tick the Enforce User Identity Validation option (enabling this option is important). In the add-on settings in , enter your API channel Inbox ID, Inbox Identifier, and User Identity Validation in the respective fields. The API channel ID can be obtained from the URL in the browser whilst you are on the inbox settings page: Once you obtain this information, go to the addon settings, and enter it in the respective fields. Next, obtain your account ID from your Chatwoot dashboard by navigating to Settings > Account Settings section. Then obtain your Chatwoot account API token by navigating to your profile settings in Chatwoot. Enter the Account ID and API Token in the add-on settings in the respective fields. Once you provide all the information required in the addon settings, click to save the changes. You are now ready to handle your tickets in . Note that any tickets created prior to configuring and activating ticket handling in Chatwoot, these tickets will not be imported to Chatwoot, so you will have to handle them in . Next, to continue with configuring the live chat widget, please follow the guide below: How to Setup Chatwoot Live Chat Widget
How to Setup Chatwoot Live Chat Widget
Setting up a Chatwoot live chat widget is easy with the Chatwoot integration addon. First, create a live chat inbox in your Chatwoot account by following the official guide in this link below: https://www.chatwoot.com/hc/user-guide/articles/1677580558 After creating the live chat channel, copy JUST the websiteToken from the JS code (without the quote marks). In addition to the token, copy the User Identity Validation token and tick to enable the Enforce User Identity Validation option as well. In in the addon settings, insert the above values in the respective fields in the add-on. Tick the option as well to enable the live chat widget, then click to save the changes: You are now ready to display the Chatwoot live widget on your website. Additional Settings: The add-on allows you to customize various settings for the widget: For the labels, make sure that any value you enter for the labels matches the name of the labels you created in your Chatwoot account. So first create the labels in Chatwoot by following the official guide in this link: https://www.chatwoot.com/hc/user-guide/articles/1677496066 Custom Attributes: The addon also allows you to pass useful information about your customer to Chatwoot utilizing the custom attributes feature. To make use of the custom attributes features, please follow the guide in the link below: How to Pass Custom Attributes About Your Customer to Chatwoot
How to Pass Custom Attributes About Your Customer to Chatwoot
The Chatwoot Integration for addon allows you to pass various useful information about your customer to Chatwoot. First, make sure that you setup the live chat widget correctly by following the guide in the link below: How to Setup Chatwoot Live Chat Widget Next, to pass the custom attributes, use the following table to create the custom attributes in your Chatwoot account. You can create the custom attributes either as conversation custom attributes or contact custom attributes. To learn how to setup custom attributes in your Chatwoot account, follow the official guide in the link below: https://www.chatwoot.com/hc/user-guide/articles/1677502327 When you create the custom attribute in Chatwoot, make sure the custom attribute key matches one of the values in the table below. Custom Attributes Supported by the Addon: Custom Attribute Key Custom Attribute Type Information Passed client_id number The client ID in client_phone_number number The client's phone number in language text The client's language city text The client's city in state text The client's state in post_code text The client's postcode in country text The client's country in active_tickets number The number of active tickets for the client in credit_balance text The client's credit balance in revenue text The revenue generated by the client unpaid_invoices number The number of the client's unpaid invoices outstanding_total text The total of the client's unpaid invoices overdue_invoices number The number of the client's overdue invoices account_overdue text The total of the client's overdue invoices last_visited_page link The current page the client is browsing