Webchat
Webchat Notification Parameters
Basic payload
- To send a payload you need to know the webchat client sessionuuid
- You may send any combination of message and client configuration in a single payload
Sending a message
To send a message add webchat_message
to the webchat
object
webchat_agent
is optional (Default : 'Agent')
webchat_message.type
( text / markdown / html )
Sending a message with custom agent name
Add webchat_agent
to the webchat
object
webchat_agent
is optional (Default : 'Agent')
Sending a form
form_name
is used as a unique identifier
Sending client settings
To update client settings add webchat_client_configuration
to the webchat
object
Available settings :
default country code
sets the default country code for any fields requiring country specific entries
switching
Allows data entry for communication via alternative platforms
switching return
When a user selects a platform and submits their details the following payload will be sent to the stub
file upload
Allow file uploading with messages.
voice notes
Allow user to send voice notes instead of messages
Receiving payloads from webchat client via heimdall
On webchat Open
When a user opens up the chat window an event is emitted on the following Heimdall path:
stubber.systems.notifications.webchat.org.{{orguuid}}.name.{{chatname}}.webchatmessagetype.initialize
Any Stub registered on this path will receive the following payload:
The purpose of this message is to allow the stub to get the session uuid of the new user. You may also use the session uuid to send a message before the user responds.
On user message
When a user sends a message an event is emitted on the following Heimdall path:
stubber.systems.notifications.webchat.org.{{orguuid}}.name.{{chatname}}.sessionuuid.{{sessionuuid}}.webchatmessagetype.message
Any Stub registered on this path will receive the following payload:
On configuration submit
When a user submits data into a field an event is emitted on the following Heimdall path:
stubber.systems.notifications.webchat.org.{{orguuid}}.name.{{chatname}}.sessionuuid.{{sessionuuid}}.sessionuuid.{{sessionuuid}}.webchatmessagetype.configuration
Any Stub registered on this path will receive the following payload: