visual_review

Update a repo's settings.

patch/api/projects/{project_id}/visual_review/repos/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/visual_review/repos/{id}/
  • Auth: HTTP bearer

Path parameters

idstring required
project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

baseline_file_pathsobject nullable
enable_pr_commentsboolean nullable

Post a pull request comment when a run finds visual changes to review.

debt_digest_enabledboolean nullable

Post the visual review debt digest to the Slack channels of the teams that own the snapshots. Off by default. The digest goes out every Monday morning.

Response

idstring uuid required
team_idinteger required
repo_external_idinteger required
repo_full_namestring required
baseline_file_pathsobject required
enable_pr_commentsboolean required
debt_digest_enabledboolean required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.