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!

SCM integration overview

Overview of how Percy integrates with your source code management system.

Percy integrates with your source code management system so you can do visual reviews alongside code reviews. It also facilitates a two-way sync between your Percy builds and your pull/merge requests, making it easy for your team to review visual diffs.

Supported SCMs


Once you integrate with your SCM, the next step is to link your Percy projects with your SCM repositories. This will automatically correlate commits and pull/merge requests with Percy builds.

Status updates


If a Percy build has visual diffs, it will be reported as needing review in your SCM. With one-click, you can review and approve the visual diffs in Percy.

Through this integration, Percy automatically pulls rich metadata into each build including information regarding the compared branches, committers, commit messages, and more.

Approval workflow


Approving a build in Percy sets the status to "passed." Percy then automatically updates the pull/merge request details of when and which team member approved it.

Example pull request summary in GitHub.

Example pull request summary in GitHub.

Note: By default, Percy approvals aren’t required before merging, but you can enable this feature once you’re ready for it.

As part of this visual review workflow, Percy supports various functionality:

Getting started


See our service-specific documentation to set up your integration.

Don't see your integration listed? Check out our webhooks documentation, or send a note to support@percy.io.

SCM integration overview


Overview of how Percy integrates with your source code management system.

Suggested Edits are limited on API Reference Pages

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