customer-agent/docs/webmaster-guide.md

Webmaster guide (plain English)

This guide is for the person who runs the website — not necessarily a developer.

Big idea

Synderesis hosts the AI. You only put a small script on your site, plus a public site key.

Visitor on your site
        │
        ▼
  Chat bubble (embed)
        │  public site key only
        ▼
  Synderesis cloud
        │  answers from YOUR FAQ
        ▼
  Optional: leave a message for you

Site key vs API key

Kind	Looks like	Goes on website?	Who uses it
Public site key	pk_live_…	Yes	Chat bubble for visitors
API key	syn_…	Never	Developers / Chrome extension / backend tools

If someone asks you for an “API key” for the chat widget, give them the site key instead.

Recommended setup order

1. Write a one-page FAQ in a text editor (or use templates/sample-faq.txt)
2. Create the agent in admin and paste the FAQ
3. Test on /customer-agent/test/?key=…
4. Install on a staging page first
5. Install on the live site
6. Change Allowed origins from * to your real domain(s)

Writing a good FAQ

Do

• Short paragraphs
• Real hours, prices, shipping times
• “We don’t …” rules if needed
• Contact email for hard cases

Don’t

• Paste entire PDF books
• Contradictory policies
• Private personal data

The agent is instructed not to invent policies. If the FAQ is empty or vague, it will say it does not know and offer human handoff.

Branding

The default bubble matches Synderesis colours (blue / gold). Optional embed attributes (advanced): see settings-reference.md.

Escalations

When a visitor leaves a message, it is stored for your account. Open admin → select agent → Recent escalations.

Outbound email to your inbox is planned; v1 records the handoff in the product.

Privacy notes for your privacy policy

You should mention:

• A chat assistant may process messages to answer support questions
• Messages may be stored briefly for quality / handoff
• Link to Synderesis privacy materials where appropriate

You remain the controller of your customer relationships.

WordPress

See the plugin under integrations/wordpress/synderesis-customer-agent/. Settings screen: Settings → Synderesis Agent.

Shopify / Wix / Squarespace

Paste the script snippet into theme footer / custom code. See install-snippets.md.

After go-live checklist

• Allowed origins locked to your domain(s)
• Escalation email correct
• FAQ covers top 10 real questions
• Tested on mobile
• Staff know where to read escalations