Not everyone your module serves works for the company. Customers want to see their project, applicants want to apply, a client wants to sign a quote. The platform gives you three ways to let them in without a full workspace account, from "sign in to your portal" to "click this link and sign".
| Way in | Who it's for | Sign-in? |
|---|---|---|
| Portal account | Repeat visitors: clients, dealers, employees checking their own records | Yes, their own password |
| Public page | Anyone: a careers page, a request form | No (or optional) |
| Signing link | One person, one record: a quote, an agreement, a change order | No |
Portal accounts and invites
A portal account is a real sign-in for an outside person, with a role that holds only your module's permissions. Your module decides who gets one; the platform owns the login, the password and the invite.
- Your module sets up its portal role, such as Client Portal, made of your permissions only.
- It sends the person an invite link. Your own public page can welcome them, or the platform's standard invite page.
- They open the link, choose a password, and land in your portal with just that role.
A new invite replaces the old one, and your module can withdraw invites at any time. Module code never sees or sets a password.
Public pages
A public page is a page of your module served on its own web address, with no workspace session: a careers page, a contact form, a status page.
- Each page gets a link made of a random code, unique to the workspace.
- A Workspace Admin sees every public page in your module's Module Settings, on the Preferences tab under Public pages: Copy link, Embed code for their website, Turn off, and New link if an old link should stop working. It also counts visits.
- The page is public, the data isn't. Anything the page loads still goes through your module's normal permission checks. A page can also be set to need a login.
Signing links: view and sign one record, no login
Email someone outside the workspace a link to one record. They open it, read it, download the PDF and, if it's a signing link, sign right on it: drawn with a finger or mouse, or typed.
- One record, one email address, one signature. Once signed, the link keeps showing the signed copy until it expires.
- Expires in 7 days by default (30 at most).
- Record changed? Your module cancels the old links, so nobody signs an outdated version. Sending a new signing link for a record cancels the earlier ones too.
- Every view, signature and download is logged, with the time and the IP address it came from.
- You decide what's shown. Show the customer's copy (their prices, never your costs) and decide what a signature does, like marking the quote accepted.
The email itself goes out through the workspace's mailbox, with wording the workspace can edit. See Email.
Ask the Module Builder
// For developers: module.json
"ui": {
"public_pages": [
{"key": "quote_sign", "path": "sign.html", "name": "Sign a quote",
"description": "Customers view and sign one quote", "requires_login": false}
]
}Good to know
- A no-login page gets a closer look. The module check flags it so a reviewer looks at it. See Publish a module: the module check.
- Public pages and signing links are included. Portal accounts are on the platform's list of services that may be metered later.
- Workspace Admins can switch any public page off, and a signing link only works while its page is switched on.
- A portal role holds only your module's permissions, so a portal user can never wander into the rest of the workspace. See Users, roles and permissions in your module.