docs(website-chat): document credential requests in the embeddable chat

Open Beginner friendly
  • Is something wrong?
#133 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
documentation

Research direction

Find the website chat documentation and the existing hosted credential link page, then read how channel delivery is described. Document the chat flow, its member-only access, configuration, card states, expiry, cancellation, rate limit, and conversation continuation without exposing internal routes or token details. Done when readers can distinguish website chat from channel delivery and understand how to use and configure the feature.

Written by the indexing model from the issue text.

Description

ai-handle

Context

nextlevelbuilder/dewee#2233 adds an optional, off-by-default capability to the public website chat: when an agent needs a credential (for example an API key for a connected tool), a signed-in workspace member chatting on the site sees a credential request card instead of a plain text reply.

What to document

  • The capability is off by default. A self-hosted operator turns it on for the gateway, and the agent must have credential requests enabled.
  • Only a visitor whose chat identity is verified as a workspace member can act on the card. Anonymous visitors never get credential administration.
  • The card never shows the secret. Choosing Open secure form opens a first-party hosted form in a new tab; the secret is typed there, not into the chat.
  • A request expires after one hour and can be cancelled from the card.
  • After the credential is saved, the original conversation continues once from where it stopped.
  • Reloading the page restores the card's current state (pending, completed, expired, cancelled).
  • Opening the secure form is rate limited per visitor.

Notes

  • Keep the page free of internal routes, hostnames, tenant data and token formats.
  • Link the existing hosted credential link page for channel delivery and explain that website chat uses its own, member-only flow.

Refs nextlevelbuilder/dewee#2233

Dominant language
TypeScript
Stars
2
Forks
2
Avg merge
1d 15h
Merged PRs (30d)
63

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nextlevelbuilder/dewee-web-v2

All issues in nextlevelbuilder/dewee-web-v2

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.