slackapi / slackapi/bolt-js

Better typing for block actions payload

Open
#2,122 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I wish some block action body will have more correct typing.

For example, when I use InteractiveMessage type when I want to handle event for clicking button on message, that's type does not contain container payload. But actually it exists.
I think it's intentional type, here is an official document.
https://api.slack.com/reference/interaction-payloads/block-actions#examples

Is there any blocker to implement this type? If not, I have a motivation to pull request.

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

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 with src/types/actions/interactive-message.ts and compare its InteractiveMessage shape with the official Slack block-actions examples linked in the issue. Update the relevant typing so the documented container payload is represented, then run the existing type tests or project checks to verify the payload remains compatible.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.