Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Security for Connect apps
Framework overview
Building blocks
Modules
JavaScript API
Last updated Feb 24, 2026

Post install redirect

Allows an app to specify a URL users will be redirected to when an app is successfully installed in Bitbucket. The following context parameters are available for use in a postInstallRedirect url:

  • user_username: username of the account where an app was installed.
  • user_uuid: uuid of the account where an app was installed.
  • user_type: The type of account your app was installed on. Either "team" or "user".

Example:

1
2
{
    "modules": {
        "postInstallRedirect": {
            "key": "redirect",
            "url": http://www.example.com?user={user_username}"
        }
    }
}

Properties

key

Typestring
RequiredYes
DescriptionA key to identify this module. This key must be unique across all modules defined by your app.

url

Typestring
RequiredYes
DescriptionThe location users will redirect to after an app is installed. The value can either be an absolute or relative URL. When a relative URL is specified, the URL is relative to your app's base URL.

Rate this page: