https://www.olark.com/api/ Recent content in JavaScript API on Olark Hugo -- gohugo.io en-us https://www.olark.com/api/system_custom_prechat/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_custom_prechat/ Dynamically add questions to your prechat survey with ‘system.custom_prechat’. Pass an array of the questions you’d like to add using the format below: olark.configure('system.custom_prechat', [ { type: "textarea", is_required: false, label: 'What can we help with today?', placeholder_text: "I need help with..." } ]); The type property refers to the type of question you would like to ask your visitors and is used in form styling and validation. Options include: https://www.olark.com/api/system_allowed_domains/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_allowed_domains/ Set which domains the chatbox will be displayed on. If your website spans multiple domains' subdomains, you can choose which subdomains will work. Note that chats cannot continue across top-level domains. In order for chats to go from a top-level domain to a subdomain, the top-level domain cannot be a naked domain (i.e. the URL should be http://www.example.com, not http://example.com). Use * as a wildcard. Separate multiple domains with commas, e. https://www.olark.com/api/calloutbubble_slide/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/calloutbubble_slide/ Enables the Attention Grabber slide-out animation. Animate Attention Grabber on checkout page If you’d like to reach out to people on your checkout page to ensure you make the sale, or offer a discount, you might wish to animate the Attention Grabber on that page only, to give it extra prominence. // Check if the page URL contains 'checkout' if(window.location.href.indexOf("checkout") >= 0){ // Enable the Attention Grabber olark.configure('CalloutBubble.slide', true ); } When the Attention Grabber slides out, it looks like this: https://www.olark.com/api/calloutbubble_bubble_height/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/calloutbubble_bubble_height/ Set the Attention Grabber image height in pixels. For example: olark.configure('CalloutBubble.bubble_height', 25 ); Results in an attention grabber with a height of 25px. This only works if you either, have the Attention Grabber switched on in the Attention Grabber settings, or are using the API call to Enable the Attention Grabber. https://www.olark.com/api/calloutbubble_bubble_width/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/calloutbubble_bubble_width/ Set the Attention Grabber image width in pixels. For example: olark.configure('CalloutBubble.bubble_width', 100 ); Results in an attention grabber with a width of 100px. This only works if you either, have the Attention Grabber switched on in the Attention Grabber settings, or are using the API call to Enable the Attention Grabber. https://www.olark.com/api/system_hb_position/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hb_position/ Change the position of the chatbox. This can also be changed site wide from the Theme Settings Page. https://www.olark.com/api/system_hb_chatbox_size/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hb_chatbox_size/ Change the size of the chatbox. The chatbox can be configured to appear in one of three different sizes: small, medium, or large. By default, it uses the medium size. Changing the size of the chatbox will also modify the size of the chat button. This configure call will only accept a string value indicating the size you would like to use. For example olark.configure('system.hb_chatbox_size', 'sm'); // Small olark.configure('system.hb_chatbox_size', 'md'); // Medium olark. https://www.olark.com/api/system_hb_custom_style_font/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hb_custom_style_font/ Choose what font you’d like the chatbox to have. Use this call with an Array of valid loaded fonts. Note that the fonts must be loaded on your site for the chatbox to be able to use them. olark.configure('system.hb_custom_style', { general: { fonts: ['Bitter', 'serif'], corners: '', secondaryColor: '' } }); https://www.olark.com/api/api_chat_setoperatorgroup/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_setoperatorgroup/ Note: This method requires a plan that supports the Groups feature. Locks the visitor to a specific group of operators. All messages from the visitor will now go to that group of operators instead of all operators. See the operator configuration page to find the Group ID. Choose operator group by button click When the visitor clicks the Talk to our Sales Team button, lock to the Sales Group specifically. https://www.olark.com/api/system_right_to_left/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_right_to_left/ Change the text position for right to left language support. This can also be changed site wide from the Theme Settings Page. https://www.olark.com/api/system_hb_custom_style_corners/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hb_custom_style_corners/ We have two options that allow you to have ‘soft’ or ‘hard’ corners for the chatbox. By default the chatbox will have soft corners. olark.configure('system.hb_custom_style', { general: { fonts: [''], corners: 'hard', secondaryColor: '' } }); https://www.olark.com/api/system_hb_custom_style_secondary_color/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hb_custom_style_secondary_color/ Change the color of your visitor messages. This configuration key will only accept hex values. olark.configure('system.hb_custom_style', { general: { fonts: [''], corners: '', secondaryColor: '#ffe6ff' } }); https://www.olark.com/api/system_localization/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_localization/ You can change the language of the chatbox per page by using the following configuration call. If you want to change the language of the chatbox site wide you can do so from your Text & Forms settings. We support the following languages. olark.configure("system.localization", "en-US"); // English (United States) olark.configure("system.localization", "de-DE"); // Deutsch (Deutschland) olark.configure("system.localization", "es-ES"); // Spanish (Spain) olark.configure("system.localization", "fr-FR"); // Français (France) olark.configure("system.localization", "it-IT"); // Italian (Italy) olark.configure("system.localization", "nl-NL"); // Dutch (Netherlands) olark. https://www.olark.com/api/api_rules_definerule/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_rules_definerule/ Note: You can create Targeted Chat rules without any coding on the Targeted Chat settings page. Create Targeted Chat rules that help you automate decisions about how and when to interact with visitors and operators. You can create rules to perform actions such as: Initiating chat with a visitor who has been browsing for more than 30 seconds Notifying an operator when a visitor lands on the page from a Google AdWords campaign Highlighting important visitors in your buddy list Be sure to check out the getDetails API call to learn how to access detailed customer information for making creative rules. https://www.olark.com/api/system_hb_disable_mobile/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hb_disable_mobile/ Disable the mobile chatbox. This can also be changed site wide from the Theme Settings Page. https://www.olark.com/api/api_box_setlocale/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_box_setlocale/ You can dynamically change the chatbox language after the page has loaded. By using this call the default localization strings provided by Olark will be used and will override any text you have set in the Text & Forms dashboard. This call, however, will not override any language configuration calls like olark.configure('locale.welcome_title', 'Foo'), the string provided by that call always takes highest priority. You can see a list of languages we support here. https://www.olark.com/api/features_attention_grabber/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/features_attention_grabber/ You can enable the Attention Grabber on a page by page basis using this API call. Show Attention Grabber on checkout page If you’d like to reach out to people on your checkout page to ensure you make the sale, or offer a discount, you might wish to show the Attention Grabber on that page only. // Check if the page URL contains 'checkout' if(window.location.href.indexOf("checkout") >= 0){ // Enable the Attention Grabber olark. https://www.olark.com/api/features_feedback/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/features_feedback/ Enable the post-chat survey on a specific page. You can also enable this on the Chat Ratings settings page. https://www.olark.com/api/features_google_analyics/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/features_google_analyics/ Use this API call to enable the Google Analytics integration on a single page. You can also enable this in your Google Analytics Extension settings. https://www.olark.com/api/features_greeter/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/features_greeter/ Enable the Greeter on a specific page. You can also enable this on the Greeter extension page. https://www.olark.com/api/features_prechat_survey/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/features_prechat_survey/ You can enable the Pre-chat Survey feature on a specific page. This can also be done on your Text & Forms settings page. You can read more about using the Pre-chat Survey in our help section. https://www.olark.com/api/box_start_expanded/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/box_start_expanded/ Expand the chatbox by default when the page loads. Note that when the chatbox is expanded, Attention Grabber images are hidden. Also, sending a message will automatically expand the chatbox in all cases by default. https://www.olark.com/api/api_box_expand/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_box_expand/ Expands the chatbox to its fully expanded height. It will also show the chatbox if not already visible, in the same way as api.box.show. Using this API call overrides any existing Targeted Chat rules that may hide the chatbox. Click to chat link A classic use of the Javascript API is to make your own click-to-chat button. Clicking this button will show the Olark chatbox and expand it to its maximum height. https://www.olark.com/api/system_hb_detached/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hb_detached/ Normally, the chatbox is anchored to the bottom of the webpage. This detaches the chatbox from the bottom of the page, allowing it to float near the bottom instead. olark.configure('system.hb_detached', true); https://www.olark.com/api/api_visitor_getdetails/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_visitor_getdetails/ Gets the email address, full name, geolocation, and other details for this visitor. The value will be returned to the specified returnCallback. The name, email and phone number fields are the last-known visitor information, either from your pre-chat survey, a completed offline message form, or previously updated via the API. Geolocation information is provided to the best of our knowledge, based on the visitor’s IP. Note: As part of our effort to remove personally identifiable information from our API, this call no longer provides access to the visitor’s IP address. https://www.olark.com/api/api_box_hide/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_box_hide/ Hides the chatbox. This box will make the chatbox disappear on the page, but operators will still be able to see visitors in their visitor list. Hide the chatbox if not logged in You might want Olark to be loaded in the background on a particular page, but not show immediately. Here’s how that might look in PHP: <?php // Check to see if the user is logged in if (! https://www.olark.com/api/system_hide_minimize_button/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hide_minimize_button/ Normally the chatbox shows an icon in the top right corner that, when clicked, allows the user to minimize it. This configuration option allows you to remove that button so that, once the chatbox has been expanded, the user can not manually minimize it. However, the chatbox can still be minimized and expanded with api calls. https://www.olark.com/api/box_inline/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/box_inline/ Instead of having the Olark chat window fixed to the bottom corner of your page, Olark will instead search your page for an element with the ID olark-box-container and load the chatbox there instead. For example, you might have a <div> in your sidebar that displays the chatbox. <div id="olark-box-container"></div> You can find our complete instructions to embed the Olark widget on your website here This rudimentary example shows the chatbox inside a wrapper, with a header. https://www.olark.com/api/api_box_shrink/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_box_shrink/ Minimizes the chatbox. Opposite of api.box.expand. Click-to-minimize button If you have your own click to chat button, you might also want to make click to minimize button: <a href="javascript:void(0);" onclick="olark('api.box.shrink')"> Minimize chat </a> https://www.olark.com/api/welcomeassist_notify_op_of_new_visitor/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/welcomeassist_notify_op_of_new_visitor/ If the Greeter function is enabled, you can use this call to enable/disable the advanced notification per page. You can also enable this on the Greeter extension page. https://www.olark.com/api/calloutbubble_offline_bubble_image_url/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/calloutbubble_offline_bubble_image_url/ Sets the Attention Grabber image while all your operators are set to away or offline. Like the other Attention Grabber calls, this works on a page by page basis. You can choose an offline Attention Grabber for use across the entire site in the Attention Grabber settings This call would be useful if you wanted a different image on a particular page, such as the contact page, or if you only wanted the Attention Grabber to appear on one page. https://www.olark.com/api/api_chat_onofflinemessagetooperator/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_onofflinemessagetooperator/ When an offline message is sent to the operator, this will call the given callback with an event object Track visitors who send you an offline message Use your favorite analytics software to keep track of visitors who have sent an offline message to an operator (since they might be more valuable): <script> olark('api.chat.onOfflineMessageToOperator', function(event) { // Example code yourAnalytics.track("sent_an_offline_message"); }); </script> Or, you could send a message back explaining that no-one is around, and point the visitor to your help center https://www.olark.com/api/api_box_onexpand/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_box_onexpand/ Whenever the chatbox is expanded, the given callback function will be triggered. Watch for visitors clicking the chatbox A visitor to your site might expand the chatbox, but not initiate a conversation. You can check to see if a conversation has started and if not, send the visitor a message after 3 seconds. <script> // Triggers when the chat box has been expanded olark('api.box.onExpand', function() { // Use getDetails to grab visitor information olark('api. https://www.olark.com/api/api_box_onhide/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_box_onhide/ Whenever the chatbox is hidden, the given callback function will be triggered. Notify an operator when a visitor closes the chat box You can notify your operator that the visitor has closed the chatbox if you have already started chatting: <script> // Checks to see if the coversation has started olark('api.chat.onBeginConversation', function(){ // Triggers when the chat box has been hidden olark('api.box.onHide', function() { // Notifies the operator. The visitor does not see this. https://www.olark.com/api/api_chat_onready/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_onready/ Use this API call to detect when the Olark chatbox has loaded. You can create your own callback function once the onReady event fires. For example, you would use onReady if you need to manipulate elements on your page only when you know for sure that Olark has loaded. You might be doing an A/B test for live chat, and want to send an event to your analytics when Olark has loaded on a page. https://www.olark.com/api/api_box_onshrink/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_box_onshrink/ Whenever the chatbox becomes minimized, the given callback function will be triggered. Track when visitors minimize your Olark widget If you are trying to track when visitors shrink the Olark widget, to perhaps track via analytics the efficacy of different auto-messaging rules, you can use this following example to do so. <script> olark('api.box.onShrink', function(event) { // Example code yourAnalytics.track("visitor_minimized_olark"); }); </script> Notify an operator when a visitor minimizes the chat box You can notify your operator that the visitor has minimized the widget if you have already started chatting: https://www.olark.com/api/api_box_onshow/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_box_onshow/ Whenever the chatbox is shown (unhidden), the given callback function will be triggered. Update visitor status when chat box visible If you have chosen to have your chatbox hidden by default, you can indicate in your buddy list that a visitor can now see the chatbox. This means they might be about to send a message: olark('api.box.onShow', function() { olark('api.chat.updateVisitorNickname', { snippet: "is visible" }); }); https://www.olark.com/api/api_chat_onbeginconversation/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_onbeginconversation/ Whenever a visitor or operator sends the first message, the given callback function will be triggered. Show premium users in visitor list Olark already sends some nice information to the operator when the chat first begins, but you can send your own information too. Here’s how you might highlight that a visitor to your site is a premium customer: <script> // Triggers when the first message has been sent // Including automated messages from the Greeter or Targeted Chat rules olark('api. https://www.olark.com/api/api_chat_onmessagetooperator/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_onmessagetooperator/ Whenever a message is sent to the operator, this will call the given callback with an event object. Track messages to operators Use your favorite analytics system to keep track of visitors who have sent a message to an operator (since they might be more valuable): <script> olark('api.chat.onMessageToOperator', function(event) { yourAnalytics.track("chatted_with_operator"); }); </script> Track positive reactions Maybe you want to keep track of positive vs. negative reactions. You could watch when people send you smileys, indicating that they are happy: https://www.olark.com/api/api_chat_onmessagetovisitor/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_onmessagetovisitor/ Whenever a message is sent to the visitor, this will call the given callback with an event object. Track operator response times Use your favorite analytics system to keep track of how long it takes an operator to respond to a visitor: <script> olark('api.chat.onMessageToOperator', function(event) { // Get the timestamp for when the visitor sends a message var visitorSentAt = +new Date; olark('api.chat.onMessageToVisitor', function(event) { // Get the timestamp for when the operator sends a message var operatorSentAt = +new Date; // Calculate the difference between the two times and track the event // Check your anayltics software API to see how to push an event yourAnalytics. https://www.olark.com/api/api_chat_oncommandfromoperator/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_oncommandfromoperator/ Whenever a command is sent from the visitor, e.g. !track this is a lead, this will call the given callback with an event object. Commands must begin with an exclamation point ! and come at the start of a message. You can also see a list of the default operator commands in our help section. To see these while chatting, type !help into a chat at any time to see the list of commands you can perform. https://www.olark.com/api/api_chat_onoperatorsavailable/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_onoperatorsavailable/ Whenever any operator comes online, the given callback will be triggered. Indicate you have operators available Show a green icon whenever you have operators available to chat, or a red one when you are away: <!-- HTML element to show chatbox status --> <div id="chat-indicator">Live chat</div> <style type="text/css"> /* Operators available */ .green-icon { background-color: green; } /* Operators offline */ .red-icon { background-color: red; } </style> <script> olark('api.chat.onOperatorsAvailable', function() { // Identify the element, and give it a class name document. https://www.olark.com/api/api_chat_onoperatorsaway/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_onoperatorsaway/ Whenever all operators are offline, the given callback will be triggered. Indicate your operators are offline Show a red icon whenever you have operators available to chat: <!-- HTML element to show chatbox status --> <div id="chat-indicator">Live chat</div> <style type="text/css"> /* Operators available */ .green-icon { background-color: green; } /* Operators offline */ .red-icon { background-color: red; } </style> <script> olark('api.chat.onOperatorsAvailable', function() { // Identify the element, and give it a class name document. https://www.olark.com/api/calloutbubble_bubble_image_url/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/calloutbubble_bubble_image_url/ Sets the Attention Grabber image while your operators are set to available. Like the other Attention Grabber calls, this works on a page by page basis. You can choose an online Attention Grabber for use across the entire site in the Attention Grabber settings This call would be useful if you wanted a different image on a particular page, such as the contact page, or if you only wanted the Attention Grabber to appear on one page. https://www.olark.com/api/system_give_location_to_operator/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_give_location_to_operator/ Gives notifications about what page the visitor is on. By default, each time a visitor navigates to a new URL while on your site, this will be sent as a notification to your operator. Set to false to disable this behavior. https://www.olark.com/api/system_disable_default_visitor_information/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_disable_default_visitor_information/ This will turn off all of the initial pre-chat notifications that give you visitor context - including location, current URL and number of previous conversations - allowing you to show just your own custom pre-chat information instead. https://www.olark.com/api/system_chat_does_not_follow_external_links/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_chat_does_not_follow_external_links/ If you have a link in your chatbox that goes to a non-local URL, for example a page on another domain, Olark will by default wrap the new page. This means that the chatbox will still appear on the new page, even if it’s not your website. However, increasingly websites are not allowing cross-domain access, meaning that the wrapped content may not work correctly. You can choose to disable this wrapping behavior by setting this API call to true. https://www.olark.com/api/system_require_email/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_require_email/ Require visitors fill out their email address in the pre-chat survey before chatting. This requires the pre-chat survey to be enabled first. This setting can also be enabled on the pre-chat survey section of the Text & Forms settings page. You can read more about using the pre-chat survey in our Help Center. Even if the pre-chat survey is enabled in your settings, you would need to enable the plugin using this line to use the system. https://www.olark.com/api/system_require_name/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_require_name/ Require visitors fill out their name in the pre-chat survey before chatting. This requires the pre-chat survey to be enabled first. This setting can also be enabled on the pre-chat survey section of the Text & Forms settings page. You can read more about using the pre-chat survey in our Help Center. Even if the pre-chat survey is enabled in your settings, you would need to enable the plugin using this line to use the system. https://www.olark.com/api/system_require_phone/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_require_phone/ Require visitors fill out their phone number in the pre-chat survey before chatting. This requires the pre-chat survey to be enabled first. This setting can also be enabled on the pre-chat survey section of the Text & Forms settings page. You can read more about using the pre-chat survey in our Help Center. Even if the pre-chat survey is enabled in your settings, you would need to enable the plugin using this line to use the system. https://www.olark.com/api/api_chat_sendmessagetovisitor/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_sendmessagetovisitor/ Send a message to the visitor. It will appear as if the message came from an operator. Trigger an automated message Send a welcome message whenever a visitor clicks on a help me button: <!-- HTML button --> <a id="help-me" href="#">Live chat help</a> <script> document.getElementById('help-me').onclick = function() { olark('api.chat.sendMessageToVisitor', { body: "Let me know if you have any questions." }); // Stops the link reloading the page return false; } </script> https://www.olark.com/api/api_chat_sendnotificationtooperator/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_sendnotificationtooperator/ Send a notification message to the operator. The operator will see [info] to indicate that this message was not sent from the visitor. Notify operator on landing pages You can send your operator a notification when the visitor lands on a particular page, such as a landing page: <script> // Checks if the current URL contains 'landing' if (document.location.href.indexOf('landing') != -1) { olark('api.chat.sendNotificationToOperator', { // Send a custom notification body: 'visitor landed on the billing page' }); } </script> Notify operators on landing pages after one minute Perhaps you want to notify an operator when a visitor is hesitating on a page for more than 60 seconds, so you can choose to initiate a chat with them: https://www.olark.com/api/api_chat_sendnotificationtovisitor/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_sendnotificationtovisitor/ Send a notification message to the visitor. The message will look like a notification, and will not show up as coming from a particular operator. Notify a visitor if no immediate response Assure a visitor that the operator will be back later if there is no response from an operator in 60 seconds: <script> // Set a timer variable var lastMessageTimeout; // Wait for a message to the visitor olark('api.chat.onMessageToVisitor', function(){ // If a message is sent, reset the timer clearTimeout(lastMessageTimeout); // Start the timer lastMessageTimeout = setTimeout(function(){ // Send a custom notification to the visitor olark('api. https://www.olark.com/api/system_hb_dark_theme/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hb_dark_theme/ Choose a light or dark theme for the chatbox. This can also be changed site wide from the Theme Settings Page. You can enable a dark theme on a specific page. You can also do this for your entire site from the Theme Settings Page. https://www.olark.com/api/system_google_analytics_id/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_google_analytics_id/ Set the Google Analytics ID for your account on a specific page. For example, you might have separate domains using the same Olark account, but different Google Analytics IDs. <?php // Get the current domain $host = $_SERVER['HTTP_HOST']; if ($host == "example.com") { olark.configure('system.google_analytics_id', 'YOUR-GA-ID' ); } elseif ($host == "test.org") { olark.configure('system.google_analytics_id', 'OTHER-GA-ID' ); } ?> Check out our related help guide for this here. You can also view advanced troubleshooting help for Google Analytics + Olark here. https://www.olark.com/api/welcomeassist_welcome_delay_in_seconds/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/welcomeassist_welcome_delay_in_seconds/ Set the time after which the Greeter message will be sent to first-time visitors on your site. You can also enable this on the Greeter extension page. https://www.olark.com/api/welcomeassist_welcome_messages/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/welcomeassist_welcome_messages/ Set the welcome messages to send to the visitors when the Greeter function activates. If you have more than 1 message enabled in the call, we will choose a random one to send to the visitor when they meet the greeter criteria. You can also enable this on the Greeter extension page. https://www.olark.com/api/system_group/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_group/ Set the group before the chatbox loads. You can get the ID for each group by clicking on it from the Operator settings page. This differs from the setOperatorGroup API call in that it can only be done before the chatbox loads. To set the operator group after the chatbox has loaded, use setOperatorGroup instead. https://www.olark.com/api/system_hb_primary_color/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hb_primary_color/ Set the primary color of the chatbox. This can also be changed site wide from the Theme Settings Page. This configure call will only accept a hex string. For example olark.configure('system.hb_primary_color', '#744da8'); https://www.olark.com/api/system_hb_show_as_tab/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hb_show_as_tab/ Show the chatbox as a tab. This can also be changed site wide from the Theme Settings Page. https://www.olark.com/api/system_hb_show_button_text/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_hb_show_button_text/ Show the button text on the chatbox icon. This can also be changed site wide from the Theme Settings Page. https://www.olark.com/api/api_box_show/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_box_show/ Shows the chatbox. Showing the chatbox will make it appear on the page. This will override settings such as Invisible Olark. Should you wish to show the widget on specific pages, you can also create these rules using our Targeted Chat tool, instead of updating the code on your page. Show the chatbox on error If a visitor runs into an error, you might want to make sure that the chatbox is displayed: https://www.olark.com/api/system_is_single_page_application/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/system_is_single_page_application/ Olark uses polling to check your visitor’s status while on your site. Visitors who leave your site, or have been idle for a long time without changing page, will eventually stop sending polling requests. If you have a single page application where the visitor does not change pages, they may incorrectly be detected as being idle. You can prevent this by setting is_single_page_application to true. https://www.olark.com/api/box_start_hidden/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/box_start_hidden/ Suppose you usually show the chatbox, but wish to hide it on specific pages. You can do so using the following Javascript API function. You can enable this option on your Setup page as Hide the chatbox by default. The api.box.hide function is useful for when the chatbox has already loaded on a site and you wish to hide it again. For example, when the visitor clicks a particular button. https://www.olark.com/api/welcomeassist.welcome_new_visitors/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/welcomeassist.welcome_new_visitors/ Use this call to switch the Greeter on. You can then use the calls below to control how the Greeter behaves. You can also enable this on the Greeter extension page. https://www.olark.com/api/api_visitor_updatecustomfields/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_visitor_updatecustomfields/ If you have custom data that you want to keep track of for a visitor, such as an internal customer ID or some internal data, you can give it to Olark using this API. Note: Custom fields are not sent automatically to CRM integrations. Custom fields will, however, be sent with Webhooks by default. Once set up, Custom fields are sent to the CRM only, they do not appear in the chat console. https://www.olark.com/api/api_visitor_updateemailaddress/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_visitor_updateemailaddress/ Keep track of an email address for this visitor, to link it with your CRM cases and display in the visitor list. Update the visitor’s email address You can grab information from your registered users and send it to Olark. <script> olark('api.visitor.updateEmailAddress', { emailAddress: 'johndoe@olark.com' }); </script> https://www.olark.com/api/api_visitor_updatefullname/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_visitor_updatefullname/ Keep track of a full name for this visitor, to link it with your CRM cases and display in the buddy list. Update the visitor’s name You can grab information from your registered users and send it to Olark. <script> olark('api.visitor.updateFullName', { fullName: 'John Doe' }); </script> For example, if you were using PHP and pulled the visitor’s name from your own database, you might write: <script> olark('api.visitor.updateFullName', { fullName: '<? https://www.olark.com/api/api_chat_updatevisitornickname/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_updatevisitornickname/ Important Note: updateVisitorNickname is best used to display visitor information other than name and email in the buddy list. To display a name and/or email in the buddy list use api.visitor.updateFullName and api.visitor.updateEmailAddress respectively. Add information to the visitor’s nickname in the operator’s buddy list. You can only set a ‘snippet’ of the nickname, since other extensions may be trying to update the nickname at the same time. https://www.olark.com/api/api_visitor_updatephonenumber/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_visitor_updatephonenumber/ Keep track of a phone number for this visitor, to link it with your transcripts and display in the visitor list. Update a visitor’s phone number You can grab information from your registered users and send it to Olark. <script> olark('api.visitor.updatePhoneNumber', { phoneNumber: '(123) 456-7890' }); </script> https://www.olark.com/api/api_chat_updatevisitorstatus/ Mon, 01 Jan 0001 00:00:00 +0000 https://www.olark.com/api/api_chat_updatevisitorstatus/ Add information to the visitor’s status in the operator’s buddy list. You can only set a ‘snippet’ of the status, since other extensions may be trying to update the status at the same time. Display number of items in a shopping cart To show custom information, like the number of items somebody has in their shopping cart: <script> olark('api.chat.updateVisitorStatus', { snippet: 'has 10 items in cart' }); </script> Do you have multiple pieces of information?