Percy Developer Hub

Welcome to the Percy Developer Hub. You'll find comprehensive guides and documentation to help you start working with Percy as quickly as possible, as well as support if you get stuck. Let's jump right in!

Bitbucket Cloud

Covered in this doc

Installing Percy’s Bitbucket Cloud integration
Linking Percy projects with Bitbucket repositories

If you're using Bitbucket Server or Data Center, sign up to be included in our future beta programs here.

The Percy Bitbucket integration makes it easier to sync visual reviews with code reviews. Once installed, Percy will be able to automatically pull in metadata from pull requests to builds, and post status updates to Bitbucket Cloud repositories. This integration also helps us provide more relevant snapshot comparisons through smarter base build selection.

Installing the Percy Bitbucket integration


Navigate to your Organization Settings > Integrations. Click “Install” to add Bitbucket.
When you click “Install Bitbucket Cloud App” you’ll be directed to Bitbucket for authentication.

Granting Percy access to your Bitbucket account will allow you to link projects to any repository you have admin access to in Bitbucket.

Linking Percy projects and Bitbucket repositories


Once you’ve granted access, you’ll need to link your Percy projects to your Bitbucket repositories.

Percy projects can also be linked to Bitbucket repositories from the Project's settings page, in the "Link a repository" section.

Running and reviewing builds


Once you've added the app and linked projects with repositories, subsequent Percy builds will show metadata from Bitbucket, and the Percy status will be shown on Bitbucket pull requests.

Clicking the Percy status in Bitbucket will take you to the Percy build UI, showing all visual diffs to be reviewed. Approving a build in Percy sets the Percy status in Bitbucket to successful, so that your team can see that visual changes were reviewed and approved.


What's next

Learn about our additional workflow features like snapshot carryforward, auto-approved branches, baseline picking, and more.

Approval workflows
Base build selection

Bitbucket Cloud


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.