docs: Deploy with Vercel by haleychaas · Pull Request #2767 · slackapi/bolt-js

haleychaas · 2026-01-23T23:31:47Z

Summary

A tutorial on how to get started with Vercel hosting. Preview here.

Requirements (place an `x` in each `[ ]`)

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

codecov · 2026-01-23T23:33:47Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.44%. Comparing base (bfe4e60) to head (d038c72).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2767   +/-   ##
=======================================
  Coverage   93.44%   93.44%           
=======================================
  Files          37       37           
  Lines        7677     7677           
  Branches      669      669           
=======================================
  Hits         7174     7174           
  Misses        498      498           
  Partials        5        5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

technically-tracy · 2026-01-26T13:09:23Z

docs/english/deployments/vercel/vercel.md

+
+First things first, take a few moments to set up the following: 
+
+* Make sure you have a development environment where you have permission to install apps. You can get a free sandbox with the [Slack developer program](https://api.slack.com/developer-program). 


Suggested change

* Make sure you have a development environment where you have permission to install apps. You can get a free sandbox with the [Slack developer program](https://api.slack.com/developer-program).

* Make sure you have a development environment where you have permission to install apps. You can get a free sandbox with the [Slack Developer Program](https://api.slack.com/developer-program).

technically-tracy · 2026-01-26T13:10:03Z

docs/english/deployments/vercel/vercel.md

+
+![New project](new_project.png)
+
+Select your provider as the Git Scope and rename the repo if you'd like. Next, click **Create**.


Suggested change

Select your provider as the Git Scope and rename the repo if you'd like. Next, click **Create**.

Select your provider as the Git Scope and rename the repo if you'd like. Click **Create**.

technically-tracy · 2026-01-26T13:10:38Z

docs/english/deployments/vercel/vercel.md

+
+## Create a Slack app
+
+Create a new Slack app through [this link](https://api.slack.com/apps?new_app=1), then select **from a manifest**. Next, choose a workspace you have permission to install apps in. Click **Next**, then copy and paste the project manifest code here, replacing the placeholder text in the JSON tab.


Suggested change

Create a new Slack app through [this link](https://api.slack.com/apps?new_app=1), then select **from a manifest**. Next, choose a workspace you have permission to install apps in. Click **Next**, then copy and paste the project manifest code here, replacing the placeholder text in the JSON tab.

Create a new Slack app through [this link](https://api.slack.com/apps?new_app=1), then select **from a manifest**. Next, choose a workspace you have permission to install apps in. Click **Next**, then copy and paste the project manifest code here, replacing the placeholder text in the **JSON** tab.

technically-tracy · 2026-01-26T13:11:59Z

docs/english/deployments/vercel/vercel.md

+
+![Environment variables](env_variables.png)
+
+Now it’ll work through the deployment process and give you updates on what it is doing. Be patient. Deployment is hard work! Once it's finished, you'll see a confirmation screen with a button to **Continue to Dashboard**. Click that button. Here you can see that your app has been deployed! Use this dashboard to keep tabs on build logs, deployment checks and more.


Suggested change

Now it’ll work through the deployment process and give you updates on what it is doing. Be patient. Deployment is hard work! Once it's finished, you'll see a confirmation screen with a button to **Continue to Dashboard**. Click that button. Here you can see that your app has been deployed! Use this dashboard to keep tabs on build logs, deployment checks and more.

The deployment process will kick off, and you'll receive progress updates. Be patient. Deployment is hard work! Once it's finished, you'll see a confirmation screen with a button to **Continue to Dashboard**. Click that button. Here you can see that your app has been deployed! Use this dashboard to keep tabs on build logs, deployment checks, and more.

zimeg

@haleychaas This is a solid guide and an impressive example to showcase! Thanks so much for bringing this to public pages 📚 ✨

Before merging I left a note on another environment variable needed for a smooth starting experience that has all features of a Slack and Vercel AI app. I left a few other small comments but please feel free to publish when you're feeling good about things! Or let me know if I can share more setup details 👾

zimeg · 2026-01-30T19:53:04Z

docs/english/_sidebar.json

+    "items": [
+      "tools/bolt-js/deployments/aws-lambda",
+      "tools/bolt-js/deployments/heroku",
+      "tools/bolt-js/deployments/vercel/vercel"


Suggested change

"tools/bolt-js/deployments/vercel/vercel"

"tools/bolt-js/deployments/vercel"

🪬 question: Can we shorten this path?

that's a question for @lukegalbraithrussell I feel like we need it for some reason but I don't remember why

tools/bolt-js/deployments/vercel is a folder path right now. you need this to specify that you want the vercel file within the vercel folder.

this looks redundant here, but as long as you name the file either 1. the same name as the folder (like you did) or 2. index, the actual URL will just be "/tools/bolt-js/deployments/vercel"

zimeg · 2026-01-30T19:53:59Z

docs/english/deployments/vercel/index.md

🔏 suggestion: I forget if starting with "index.md" might help with the paths above, but might be nice to use for this nested page?

zimeg · 2026-01-30T20:20:03Z

docs/english/deployments/vercel/index.md

+
+Select your provider as the Git Scope and rename the repo if you'd like. Click **Create**.
+
+Keep this browser tab open; we'll be back to it soon. Next, we'll need to add a couple of variables for our app. To obtain these, direct your attention to the Slack app settings page. 


🤖 issue: We might want to add a section on gathering an AI Gateway API token and saving it as another variable called AI_GATEWAY_API_KEY with this step? I found this link to be useful:

🔗 https://vercel.com/d?to=%2F%5Bteam%5D%2F%7E%2Fai%2Fapi-keys

💰 note: This requires also saving debit card details for access to the free tier, but such is common for hosting I find. Unsure if that's needed to callout?

@zimeg did you want to take another look with this section added?

zimeg · 2026-01-30T20:23:13Z

docs/english/deployments/vercel/vercel.md

+
+Once the deployment has completed, navigate back to the Slack [app settings](https://api.slack.com/apps) and open the **App Manifest** from the sidebar. 
+
+Update the manifest so that all of the `reference_url` and `url` fields use your domain. Click **Save** and verify the URL.


👁️‍🗨️ suggestion(non-blocking): Examples might be nice since paths are never obvious for me and these are different from Bolt defaults:

Slash Commands URL: https://slack-agent-template-example.vercel.app/api/slack/events

Event Subscriptions: https://slack-agent-template-example.vercel.app/api/slack/events

Interactivity Request URL: https://slack-agent-template-example.vercel.app/api/slack/events

zimeg

@haleychaas LGTM and apologies for slow response!

Thanks for sharing a few more instruction for a clean experience - we might find improvement to .env setups soon but let's revist that as needed🤖 ✨

deploy with vercel

5a67d9e

haleychaas added 2 commits January 23, 2026 17:42

add to sidebar

614e98d

copy edits

6bfe118

haleychaas requested a review from kkemple January 23, 2026 23:59

haleychaas marked this pull request as ready for review January 23, 2026 23:59

haleychaas requested a review from a team as a code owner January 23, 2026 23:59

technically-tracy reviewed Jan 26, 2026

View reviewed changes

PR feedback

25fb182

haleychaas requested review from technically-tracy and zimeg January 26, 2026 15:10

technically-tracy approved these changes Jan 26, 2026

View reviewed changes

zimeg changed the title ~~Docs: Deploy with Vercel~~ docs: Deploy with Vercel Jan 30, 2026

zimeg added docs M-T: Documentation work only area:examples issues related to example or sample code labels Jan 30, 2026

zimeg approved these changes Jan 30, 2026

View reviewed changes

haleychaas and others added 4 commits February 2, 2026 09:50

PR feedbacK

c3312cc

Merge branch 'main' into docs-haley-vercel-tutorial

808c575

update sidebar

af7fddc

Merge branch 'main' into docs-haley-vercel-tutorial

d018fd9

haleychaas requested a review from zimeg February 3, 2026 23:26

Merge branch 'main' into docs-haley-vercel-tutorial

d038c72

zimeg approved these changes Feb 4, 2026

View reviewed changes

haleychaas merged commit f88096a into main Feb 4, 2026
21 checks passed

haleychaas deleted the docs-haley-vercel-tutorial branch February 4, 2026 20:08


		First things first, take a few moments to set up the following:

		* Make sure you have a development environment where you have permission to install apps. You can get a free sandbox with the [Slack developer program](https://api.slack.com/developer-program).


		![New project](new_project.png)

		Select your provider as the Git Scope and rename the repo if you'd like. Next, click Create.


		## Create a Slack app

		Create a new Slack app through [this link](https://api.slack.com/apps?new_app=1), then select from a manifest. Next, choose a workspace you have permission to install apps in. Click Next, then copy and paste the project manifest code here, replacing the placeholder text in the JSON tab.


		![Environment variables](env_variables.png)

		Now it’ll work through the deployment process and give you updates on what it is doing. Be patient. Deployment is hard work! Once it's finished, you'll see a confirmation screen with a button to Continue to Dashboard. Click that button. Here you can see that your app has been deployed! Use this dashboard to keep tabs on build logs, deployment checks and more.

	Now it’ll work through the deployment process and give you updates on what it is doing. Be patient. Deployment is hard work! Once it's finished, you'll see a confirmation screen with a button to Continue to Dashboard. Click that button. Here you can see that your app has been deployed! Use this dashboard to keep tabs on build logs, deployment checks and more.
	The deployment process will kick off, and you'll receive progress updates. Be patient. Deployment is hard work! Once it's finished, you'll see a confirmation screen with a button to Continue to Dashboard. Click that button. Here you can see that your app has been deployed! Use this dashboard to keep tabs on build logs, deployment checks, and more.

	"tools/bolt-js/deployments/vercel/vercel"
	"tools/bolt-js/deployments/vercel"


		Select your provider as the Git Scope and rename the repo if you'd like. Click Create.

		Keep this browser tab open; we'll be back to it soon. Next, we'll need to add a couple of variables for our app. To obtain these, direct your attention to the Slack app settings page.


		Once the deployment has completed, navigate back to the Slack [app settings](https://api.slack.com/apps) and open the App Manifest from the sidebar.

		Update the manifest so that all of the `reference_url` and `url` fields use your domain. Click Save and verify the URL.

Conversation

haleychaas commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Requirements (place an x in each [ ])

Uh oh!

codecov bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

haleychaas commented Jan 23, 2026 •

edited

Loading

Requirements (place an `x` in each `[ ]`)

codecov bot commented Jan 23, 2026 •

edited

Loading