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

Configure page

Used to configure an app. A link to the page is displayed in an app's entry from the Manage Apps page. Unlike other page modules, an app may only define a single configurePage.

Properties

key

Typestring
Max length128
RequiredYes
Pattern^[a-zA-Z0-9-]+$
DescriptionA key to identify this module. This key must be unique across all modules defined by your app.

name

Typei18n-property
RequiredYes
DescriptionRepresents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places, but identical keys must have identical values.

Properties

i18n
Type
string
Description

The localization key for i18n. You can use the i18n localization key in your apps, however, Bitbucket does not currently support localization.

value
Type
string
Description

The human-readable value.

url

Typestring
Max length2048
RequiredYes

conditions

Type
[Simple condition, Composition condition, ...]
Description

Conditions control whether or not a module will be displayed based on the current context. See Conditions for more details

params

Typeobject

Rate this page: