Documentation

Jira

Connect PixellPeep to Jira so that when a comparison fails you can turn it into a Jira ticket in one click — with the screenshots attached — instead of copying details over by hand. Requires the Pro or Enterprise plan.

Open Jira settings

Configure

  1. 1

    Check your plan includes Jira

    The Jira connection is on the Pro and Enterprise plans. If this page is greyed out or shows an upgrade message, contact us to upgrade.

    View plans
  2. 2

    Create a Jira API token (a password just for apps)

    This lets PixellPeep create tickets on your behalf. For cloud Jira (a web address ending in .atlassian.net), follow these clicks:

    1. 1.Open the link above and sign in to your Atlassian account.
    2. 2.Click "Create API token".
    3. 3.Give it a label such as "PixellPeep", then click "Create".
    4. 4.Click "Copy" to copy the token, and keep it safe — it is shown only once.
    5. 5.Running Jira on your own server instead? Create a "Personal Access Token" in your Jira profile under your avatar → Personal Access Tokens.
    Open Atlassian API tokens
  3. 3

    Fill in your Jira details here

    On the Jira settings page, enter where your tickets should go:

    1. 1.Choose the PixellPeep project to connect.
    2. 2.Select whether your Jira is "Cloud" or "Server".
    3. 3.Enter your Jira web address — for cloud it looks like https://your-company.atlassian.net with nothing after it.
    4. 4.Enter the project key — the short code shown before each ticket number, e.g. "QA" in QA-123.
    5. 5.Choose the issue type (for example Bug) and any labels you want added.
    Open Jira settings
  4. 4

    Enter your login and save

    For cloud Jira, enter your Atlassian email plus the token you created. For server Jira, just the token. Click "Save" — your token is stored securely and never shown again.

Test

  1. 1

    Test the connection

    Click "Test connection" on the settings page. If your web address, project key, and token are all correct, you will see a success message. If not, re-check those three things first.

  2. 2

    Create a ticket from a failed comparison

    Open a failed comparison on the Compare or Bulk compare page, click "Report to Jira", then "Create issue". Open Jira to confirm the new ticket exists with the screenshots attached.

  3. 3

    No duplicates

    If a ticket was already created for that comparison, the button changes to "View in Jira" and opens the existing ticket instead of making a second one.

Tips

  • For cloud Jira the web address must be exactly https://your-company.atlassian.net with nothing after it.
  • Use the same PixellPeep project that your comparison belongs to.

Troubleshooting table and security notes are in docs/JIRA.md in the repository.