Record a new app version and trigger a version-added task

Records a new deployed version of the app (git SHA, branch, timestamp, deployed URL, optional change description). Adding a version kicks off a version-added task that reviews the change and keeps the project's journeys in sync — it adds new journeys, and for main-branch versions may update/delete existing ones, then triggers test runs for the new/changed journeys. Requires the project to have a GitHub link and main branch configured in its settings.

post/api/v1/projects/{project_id}/versions

Request

  • Base URL: https://qa.replay.io
  • URL: https://qa.replay.io/api/v1/projects/{project_id}/versions
  • Auth: HTTP bearer

Path parameters

project_idstring required

Request body

git_shastring required

Git commit SHA for this version.

branch_namestring required

Git branch name the version was deployed from.

deployed_urlstring

URL where this version is deployed (defaults to the project URL).

timestampstring

ISO 8601 deployment time (defaults to now).

change_descriptionstring

Human-readable summary of what changed in this version.

Response

Created version (its version-added task is queued).

Changes

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