Tiledesk Docs
Search…
Widget
External Chatbot
Tutorials
Dashboard & AgentChat SDK
Installation
Configuration
Changelog
Javascript API: Listeners/Events
These event will triggers only when Tiledesk Widget fired some event in a specific situation. Once it's up, you'll be able to do something you need in the fanction handler.
1
window.Tiledesk(event_name, handler)
Copied!
Register an event handler to an event type.
Available events:
event_name
description
onLoadParams
Fired when the parameters are loaded*.
onInit
Fired when the widget is initialized
onAuthStateChanged
The event is generated when the user logs in or logs out
onOpen
Fired when the widget is open
onClose
Fired when the widget is closed
onBeforeMessageSend
Fired before the message sending.
onAfterMessageSend
This event is generated after the message has been sent.
onOpenEyeCatcher
Fired when the callout box is open
onClosedEyeCatcher
Fired when the callout box is closed
onCloseMessagePreview
Fired when the user click on close button in message preview while new message is received and widget is closed
onNewConversationComponentInit
Fired just after a new conversation is initialized
onBeforeDepartmentsFormRender
Fired just before rendering Departments in the Departments view
onMessageCreated
Fired when the widget receive a message
onNewConversation
Fired when the widget start a new conversation
onConversationUpdated
Fired when the widget receive a conversation update
*This event will be fired before the tiledesk parameters is loaded. Use this event to change at runtime your Tiledesk settings.
Initial events lifecycle:
onLoadParams -> onInit -> onAuthStateChanged
The handler will have the signature function(event_data).
Arguments:
Parameter
Type
Required
Description
event_name
String
YES
Event name to bind to
handler
Function
YES
Function with the signature function(event_data)
Important payload of event_data:
Parameter
Type
Description
detail.default_settings
Object
the constructor default settings
Ex. Logging of widget events
1
<script type="application/javascript">
2
window.Tiledesk('onBeforeMessageSend', function(event_data) {
3
var message = event_data.detail.message;
4
console.log("onBeforeMessageSend called ", message);
5
});
6
window.Tiledesk('onAfterMessageSend', function(event_data) {
7
var message = event_data.detail.message;
8
console.log("onAfterMessageSend called ", message);
9
});
10
</script>
Copied!
Ex. Widget with visitor fullname and email from localStorage
1
<script type="application/javascript">
2
//set fullname to localstorage
3
localStorage.setItem("user_fullname", "Andrea from localStorage");
4
localStorage.setItem("user_email", "[email protected]");
5
​
6
window.Tiledesk('onLoadParams', function(event_data) {
7
window.tiledeskSettings.userFullname = localStorage.getItem("user_fullname");
8
window.tiledeskSettings.userEmail = localStorage.getItem("user_email");
9
});
10
</script>
Copied!
Ex. Widget with welcome message with current date
1
<script type="application/javascript">
2
window.Tiledesk('onLoadParams', function(event_data) {
3
window.tiledeskSettings.welcomeMsg = " Hello at: " + new Date().toLocaleString();
4
});
5
</script>
Copied!
onBeforeMessageSend
This event will be fired before the message sending. Use this event to add user information or custom attributes to your chat message.
Important payload of event_data:
Parameter
Type
Description
detail.message
Object
the message that is being sent
Ex. Programmatic setting custom user metadata
1
<script type="application/javascript">
2
window.Tiledesk('onBeforeMessageSend', function(event_data) {
3
var message = event_data.detail.message;
4
message.attributes.userCompany = "Frontiere21";
5
});
6
</script>
Copied!
Ex. Add a custom attribute (page title) to the message.
1
<script type="application/javascript">
2
window.Tiledesk('onBeforeMessageSend', function(event_data) {
3
var message = event_data.detail.message;
4
message.attributes.pagetitle = document.title;
5
});
6
</script>
Copied!
onAfterMessageSend
This event is generated after the message has been sent.
Important payload of event_data:
Parameter
Type
Description
detail.message
Object
the message that was sent
Ex:
1
<script type="application/javascript">
2
window.Tiledesk('onAfterMessageSend', function(event_data) {
3
var message = event_data.detail.message;
4
console.log("onAfterMessageSend called ", message);
5
});
6
</script>
Copied!
onAuthStateChanged
This event is generated when the authentication state changed (Ex: user sign-in, user logout, etc.) Important payload of event_data:
Parameter
Type
Description
detail
Object
the auth event
Auth Event description:
Parameter
Type
Description
event
string
Possible values: 'online' when user is logged in, 'offline' when user is logged out
isLogged
boolean
Possible values: true if the user is logged, false if not logged
user_id
string
The current user identifier
global
object
An object with all the widget global parameters
default_settings
object
The initial widget config parameters (window.tiledeskSettings)
appConfigs
object
The remote widget config parameters obtained from the remote Tiledesk server
Ex. :
1
<script type="application/javascript">
2
window.Tiledesk('onAuthStateChanged', function (event_data) {
3
console.log("onAuthStateChanged ----> ", event_data.detail.event);
4
if (!event_data.detail.isLogged) {
5
console.log("NOT logged");
6
window.tiledesk.signInWithCustomToken("JWT CHANGE IT");
7
} else {
8
console.log("logged in");
9
}
10
});
11
</script>
Copied!
onBeforeDepartmentsFormRender
This event is generated before rendering the Departments selection View. Use this event if you want to filter the default Departments list based on some conditions.
Important payload of event_data:
Parameter
Type
Description
detail.departments
Object
the array of the default Departments
Ex. :
In the following example Departments are filtered based on the current widget language. Actually a Department doesn't provide a specific "language" field. In this example Department language is put in the Department description field. Attention you can modify the departments array only by reference.
1
<script type="application/javascript">
2
window.Tiledesk('onBeforeDepartmentsFormRender', function(event_data) {
3
var departments = event_data.detail.departments;
4
var lang = window.tiledesk.angularcomponent.component.g.lang;
5
if (lang && lang === 'en') {
6
var new_deps = departments.filter(function(dep) {
7
if (dep.description && dep.description.includes('English')) {
8
return dep;
9
}
10
});
11
} else {
12
var new_deps = departments.filter(function(dep) {
13
if (dep.description && dep.description.includes('French')){
14
return dep;
15
}
16
});
17
}
18
19
//modify the department array by reference
20
21
departments.length=0; //empty the array
22
console.log("new_deps",new_deps);
23
new_deps.forEach(function(d) { //populate the department array
24
departments.push(d);
25
});
26
27
});
28
</script>
Copied!
onNewConversationComponentInit
This event is generated as soon as a new conversation view is rendered. Use this event if you want to execute some actions on a Conversation start.
Important payload of event_data:
Parameter
Type
Description
detail.newConvId
Object
the id of the conversation that fired the event
Ex. :
In the following example a hidden message is sent as soon as a conversation starts. Sending a hidden message is useful to fire a bot welcome message, if one is invited in the conversation.
1
<script type="application/javascript">
2
window.Tiledesk('onNewConversationComponentInit', function(event_data) {
3
const message = 'hello';
4
const recipientId = event_data.detail.newConvId;
5
const recipientFullname = 'Owner';
6
const type = 'text';
7
const metadata = {};
8
const attributes = {test:'test attributes', subtype: 'info'};
9
window.tiledesk.sendSupportMessage(
10
message,
11
recipientId,
12
recipientFullname,
13
type,
14
metadata,
15
attributes
16
)
17
});
18
}
19
</script>
Copied!
onMessageCreated
This event is generated when the widget receive a message.
Important payload of event_data:
Parameter
Type
Description
detail
Object
the message that was received
Ex. :
1
<script type="application/javascript">
2
window.Tiledesk('onMessageCreated', function(event_data) {
3
var message = event_data.detail;
4
console.log("TRIGGER onMessageCreated -> ", message);
5
});
6
</script>
Copied!
onConversationUpdated
This event is generated when the widget receive a conversation update.
Important payload of event_data:
Parameter
Type
Description
detail
Object
the conversation that was received
Example:
1
<script type="application/javascript">
2
var now = Date.now();
3
window.Tiledesk('onConversationUpdated', function(event_data) {
4
var dateConvUpdate = event_data.detail.conversation.timestamp
5
console.log(" TRIGGER onConversationUpdated -> ", event_data.detail.conversation);
6
console.log("now-> ", now);
7
console.log("dateConvUpdate-> ", dateConvUpdate);
8
if(now < dateConvUpdate){
9
console.log(" New conversation!!!");
10
}
11
});
12
</script>
Copied!
Last modified 3mo ago