Email Invite (Magic Links)
With Magic Links, your private project can only be accessed by those whom you invite.
How do Magic Links work?
The process is as follows:
- You invite a reader by providing their e-mail address and when their access should expire (or never).
- We send them an e-mail containing a link that allows them access to the docs for the validity of their access. Once they use the link, it can no longer be used again.
- If they need another link, they can always go to the docs site and request a new magic link.
How to Enable Email Invite?
- From the sidebar, choose Project Settings
. - Under General Settings, choose Make Private (or Manage Access).
- Select Email Invite.
- Hit Save.
How to Invite Readers?
To invite readers:
- First, ensure that the project is protected by Email Invite.
- From the sidebar, choose Project Settings
. - Under General Settings, click the button
next to Manage Access. - Input the reader's e-mail address and expiry, if any.
- Click Grant Access.
Once you click on Grant Access, an email message will be sent to the specified email address, containing a magic link that will grant you access.
How to Revoke Reader Access?
To revoke reader access:
- From the sidebar, choose Project Settings
. - Under General Settings, click the button
next to Manage Access. - Find the reader whose access is to be revoked, then click on the
next to it.
The reader will no longer be able to access the docs, or to request a magic link.
Email Invite Customisation
To change the red message that appears when a reader's email is not registered, please contact us with the exact message you want to display. For example:
"This e-mail address does not have an invitation. If you would like to get access, please email elon@tesla.com"
The message can be designed using HTML as well.
Email Invite API
You can also invite reader programmatically using our API. See:
Troubleshooting
If you see Magic Link has already been used every time, it could be due to email security software on your mail domain. This software may access links to check them before you get the email, which can make the link invalid. Please contact us to resolve this mentioning "two step magic links".