Docs / Set up

Add the widget

The widget is one script tag. It works on any website, whatever it's built with, and your page's own styles can't break it.

The script tag#

Copy your agent's tag from Admin → Agents → Widget code. It looks like this:

<script src="https://admitur.com/widget/widget.js"
        data-site-key="sk_your_agent_key" defer></script>

Paste it before </body> on every page where students should see the chat button. In most content management systems this goes in a footer or "custom code" setting, so you add it once for the whole site.

The widget is a single small file with no other downloads, so it doesn't slow your pages down.

Allowed websites#

The site key is public: anyone can read it in your page source. What stops someone else running your assistant on their own site is the agent's list of allowed websites. The widget only answers on pages whose address is on that list.

  • List each address in full, for example https://www.your-college.edu.my.
  • List test or staging sites too, while you're trying it out, and take them off afterwards.
  • If the chat button appears but every message fails, the page's address is usually missing from this list.

Appearance#

In Admin → Agents you can change these, and see a live preview as you go:

SettingWhat it changes
ColourThe button, the header and the student's messages.
GreetingThe short message beside the button and at the top of the chat, in each language.
PositionBottom right or bottom left.
LanguagesWhich of English, Bahasa Malaysia and Chinese the agent offers.
ContactThe office the assistant points students to when it can't help.
ScopeWhat the agent is for, in a sentence, such as undergraduate admissions.

The widget follows the student's light or dark setting, and opens full screen on a phone.

What students see#

  • A button with a short greeting. Opening it shows suggested questions.
  • Answers with their source underneath, so a student can check where a figure came from.
  • Talk to a person, always available. It opens a case, and the case reference and the team handling it appear at the top of the chat. Your officers' replies arrive in the same chat.
  • New chat, which clears the conversation. The conversation is kept in the student's own browser, not in a cookie.

Pausing and changing keys#

Pause stops the agent answering on your site straight away, for example while a fee change is being approved. Resume brings it back.

Rotate site key issues a new key. The old one keeps working for 24 hours, so you have time to update the tag on your pages.

Limits#

To protect your account from abuse, each visitor can send a limited number of messages a minute and a day, and each institution has a daily total. The widget explains a limit in the student's language. Talk to a person is never blocked by the daily limit, so a student can always reach your staff.

More than one agent#

You can run separate agents, for example one for undergraduate admissions and one for postgraduate study, each with its own key, look, scope and allowed websites. The number of agents depends on your plan.

Can't find what you need? Email [email protected] and we'll answer, and add it here.