Back to Dashboard

Documentation

Learn how to use Asyntai

Budibase Integration

Put your AI agent and your chat data inside your Budibase apps

Create Account

Overview

Budibase is a low-code platform for internal apps: admin panels, forms, approval flows and dashboards. Asyntai gives it two plugins.

  • Asyntai AI Chat, a component. Drop it on any screen and your team gets an AI agent that answers from your own knowledge: policies, product details, help articles, price lists.
  • Asyntai, a datasource. Build tables, forms and dashboards on your website chats: every lead the chatbot captured, the full conversation behind it, and a form that adds new knowledge to the agent.

What You Can Build

  • An internal help desk screen where staff ask the agent instead of searching documents
  • A lead inbox with the email addresses and phone numbers visitors left in the chat
  • A chat viewer: click a lead and read the whole conversation next to it
  • A knowledge form that adds a page or a note, so the agent knows it from the next answer
  • A daily report of chats per website

Requirements

  • A Budibase account with permission to add plugins (Budibase Cloud or self-hosted)
  • An Asyntai account. The chat panel and the datasource use the Starter plan or higher.
  • For the datasource: a self-hosted Budibase, because Budibase runs custom datasources on self-hosted installations

Install the Plugins

1

Open Plugins

In Budibase, open Settings, then Plugins under Organisation, and press Add plugin.

2

Add the Chat Component

Choose the source GitHub and paste https://github.com/asyntai/budibase-component-asyntai-chat. Press Save.

3

Add the Datasource

Press Add plugin again, choose GitHub and paste https://github.com/asyntai/budibase-datasource-asyntai.

Both plugins appear in the list with the type Component and Datasource. You can also download the .tar.gz file from the latest GitHub release and use the source File Upload.

Add the AI Chat to a Screen

1

Copy Your Widget ID

Sign in to Asyntai and open the Install page. Your widget ID is the value of data-asyntai-id in the snippet shown there. It starts with asyntai_.

2

Drop the Component

Open a screen in the Budibase designer, press Add component and choose Asyntai AI Chat from the Plugins group.

3

Paste the Widget ID

Paste it into Widget ID in the settings panel and choose a Display. Publish the app.

Display: Chat panel on the screen

The chat sits inside the screen, as tall as you set in Panel height. It works in every Budibase app with no extra setup.

Display: Chat button in the corner

A chat button floats in the corner of the screen, like on your website. The agent also knows who is signed in: with Tell the agent who is signed in switched on, it receives the name, email address and app role of the Budibase user, and Extra context for the agent adds your own line, such as a team or a location. The agent uses this through User Context on the Standard plan and higher.

The button loads the Asyntai script from widget.asyntai.com, so Budibase must allow that address. On a self-hosted Budibase, set these environment variables and restart Budibase:

CUSTOM_CSP_SCRIPT_SRC=https://widget.asyntai.com
CUSTOM_CSP_CONNECT_SRC=https://asyntai.com,https://widget.asyntai.com

On a Budibase plan with custom app scripts, add https://widget.asyntai.com and https://asyntai.com to the script allowlist in the app settings instead. The button shows on the screens that hold the component, and it keeps the conversation when the user moves between them.

Connect the Datasource

1

Get Your API Key

Sign in to Asyntai, open Settings, then API, and copy your API key.

2

Add the Data Source

In your app, open Data, press the + next to Sources, and choose Asyntai.

3

Paste the Key

Paste the key into API key. Leave Server address as https://asyntai.com. Budibase tests the connection and shows Connected.

4

Create a Query

Press Create new query, pick a function, and run it. Start with List leads, then bind a Table to the query.

Queries

  • Ask a question: send a question and get the agent's answer from your knowledge. Pass the same Session ID on every turn to keep the conversation.
  • List leads: email addresses and phone numbers visitors left in the chat, newest first. Filter by website, email address and date.
  • List chats: recent conversations with the first message, page and country. Filter by website, source and date.
  • Get chat transcript: every message of one chat. Pass the Session ID of a lead or a chat.
  • List websites: the websites in your account with their ID.
  • List knowledge: the pages, files and notes the agent answers from.
  • Add text to knowledge: a title and a text, for opening hours, a policy or a price list.
  • Add page to knowledge: the agent reads the page and answers from it.

Fields marked Website ID or domain take either the number from List websites or the plain domain, for example shop.example.com.

Tip: Make a Get chat transcript query with a binding named session, and set Session ID to {{ session }}. Point a table at List leads, and on row click run the transcript query with the row's session_id. Click a lead and the conversation opens.

Removing It

Remove the component from your screens and the datasource from your app, then open Settings, Plugins, and delete the two Asyntai plugins.

Plans & Pricing

The plugins are free. The chat panel and the datasource use the Starter plan or higher. View pricing.

Need Help?

If you have any questions or run into issues, contact us at [email protected].