Live Agent Developer's Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Spring '14 (API version 30.0)
About This Guide
Prerequisites
API Versions
Create Deployments
setCustomVariable
rejectChat
addButtonEventHandler
Automated Chat Invitation Code Sample
Deployment API Code Sample
Newer Version Available
Customize Automated Chat Invitations with the Deployment APIs
Customize automated chat invitations that appear to customers on your
website.
Use the following deployment methods to customize your automated chat invitations.
-
setCustomVariable
Use the setCustomVariable method to create customized criteria in your sending rules that must be met in order for your automated invitation to be sent to customers. -
rejectChat
Use the rejectChat method to reject and retract an invitation that’s been sent to a customer. -
addButtonEventHandler
Use the addButtonEventHandler method to define an automated invitation’s behavior when certain events occur. -
Automated Chat Invitation Code Sample
Test and preview how automated chat invitations can work on your website using this code sample.