slackapi / slackapi/bolt-js

Support automatic SLACK_API_URL configuration via slackApiUrl

Open
#2,926 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

auto-triage-skip enhancement
Dominant language
TypeScript
Stars
2.9k
Forks
445
Avg merge
1d 3h
Merged PRs (30d)
28

Description

Summary

When developing Slack apps that need to run against non-production API endpoints (e.g. qa.slack.com), developers must manually wire the SLACK_API_URL environment variable into the App constructor via clientOptions.slackApiUrl. It would be useful for Bolt to automatically read SLACK_API_URL from the environment and apply it without requiring template/app-level boilerplate.

Context

The starter template currently requires an explicit code change to support custom API URLs:

Ideally this would be handled at the framework level so every template and app gets it for free.

Proposal

Have Bolt automatically check for SLACK_API_URL in the environment and use it as the default slackApiUrl in client options when present, without requiring explicit configuration in app code.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the App constructor and the existing clientOptions.slackApiUrl handling; trace how client options are initialized and how environment variables are read. Verify the behavior for SLACK_API_URL being present or absent, and confirm that apps can use a custom API endpoint without explicitly setting slackApiUrl.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.