Documentation

Learn how to set up and use Required to enforce required fields in your Linear workflow. This guide covers everything from initial setup to advanced configuration.

Getting Started

Required helps you enforce required fields in Linear by automatically moving issues back to previous states when required information is missing. Here's how to get started:

Step 1: Create an Account

Step 2: Connect Linear Workspace

Connect your Linear workspace using OAuth. You'll need administrator permissions to complete this step.

Note: The integration requires write permissions to move issues between states and add comments.

Step 3: Create Required Fields

Configure which fields should be required and in which workflow states they apply.

Field Types

Required supports several types of Linear fields that can be made required:

Estimate

Require time estimates before issues can move to specific states.

Time tracking

Labels

Require specific labels or label groups to be applied.

Categorization

Priority

Ensure priority is set before moving issues forward.

Workflow control

Assignee

Require issues to be assigned before proceeding.

Accountability

Customer

Ensure customer information is linked to the issue.

Customer tracking

Webhook Setup

Required uses Linear webhooks to monitor issue changes in real-time. The webhook is automatically configured when you connect your workspace.

Automatic Configuration

When you connect your Linear workspace, we automatically:

Create a webhook endpoint for your organization
Configure it to listen for issue creation and updates
Set up proper authentication and security
Handle webhook verification and error handling

How It Works

Understanding the workflow and field configuration helps you set up your required fields effectively.

Workflow Process

Step-by-step explanation of how required fields are enforced

Issue State Change

When an issue is moved to a new state, Linear sends a webhook notification.

Field Validation

Our system checks if the target state has any required fields configured.

Requirement Check

If required fields are missing, the issue is moved back to the previous state.

Notification

A comment is added to the issue explaining which fields are required.

Creating Required Fields

Detailed guide on configuring required fields in the dashboard

1. Select Team

Choose the Linear team where you want to enforce required fields. Each team can have different field requirements.

Tip: You can create multiple field configurations for the same team to cover different scenarios.

2. Choose Field Type

Select which type of field should be required:

Estimate - Time tracking

Labels - Categorization

Priority - Workflow control

Assignee - Accountability

Customer - Customer tracking

3. Configure States

Select which workflow states should require this field. The field will be enforced when issues move to these states:

Triage - Cannot be configured (initial state)

Backlog - Optional configuration

Unstarted - Can be required

Started - Can be required

Completed - Can be required

Canceled - Can be required

Important: If triage is enabled, issues without required fields will be moved to triage. Otherwise, they'll be moved to the first backlog state.

4. Name Your Configuration

Give your required field configuration a descriptive name to help you remember its purpose. For example: "Require estimate before starting work" or "Must assign before moving to started".

State Management

How the system determines where to move issues when requirements aren't met

If a previous state exists and doesn't require the same fields, move back to that state

If triage is enabled, move to triage state

Otherwise, move to the first backlog state

Troubleshooting

Common issues and their solutions to help you get the most out of Required.

Issues Not Being Moved Back

If issues aren't being moved back when required fields are missing:

Check that your Linear workspace is properly connected
Verify that the webhook is active in your Linear settings
Ensure you have the correct permissions in Linear
Check the webhook logs for any error messages

Field Not Recognized

If a field isn't being recognized as required:

Verify the field is configured for the correct team
Check that the field is enabled for the target state
Ensure the field type matches what's configured
For labels, verify the label ID is correct

Permission Issues

If you're experiencing permission issues:

Ensure you're an administrator in your Linear workspace
Check that the OAuth integration has write permissions
Verify your account has access to the teams you're configuring
Contact your Linear workspace administrator if needed

Emergency: Disable Integration

If Required is causing issues or is temporarily unavailable, you can disable the integration in Linear:

How to Disable the Integration

Go to your Linear workspace settings
Navigate to "Integrations" or "Webhooks"
Find the Required webhook integration
Click "Disable" or "Delete" to stop the integration
Your workflow will continue normally without field enforcement

Re-enabling the Integration

When you're ready to re-enable the integration:

Go to your Required dashboard
Click "Reconnect Linear Workspace"
Follow the OAuth flow to re-establish the connection
Your field configurations will be restored automatically

Note: When the integration is disabled, issues can move freely between states without field validation. Re-enable the integration when the issue is resolved.

Platform Status

If you suspect Required is down or experiencing issues:

Check if you can access the dashboard at https://required-fields.com
Try creating or editing a field configuration
Check if webhook notifications are being received
Contact support if the platform appears to be down

Support: Email us at support@quantos.it for immediate assistance.

Need Help?

Can't find what you're looking for? Our support team is here to help.

Contact Support

Table of Contents