Publish an agent

​

Before you start

• Who can publish. You need to be a workspace admin or owner and have Full access to the agent. You also need edit access to everything you let the agent read. Built-in agents can’t be published.
• Who pays. Every conversation runs on your workspace’s AI credits. Usage limits keep this predictable, and the defaults are deliberately conservative.
• It starts switched off. A new publication can only answer questions — from sources you choose — and create tickets, and it does nothing until you turn it on.

​

Put a chat bubble on your website

1. Open the agent’s chat and click the Settings icon in the header.
2. Expand Websites and apps (external users) and click Publish agent.
3. Under Who can chat, keep Anyone on your website turned on.
4. Choose What it can read. Pick Only what you choose and add the spaces, projects, boards or pages the agent should answer from — the help docs or FAQs you’d want a customer to see. Until you add something, the agent has nothing to answer from.
5. Under Websites it can appear on, add your website’s address, such as https://www.example.com.
6. Turn on Active.
7. Click Save changes at the top of the settings panel.
8. Under Install chat bubble, click Copy embed code, and paste it into your site’s HTML just before </body>.

<script
  src="https://assets.superthread.com/agent-bubble/0.1.7/agent-bubble.js"
  data-api-origin="https://api.superthread.com"
  data-publication="apub_…"
  defer
></script>

​

Customise the bubble

​

If your site has a Content Security Policy

​

Choose what visitors can read and do

• Only what you choose – just the spaces, projects, boards and pages you list. This is the safe choice for a public website.
• Everything this agent can read – everything the agent has access to, including anything it’s given later. Superthread asks you to confirm before allowing this for anonymous visitors.

• who it’s for — anyone on your website, people signed in to your app, or both,
• Visitor confirms first – the visitor approves that exact action before it runs,
• Your team approves first – someone with access to the agent approves it before it runs. Default requires approval whenever an anonymous visitor’s chat would change something, except creating a ticket,
• Allowed targets – for actions that change things, where they’re allowed to make changes.

​

Hand over to your team

• Your replies reach the visitor. Comments on that card appear in the visitor’s chat, labelled as coming from your team.
• Internal notes stay private. Tick Internal in the comment box to keep a comment between your team.
• Status updates – for each list on the form’s board, you can write a message the visitor sees when the card moves there. Moves to lists without a message stay private. Turn on Resolves for the lists that mean “done”: reaching one ends the handover.
• After your team replies – choose whether the Agent pauses until the card is resolved (the default), or the Agent keeps answering alongside your team.

​

Signed-in users in your app

1. In Developer settings, under Apps, click Register app. Choose how Customers are created — One customer per person, or One customer per account if your users belong to companies. This can’t be changed later.
2. Copy the signing secret. It’s shown once. Keep it on your server only — never put it in a website, app or chat.
3. Link the app to this publication, and turn on People signed in to your app under Who can chat.
4. On your server, after checking your own login, sign a short-lived token for the user and pass it to the bubble.

<script>
  function startSupportChat() {
    SuperthreadAgentBubble.mount({
      signIn: {
        appId: 'aapp_…',
        personKey: `${currentUser.id}@${currentUser.accountId}`,
        // Called on sign-in and every renewal. Each token is single use.
        getAssertion: async () => {
          const res = await fetch('/api/agent/identity-assertion', { method: 'POST', credentials: 'same-origin' });
          if (!res.ok) throw new Error('Not signed in');
          return res.text();
        },
      },
    });
  }
  window.SuperthreadAgentBubble
    ? startSupportChat()
    : window.addEventListener('superthread-agent-bubble:ready', startSupportChat, { once: true });
</script>

​

Keys

• Rotate key creates a new secret and lets the old one keep working For 1 hour, For 24 hours or For 7 days while your server switches over — or Stop now.
• Revoke key and Revoke app take effect immediately and end every conversation they signed in, for every agent the app is linked to.

​

What visitors see

• the agent’s replies are labelled AI, and your team’s are labelled as human,
• they can rate answers as helpful or not,
• they confirm or reject actions that need their confirmation,
• they’re told when an action is waiting for your team’s approval.

​

Review conversations

• Conversations – every chat, filterable by date, audience, handover, rating, ticket and denied actions. Each shows the full transcript, the actions taken, and what it cost.
• Approvals – actions waiting for your team to approve.
• Blocks – conversations, people and networks you’ve blocked from chatting.
• Metrics

​

Privacy and data

• Privacy notice link and Notice text – what visitors see before their first message. Leave the text empty to use the default AI notice.
• Show staff names on replies – otherwise your team’s replies appear as “Support team”.
• Show list names instead of status messages
• Links it can share – limit clickable links in replies to certain domains.
• How long chats are kept – website visitors up to 90 days, signed-in people up to 365 days, counted from the last message. Cards and customer records the conversation created are kept, as they’re part of your workspace.

​

Usage limits

​

Turn it off or delete it

​

Troubleshooting

• The bubble doesn’t appear. Check that Active is on, that the page’s exact address is listed under Websites it can appear on, and that your Content Security Policy allows the bubble.
• The agent says it doesn’t know anything. Check What it can read — with Only what you choose and nothing added, it has nothing to answer from.
• The agent never hands over. Choose a Ticket form under Handing over to your team.
• A visitor lost the conversation. Add data-persistence="sessionStorage" to the embed code.

​

Related

• Agents – creating and configuring custom agents
• Customers – where signed-in visitors and their requests are recorded
• Forms – the forms used for handover tickets
• AI credits – how agent usage is charged