Widget / Home
Home tab and greeting
What the visitor sees on Home, the greeting texts, the news and articles at the bottom of Home, auto-open and the pinned banner.
Home tab layout
When visitors open the widget, they usually land on the Home tab. The exceptions: if they have an open conversation, the widget opens it straight away, and with “Open chat with welcome straight away” on, it opens a new conversation. From top to bottom, Home shows:
- Pinned banner, if it’s turned on and set to show on Home (see below).
- Greeting: the “Hi there 👋” title and the “How can we help?” subtitle (or your own texts).
- Working hours: “Online until …” or the outside-hours message, if “Show working hours in widget” is on.
- Away message, if an away segment is active right now.
- “Recent message”: a card with the visitor’s latest conversation, if there is one. Clicking it opens that conversation.
- “Send us a message”: the main button, which starts a new conversation.
- Latest news: one to three cards with the latest customer news (two by default). Each card has a cover (the post’s image or, without one, a megaphone icon on the accent tint), the title in up to two lines, a “News · 2 days ago” line and a chevron. Tapping a card opens the post.
- Knowledge base articles: a “Search articles” field, the popular articles as tiles or a list, and an “All articles” link. Tapping the field opens the Help tab with its search field focused; “All articles” opens the Help tab.
The last two blocks are set up in Widget BuilderWelcomeBottom of Home (see below).
Greeting texts
SettingsWidget BuilderWelcome. The texts are set separately for Russian and English: switch the editing language above the section.
welcome.title
Type: stringDefault: "Hi there 👋"
Hero title: the large title on Home.
welcome.subtitle
Type: stringDefault: "How can we help?"
Hero subtitle. If a greeting segment is active right now, its text is shown instead.
welcome.message
Type: stringDefault: —
Welcome message (optional): the second line on the “Send us a message” button and the heading at the start of a conversation (instead of “Welcome!”). For example: “We usually reply within 5 minutes”.
welcome.button_text
Type: stringDefault: "Send a message"
CTA button text: the text on the launcher button in the corner of the site. While it’s set, the launcher is a pill with an icon and the text; an empty field gives a round button. It doesn’t change the “Send us a message” button.
welcome.quick_replies
Type: { id, label }[]Default: []
Quick replies: up to 8 buttons at the start of a new conversation. A click sends the button’s text as the visitor’s message.
| Field | Type | Default | Description |
|---|---|---|---|
| welcome.title | string | "Hi there 👋" | Hero title: the large title on Home. |
| welcome.subtitle | string | "How can we help?" | Hero subtitle. If a greeting segment is active right now, its text is shown instead. |
| welcome.message | string | — | Welcome message (optional): the second line on the “Send us a message” button and the heading at the start of a conversation (instead of “Welcome!”). For example: “We usually reply within 5 minutes”. |
| welcome.button_text | string | "Send a message" | CTA button text: the text on the launcher button in the corner of the site. While it’s set, the launcher is a pill with an icon and the text; an empty field gives a round button. It doesn’t change the “Send us a message” button. |
| welcome.quick_replies | { id, label }[] | [] | Quick replies: up to 8 buttons at the start of a new conversation. A click sends the button’s text as the visitor’s message. |
Bottom of Home: news and articles
SettingsWidget BuilderWelcomeBottom of Home holds two blocks below the “Send us a message” button: news first, then knowledge base articles. Each has its own switch, and both are on by default.
welcome.home_news.enabled
Type: booleanDefault: true
Latest news: cards with the latest customer news. The block shows only if the News tab is on and at least one news post for customers is currently running. The date on a card is relative, in the widget language.
welcome.home_news.count
Type: numberDefault: 2
How many posts: the latest 1 to 3.
welcome.home_articles.enabled
Type: booleanDefault: true
Popular articles and search: the search field, the popular articles and the “All articles” link. The block shows only if the Help tab is on, the plan includes the knowledge base and there’s at least one published public article. With no articles, there’s no search field either.
welcome.home_articles.layout
Type: "tiles" | "list"Default: "tiles"
Article layout. Tiles: a two-column grid; each tile has an accent-colored icon (the article category’s own icon if the category has one, otherwise a document icon) and the title in up to two lines, never cut to one. With an odd number of tiles (say, there are fewer public articles than you picked), the last one spans the whole row. List: rows with a document icon, the title in up to two lines and a chevron, thin separators between rows and no frame around the list.
welcome.home_articles.count
Type: numberDefault: 4
How many articles: 2, 4 or 6 for tiles, 3, 4 or 5 for a list. The config accepts 2 to 6.
| Field | Type | Default | Description |
|---|---|---|---|
| welcome.home_news.enabled | boolean | true | Latest news: cards with the latest customer news. The block shows only if the News tab is on and at least one news post for customers is currently running. The date on a card is relative, in the widget language. |
| welcome.home_news.count | number | 2 | How many posts: the latest 1 to 3. |
| welcome.home_articles.enabled | boolean | true | Popular articles and search: the search field, the popular articles and the “All articles” link. The block shows only if the Help tab is on, the plan includes the knowledge base and there’s at least one published public article. With no articles, there’s no search field either. |
| welcome.home_articles.layout | "tiles" | "list" | "tiles" | Article layout. Tiles: a two-column grid; each tile has an accent-colored icon (the article category’s own icon if the category has one, otherwise a document icon) and the title in up to two lines, never cut to one. With an odd number of tiles (say, there are fewer public articles than you picked), the last one spans the whole row. List: rows with a document icon, the title in up to two lines and a chevron, thin separators between rows and no frame around the list. |
| welcome.home_articles.count | number | 4 | How many articles: 2, 4 or 6 for tiles, 3, 4 or 5 for a list. The config accepts 2 to 6. |
Popular articles are the most viewed published public ones; with equal views, the one with more 👍 comes first, then the newer one. Internal articles never make it into the block. If the News or Help tab is off in the Tabs section, the builder says under the block’s switch that it won’t show.
Auto-open
The same Welcome section controls when the widget opens by itself:
- Auto-open delay (seconds): 1–3600 seconds after the page loads, once per browser session, and only if the visitor hasn’t opened the widget themselves yet. Empty or 0 turns it off.
- Open the chat right away in a Telegram Mini App: if the site runs as a Mini App, the panel opens straight away. Links opened from Telegram chats (the in-app browser) aren’t a Mini App: the widget never opens by itself there.
- Where to open by itself: for the delay, choose Everywhere, Only in a regular browser or Only on a computer. The widget never opens by itself for search engine bots.
- What to open: a tab and, for Help and News, a section, article or post. If that tab isn’t visible, the widget opens as usual.
- Open chat with welcome straight away: clicking the launcher takes the visitor straight to a new conversation instead of Home. A ticket is created only once they send something.
Pinned banner
SettingsWidget BuilderPinned Banner: a strip right under the widget header for important, temporary messages: “Today we’re open until 17:00”, “Maintenance 19:00–20:00”.
welcome.pinned_banner.enabled
Type: booleanDefault: false
Enable pinned banner. Without text, the banner isn’t shown.
welcome.pinned_banner.text
Type: stringDefault: —
Banner text: up to 2000 characters of plain text; formatting and links aren’t supported.
welcome.pinned_banner.image_url
Type: stringDefault: —
Image URL (optional): a small icon to the left of the text (20×20).
welcome.pinned_banner.dismissable
Type: booleanDefault: true
Dismissable by visitor: a × button on the right. The dismissal is saved in the visitor’s
sessionStorage, so the banner stays hidden for the rest of the browser session and comes back in a new one. If you change the text, the banner shows again.welcome.pinned_banner.show_on
Type: ("home" | "chat" | "help" | "news")[]Default: ["home", "chat"]
Show on: the tabs the banner shows on: Home, Chat (the list of conversations), Help (the section’s first page, not inside a category or an article) and News. There’s no banner inside an open conversation. With every box cleared, the banner shows nowhere. The old
conversation value in saved configs is read as chat.| Field | Type | Default | Description |
|---|---|---|---|
| welcome.pinned_banner.enabled | boolean | false | Enable pinned banner. Without text, the banner isn’t shown. |
| welcome.pinned_banner.text | string | — | Banner text: up to 2000 characters of plain text; formatting and links aren’t supported. |
| welcome.pinned_banner.image_url | string | — | Image URL (optional): a small icon to the left of the text (20×20). |
| welcome.pinned_banner.dismissable | boolean | true | Dismissable by visitor: a × button on the right. The dismissal is saved in the visitor’s sessionStorage, so the banner stays hidden for the rest of the browser session and comes back in a new one. If you change the text, the banner shows again. |
| welcome.pinned_banner.show_on | ("home" | "chat" | "help" | "news")[] | ["home", "chat"] | Show on: the tabs the banner shows on: Home, Chat (the list of conversations), Help (the section’s first page, not inside a category or an article) and News. There’s no banner inside an open conversation. With every box cleared, the banner shows nowhere. The old conversation value in saved configs is read as chat. |
Was this page helpful?