Customize Automated Chat Invitations with the Deployment APIs

Customize automated chat invitations that appear to customers on your website.

The legacy chat product is scheduled for retirement on February 14, 2026, and is in maintenance mode until then. During this phase, you can continue to use chat, but we no longer recommend that you implement new chat channels. To avoid service interruptions to your customers, migrate to Messaging for In-App and Web before that date. Messaging offers many of the chat features that you love plus asynchronous conversations that can be picked back up at any time. Learn about chat retirement in Help.

Important

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.