Deploy Button Source

Parameter	Type	Value
`repository-url`	`string`	The source Git repository URL.

Use the repository-url parameter to specify a Git repository URL. You can optionally include a subdirectory within the repository. Users clone this into their GitHub, GitLab, or Bitbucket account when going through the Vercel Project creation flow.

The example below shows how to set the repository URL to hello-world:

The repository-url parameter is required when sending you to the Vercel Project creation flow to set up a project from a GitHub, GitLab, or Bitbucket repository.

Parameter	Type	Value
`project-name`	`string`	A default project name.

Use the project-name parameter to define a default project name.

This is useful when you already know what to name the project. For example, if you're sending the deploy link from an application that has already set up a project that will connect to the created Vercel project.

If a project with the specified name already exists, you'll need to define a new project name. The project is not guaranteed to have the specified name.

The example below shows how to set the project name to "my-awesome-project":

Parameter	Type	Value
`repository-name`	`string`	A default repository name (no spaces).

Use the repository-name parameter to define a default repository name.

Similar to the Project Name parameter, this is useful when you already know what to name the repository.

The example below shows how to set the repository name to "my-awesome-project":

Parameter	Type	Value
`stores`	`string`	A default JSON object converted to a string.

The stores parameter accepts a JSON array of store configurations. Each item in the array defines a store to create during deployment. You can use it to set up a Vercel Blob store or an integration-based store.

To create a Vercel Blob store during deployment, set type to blob:

Property	Type	Required	Description
`type`	`string`	Yes	Must be `blob`.
`access`	`string`	No	Set to `public` or `private` to fix the access level in the creation modal. When you omit this property, the modal defaults to `private` and you can choose either option.
`envVarPrefix`	`string`	No	Custom prefix for the environment variables created for this store. For example, setting this to `MYBLOG` produces `MYBLOG_BLOB_READ_WRITE_TOKEN`.

For example, to create a Blob store with private access:

First, encode the parameter:

Then, use it as follows:

To set up a store from a Marketplace integration, set type to integration:

Property	Type	Required	Description
`type`	`string`	Yes	Must be `integration`.
`integrationSlug`	`string`	Yes	The slug of the integration.
`productSlug`	`string`	Yes	The slug of the product.
`protocol`	`string`	No	The protocol type (e.g., `storage`).
`envVarPrefix`	`string`	No	Custom prefix for the environment variables.
`allowConnectExistingProduct`	`boolean`	No	Whether to allow connecting an existing product instead of creating a new one.

For example:

First, encode the parameter:

Then, use it as follows: