Chat Parameters

The chat window can be initialized with a set of parameters.
All parameters are optional and some have a default value.

Parameters

locale

Type:String: Overrides the session language. The new language is stored in the session for future reference once the chat is loaded. When there is no locale provided and no value is in the session then the Default Language set in the Appearance Settings will be taken as default.

Accepted values: 'de', 'fr', 'it', 'en'

Default: Default Language set in General Settings

https://chat.guuru.com/<YOUR_APP_ID>?locale=de

referer

Type:String: Page where the chat was triggered including the domain. This value is used to collect insights about the usage of the chat.

https://chat.guuru.com/<YOUR_APP_ID>?referer=https://foobar.baz/foo-page

Default: null

refererPath

Type:String: Page path where the chat was triggered excluding the domain. This value is used to collect insights about the usage of the chat.

https://chat.guuru.com/<YOUR_APP_ID>?refererPath=/foo-page

Default: null

refererType

Type:String: Page type identifier where the chat was triggered. This value is used to collect insights about the usage of the chat. Examples include "Homepage", "Product" and "Checkout".

https://chat.guuru.com/<YOUR_APP_ID>?refererType=Checkout

Default: 'page'

refererTrigger

Type:String: Device type or page element that triggered the chat. This value is used to collect insights about the usage of the chat. Examples include broader groups such as "iOS app", "Android App", "Desktop", "Mobile" or more refined groups such as "footer", "main nav" or "bot flow".

https://chat.guuru.com/<YOUR_APP_ID>?refererTrigger=Mobile App

Default: null

customMeta

Type:{key<String>:value<String>}: Preload the chat request with relevant information. Typically used to transfer information from one context to the chat request.

https://chat.guuru.com/<YOUR_APP_ID>?customMeta={"pre check":"ok","step":"2"}

Default: null

".", "#", "$", "/", "[", or "]" characters are not supported in the key

utm_campaign, utm_source, utm_medium, utm_content, utm_term

Type:String: If any utm tracking parameter is present it will be saved as additonal information. Examples include relate the origin of the chat with some newsletter campaign.

https://chat.guuru.com/<YOUR_APP_ID>?utm_campaign=March19&utm_source=newsletter&utm_medium=email&utm_content=talk-with-a-guuru-customer

Default: null

payloadQuestion, payloadName, payloadEmail

Type:String: Preload the chat request with the question, name and/or email. The chat request is immediately created if:

  • All three parameters are present
  • Only payload question is present and the name and email are not required

If some of the required attributes is defined but not the others (e.g. name but not question) the user will only be asked to type the missing attributes (e.g. question).

https://chat.guuru.com/<YOUR_APP_ID>?payloadQuestion=Hello can you recommend me a new camera%3F&payloadName=John Doe&payloadEmail=john.doe@mail.com

Default: null

Don't forget to encode special caracters that may be present in the parameter values

customer

Type:{key<String>:value<String>}: Customer related information. Used when a customer is loggedin. The information will be available to agents only.

https://chat.guuru.com/<YOUR_APP_ID>?customer={"id":"EXT_0123456789","Preferred Language": "German"}

Default: null

Don't forget to encode special caracters that may be present in the parameter values

← Getting startedGetting Started →