Quick start

Quick Start Guide

Welcome to Bugsnap! Let's get you started in just a few simple steps.

Step 1: Create an Account

  1. Visit Bugsnap: Head over to app.bugsnap.io/sign-up (opens in a new tab) to create a new account.
  2. Choose a Sign-in Method: You can sign up using your email address for magic link authentication or directly with your GitHub account.

Step 2: Set Up Your Organization

  1. Create Your Organization: After signing up, you'll be redirected to this page (opens in a new tab). Here, you'll set up your organization's details:
    • Organization Name: This can be any string, but it must be unique across Bugsnap.
    • Organization Slug: A URL-friendly version of your organization name. This will be used in your dashboard URL (e.g., app.bugsnap.io/your-organization-slug/dashboard).
    • Prefix: A unique 3-letter code to mark each issue your organization receives. For example, if your prefix is "HLW", your issues will be labeled as HLW-1, HLW-2, and so on.

Step 3: Invite Your Team

  1. Invite Members: Navigate to this page (opens in a new tab) to invite your team members. Enter their email addresses and assign roles (ADMIN or MEMBER).
  2. Activation: Each invited member will receive an email with a link. They'll need to click on this link to activate their account. Note: On the Free plan, you can invite up to 3 members. The Premium plan allows for unlimited members.

Step 4: Generate Your API Key

  1. Navigate: Go to this page (opens in a new tab) (replace ORGANIZATION_SLUG with your organization's slug).
  2. Create & Manage API Keys: On the Free plan, you can create one API key. Name it, and once created, you can copy its value, roll the key, or delete it. Premium users can create multiple keys for different environments like staging, production, etc.

Congratulations! You've successfully set up your Bugsnap account. Dive into the world of seamless bug reporting and efficient issue management. If you need further assistance, feel free to reach out to our support team at support@bugsnap.io.