Documentation

Welcome to Relay

Relay is a client portal that bridges your Linear workspace and your clients. It gives your clients a dedicated, branded space to track project progress, submit requests, and stay up-to-date — without needing access to your internal tools.

Who is Relay for?

Relay is designed for agencies and teams that use Linear for project management and want to share progress with clients in a polished, professional way.

Whether you're a client checking on the status of your project, or an administrator setting up boards and managing users, this documentation will guide you through everything Relay has to offer.

Quick Start

Get up and running with Relay in three steps:

  1. 1

    Log in to your account

    Use the credentials provided in your invitation email to sign in.

  2. 2

    Navigate to your dashboard

    After logging in, you'll see your dashboard with all the boards shared with you.

  3. 3

    Open a board

    Click on any board card to view the project's issues, progress, and updates.

Dashboard Overview

The dashboard is your home base in Relay. It displays all the boards that have been shared with you, each represented by a card showing:

  • The board name and associated projects
  • A progress bar showing overall issue completion
  • Quick counts of open and completed issues

Click on any board card to dive into the full board view with all its issues and details.

Viewing Your Board

The board view is where you see all the issues related to your projects. Issues are organized by their current status, giving you a clear picture of what's in progress, what's completed, and what's upcoming.

Each issue card displays the title, priority indicator, project label, and assignee. Click on any issue to see its full details.

Board & List Views

Relay offers two ways to view your issues:

Board View

A Kanban-style layout with columns for each status. Issues are displayed as cards that you can scan at a glance.

List View

A compact table layout that shows more issues at once with sortable columns for priority, status, and more.

Toggle between views using the view switcher in the toolbar. Your preference is remembered for each board.

Filtering & Searching

Narrow down the issues displayed on your board using the available filters:

  • Project Filter by a specific project within the board
  • Label Show only issues with a particular label
  • Priority Filter by urgency level (Urgent, High, Medium, Low)
  • Cycle View issues from a specific development cycle

Use the search bar to quickly find issues by title. The search updates results in real time as you type.

Tip

Combine multiple filters to narrow down exactly what you're looking for. All active filters are shown as pills that you can remove individually.

Issue Details

Click on any issue to open its detail view. Here you'll find:

  • Description — The full issue description with rich text formatting
  • Metadata sidebar — Status, priority, assignee, project, labels, and cycle
  • Comments — A threaded discussion area to communicate about the issue
  • Subscribe button — Get notified about changes to this issue

Creating Requests

Relay allows you to submit new requests (bugs, feature requests, or general feedback) directly from your board. Click the "New Request" button to open the submission form.

When creating a request, you can provide:

  • Title A brief summary of the request
  • Description Detailed explanation with rich text formatting support
  • Priority How urgent the request is (Urgent, High, Medium, Low, None)
  • Images Attach screenshots or files to help explain the request

Tip

Your request is automatically routed to the team's Linear workspace, so they can start working on it immediately.

Comments & Discussions

Every issue has a comments section where you can communicate with the team. Comments support rich text formatting and are synced with the team's Linear workspace.

Comments are displayed in a threaded format, making it easy to follow conversations. You can reply to specific comments to keep discussions organized.

Note

Comments you post in Relay are visible to the team in Linear, and vice versa. Keep this in mind when discussing sensitive topics.

Viewing Project Updates

Project updates are periodic summaries from the team about the overall progress of your projects. Access them via the "Updates" tab on your board.

Each update includes a written summary from the team, the date it was posted, and a health indicator showing the project's current status.

Updates are listed in reverse chronological order so you always see the latest news first.

Health Indicators

Each project update includes a health indicator to give you a quick sense of how things are going:

On Track — The project is progressing as planned
At Risk — There are potential delays or blockers
Off Track — The project has significant issues that need attention

Email Notifications

Relay keeps you informed via email notifications. You can receive emails for:

  • New comments on issues you're subscribed to
  • Status changes on issues you're following
  • New project updates from the team

Subscriptions

Control which issues and projects you receive notifications for:

  • Issue subscribe Click the subscribe button on any issue detail page to follow it
  • Project subscribe Subscribe to a project to get notified about all its updates
  • Unsubscribe Use the unsubscribe link in any notification email, or toggle it from the issue/project page

Notification Settings

Manage your notification preferences from the Settings page. You can access it from the user menu in the navigation bar.

Here you can update your profile information, change your password, and configure how you receive notifications from Relay.

Admin Dashboard

The admin dashboard provides a high-level overview of your Relay instance. It shows:

  • Total number of boards, projects, users, and issues
  • Linear connection status
  • Quick access to all admin management sections

Admin Only

The admin section is only accessible to users with administrator privileges. If you need admin access, contact your team's Relay administrator.

Managing Boards

Boards are the primary way you organize content for your clients. Each board is a curated view containing one or more projects.

Creating a Board

  1. 1. Navigate to Admin → Boards
  2. 2. Click "Create Board"
  3. 3. Give the board a name and optional description
  4. 4. Assign projects to include on this board
  5. 5. Assign client users who should have access

Editing a Board

Click on any board from the admin boards list to edit its settings, add or remove projects, and manage which clients have access.

Managing Projects

Projects in Relay are synced from your Linear workspace. The admin projects page lets you:

  • View all imported projects and their sync status
  • Import new projects from Linear
  • Trigger a manual sync of project data

How syncing works

Once connected, Relay automatically receives updates from Linear via webhooks. Issues, comments, and status changes are reflected in real time. You can also manually trigger a full sync from the projects page.

Managing Users

The users section lets you manage who has access to your Relay instance.

Inviting Users

Send invitation emails to new users by providing their name and email address. They'll receive a link to set up their password and access their boards.

User Roles

Admin

Full access to all admin features, boards, and settings

Client

Access to assigned boards only, can submit requests and comment on issues

Deactivating Users

Deactivate a user's account to revoke their access. Deactivated users cannot log in but their data is preserved.

Linear Integration

Relay connects to your Linear workspace via OAuth to sync projects, issues, and comments.

Connecting Linear

  1. 1. Go to Admin → Settings
  2. 2. Click "Connect to Linear"
  3. 3. Authorize Relay in the Linear OAuth flow
  4. 4. Once connected, you can import projects from the Projects page

Webhook Sync

After connecting, Relay sets up webhooks with Linear to receive real-time updates. This means changes made in Linear (issue updates, new comments, status changes) are automatically reflected in Relay.

Disconnecting

You can disconnect your Linear account from Admin → Settings at any time. This will stop syncing new data but won't delete any existing data in Relay.

Admin Settings

The settings page is where you configure your Relay instance:

  • Linear Connection — Connect or disconnect your Linear workspace
  • Webhook Configuration — View the status of your Linear webhook
  • General Settings — Configure application-wide preferences