healthchecks/templates/docs/projects_teams.html

<h1>Projects and Teams</h1>
<p>Use Projects to organize checks in your SITE_NAME account. Your account initially
has a single default project. You can create additional projects and transfer
your checks between them as your usage grows.</p>
<p><img alt="An overview of projects" src="IMG_URL/projects.png" /></p>
<p>Checks and integrations are project-scoped: each check and each configured
integration always belongs to a particular project. Checks can be transferred
between projects. The transfer operation preserves check's ping address:</p>
<p><img alt="The transfer dialog" src="IMG_URL/transfer_check.png" /></p>
<h2>Team Access</h2>
<p>You can grant your colleagues access to a project by inviting them into
the project's team. Each project has its separate team so you can grant access
selectively. Inviting team members is <strong>more convenient and more
secure</strong> than sharing a password to a single account.</p>
<p><img alt="Team access section" src="IMG_URL/team_access.png" /></p>
<p>The user who created the project is the <strong>owner</strong>. Any invited users
are <strong>members</strong>. The members can:</p>
<ul>
<li>create, edit and remove checks</li>
<li>create and remove integrations</li>
<li>rename the project</li>
<li>view and regenerate project's API keys</li>
<li>give up their membership
(from their <a href="../../accounts/profile/">Account Settings</a> page)</li>
</ul>
<p>The members <strong>can not</strong>:</p>
<ul>
<li>invite new members into the project</li>
<li>manage project's billing</li>
<li>remove the project</li>
</ul>
<h2>Read-only Access</h2>
<p>When inviting a team member, you can mark their membership as read-only:</p>
<p><img alt="The Access Level parameter in the Invite form" src="IMG_URL/invite_member.png" /></p>
<p>Read-only members can:</p>
<ul>
<li>view checks, including check details and ping logs</li>
<li>view integrations</li>
<li>give up their membership</li>
</ul>
<p>Read-only members can not modify checks, integrations, or project settings.
They also cannot access the project's API keys as that would effectively give them
read-write access through API.</p>
<h2>Projects and Check Limits</h2>
<p><strong>Check Limit</strong> is the total number of checks your account can have. The specific
limit depends on the account's billing plan. When you reach the Check Limit
you will not be able to create new checks.</p>
<p>All projects owned by your account shares your account's Check Limit.
For example, consider a Business account with two projects,
"Project A" and "Project B." If A has 70 checks, then B cannot have more than
30 checks in order to not exceed the Business account's total limit of 100.</p>
<p>However, only checks from your own projects count towards your account's
quota. If you get invited to somebody else's project, that does not change
the number of checks you can create in your projects.</p>
<h2>Projects and Team Size Limits</h2>
<p><strong>Team Size</strong> is the number of <em>unique</em> users you can invite to your projects.
Same as with Check Limit, all projects share your account's Team Size limit.
However, if you invite the same user (using the same email address) into multiple
projects, it only takes up a single seat.</p>
<h2>Projects and Monthly Reports</h2>
<p>SITE_NAME sends monthly email reports at the start of each month. The monthly reports
list a summary of checks from <strong>all your projects</strong>. It contains status summaries for
both the projects you own and the projects you are a member of.</p>