Appearance
Settings
Settings is for the workspace as a whole: its name, the people in it, and how other systems connect to it. Some sections are only shown to owners and admins.
| Section | What it's for | Who sees it |
|---|---|---|
| Workspace | The workspace's name, and how long conversations are kept. | Everyone (owners and admins can change it) |
| Team | The people who can sign in, and invitations. | Everyone (owners and admins can invite and change roles) |
| API tokens | Keys for your own systems to use the REST API. | Owners and admins |
| Webhooks | Telling your other systems about conversations, leads and handoffs as they happen. | Owners and admins |
| Privacy | Exporting or erasing what's stored about a visitor. | Owners and admins |
| Audit log | Who changed what. | Owners and admins |
| Your account | Your own sign-in. | Everyone |
Workspace
- Workspace name: shown at the top of the sidebar.
- Keep conversations for: conversations with no messages for this many days are deleted, with their images (checked every hour). 0 keeps them for ever. In a hosted workspace, the most is 90 days; see Hosted accounts.
Click Save after changing either.
This server shows the server's public address and the versions of Wireface Chat, its face engine and the chat widget. If it warns that PUBLIC_URL isn't set, ask whoever runs the server: the install code uses that address.
Team and invitations
People lists everyone who can sign in to the workspace, with their email, when they last signed in, whether they're online, away or offline, and their role.
To invite someone:
- Click Invite someone.
- Enter their Email and choose a Role (see Roles).
- Click Create invitation.
- Click Copy the link and send it to them however you like. Wireface Chat doesn't send email itself. The link works once, for 7 days.
When they open the link, they see Join and the workspace's name. They enter Your name, Choose a password and Password again, then click Join the workspace. (Someone who already has an account on the same server just enters Your password.) After that, they sign in with their email and that password.
Open invitations lists links that haven't been used yet. The link is only shown when you make the invitation: lost it? Cancel the invitation and invite them again.
To change someone's role, choose it in the list. To take someone out of the workspace, open the ... menu next to them and click Remove from workspace: they're signed out at once. Conversations they took part in keep their name.
Roles
Each role can do everything the roles below it can.
| Role | What they can do |
|---|---|
| Owner | Everything, including managing other owners. In a hosted workspace, deleting the workspace. |
| Admin | Bots, providers, knowledge, tools, the team (except owners) and settings, including API tokens, webhooks, privacy requests and the audit log. Deleting conversations and leads. |
| Agent | Conversations: take over, reply, add notes and tags, close them. Change a lead's status. Read everything else. |
| Viewer | Read only. |
A request for a person only goes to the team when an owner, admin or agent is online or away. Viewers aren't counted.
Nobody is invited as an owner: invite them as an admin, then an owner can change their role to Owner. Admins can change everyone's role except owners'. You can't change your own role or remove yourself.
API tokens
An API token lets one of your own systems (a CRM sync, a reporting script) use the REST API. Make one token per system, so you can revoke them separately.
- Click New token.
- Give it a Name (what it's for), choose when it Expires (In 30 days, In 90 days, In a year or Never), and tick only the Scopes it needs. Each scope says what it allows.
- Click Create token, then copy it straight away: it won't be shown again.
The list shows each token's start, whether it's Active, Expired or Revoked, and when it was last used. Revoke stops it working at once.
Tokens act for the workspace, not for the person who made them: removing someone from the team doesn't revoke tokens they made.
Webhooks
A webhook sends events to an address of yours as they happen: new leads to your CRM, or handoff requests to your team chat, for example. You need a system that can receive them; the developer guide is Webhooks.
Click Add a webhook.
Enter the Endpoint URL (https), and tick the Events to send:
Event When conversation.startedA visitor started a conversation. conversation.endedA conversation was closed or timed out. message.createdA message from the visitor, the AI or your team. lead.capturedContact details were collected. handoff.requestedSomeone asked for a person. handoff.acceptedA person took over. handoff.resolvedThe conversation went back to the AI. feedback.receivedA thumbs up or down, or a rating. Click Add webhook, and copy the signing secret it shows: it won't be shown again. Your system uses it to check that deliveries really come from Wireface Chat.
Each webhook has a switch to pause it, and shows whether it's working. Send a test sends a test event. The ... menu has Edit, New signing secret and Remove.
Show deliveries lists what was sent: Delivered, Will retry, Failed or Gave up, with the response. Failed deliveries are retried for a day, and Redeliver sends one again. A webhook that keeps failing is switched off; turn it back on once the endpoint is fixed.
Privacy
Visitor data requests is for people who ask to see, or delete, what you hold about them (under GDPR and similar laws).
- Choose Find by Email or Your user id (the id your site passed when it identified the visitor).
- Enter the email address or user id and click Find.
- For each match:
- Export downloads everything about them as a JSON file: their details, every conversation with its transcript, and their leads.
- Erase deletes their conversations (with images), leads and visitor record for good. Click Erase everything to confirm.
Each bot keeps its own visitors, so one person may show up more than once, and may be found by one identifier but not the other. Erasures are recorded in the audit log. More detail: Privacy.
Audit log
The Audit log lists who changed what, newest first: bots, providers, tools, knowledge, webhooks, the team, tokens and visitor data. Each entry shows who did it (a person, an API token or the server), what they did, what it was done to (by its id), when, and from which IP address. Some entries have details. Load older entries goes further back.
The log records that something changed, never the contents.
Your account
With an email and password, change your password here: enter your Current password, a New password (at least 10 characters) and New password again, then click Change password.
If you sign in with a wireface.dev account, there's no password here. Your wireface.dev account opens wireface.dev, where your name and mobile number are kept.
In a hosted workspace, the owner can also delete the workspace here. See Deleting your workspace.
You can also reach this section from your menu, with Account settings.