Context
Defined in: src/types/middleware.ts:37
Context object, which provides contextual information associated with an incoming requests. You can set any other custom attributes in global middleware as long as the key does not conflict with others.
Extends
Indexable
[key: string]: any
Properties
botId?
optional botId?: string;
Defined in: src/types/middleware.ts:53
This app's bot ID in the installed workspace.
This is required for ignoreSelf global middleware.
see also: https://github.com/slackapi/bolt-js/issues/874
botToken?
optional botToken?: string;
Defined in: src/types/middleware.ts:42
A bot token, which starts with xoxb-.
This value can be used by say (preferred over userToken),
botUserId?
optional botUserId?: string;
Defined in: src/types/middleware.ts:58
This app's bot user ID in the installed workspace.
This value is optional but allows ignoreSelf global middleware be more filter more than just message events.
enterpriseId?
optional enterpriseId?: string;
Defined in: src/types/middleware.ts:70
Enterprise Grid Organization ID.
functionBotAccessToken?
optional functionBotAccessToken?: string;
Defined in: src/types/middleware.ts:81
A JIT and function-specific token that, when used to make API calls, creates an association between a function's execution and subsequent actions (e.g., buttons and other interactivity)
functionExecutionId?
optional functionExecutionId?: string;
Defined in: src/types/middleware.ts:86
Function execution ID associated with the event
functionInputs?
optional functionInputs?: FunctionInputs;
Defined in: src/types/middleware.ts:91
Inputs that were provided to a function when it was executed
isEnterpriseInstall
isEnterpriseInstall: boolean;
Defined in: src/types/middleware.ts:74
Is the app installed at an Enterprise level?
retryNum?
optional retryNum?: number;
Defined in: src/types/middleware.ts:96
Retry count of an Events API request (this property does not exist for other requests)
retryReason?
optional retryReason?: string;
Defined in: src/types/middleware.ts:100
Retry reason of an Events API request (this property does not exist for other requests)
teamId?
optional teamId?: string;
Defined in: src/types/middleware.ts:66
Workspace ID.
userId?
optional userId?: string;
Defined in: src/types/middleware.ts:62
User ID.
userToken?
optional userToken?: string;
Defined in: src/types/middleware.ts:47
A bot token, which starts with xoxp-.
This value can be used by say (overridden by botToken),