Class: SlackEventAdapter
Defined in: packages/events-api/src/adapter.ts:14
An adapter for Slack's Events API.
Extends
unknown
Constructors
new SlackEventAdapter()
new SlackEventAdapter(signingSecret, __namedParameters): SlackEventAdapter
Defined in: packages/events-api/src/adapter.ts:47
Parameters
signingSecret
string
The token used to authenticate signed requests from Slack's Events API.
__namedParameters
EventAdapterOptions = {}
Returns
Overrides
EventEmitter.constructor
Properties
includeBody
includeBody: boolean;
Defined in: packages/events-api/src/adapter.ts:23
Whether to include the API event bodies in adapter event listeners.
includeHeaders
includeHeaders: boolean;
Defined in: packages/events-api/src/adapter.ts:28
Whether to include request headers in adapter event listeners.
signingSecret
readonly signingSecret: string;
Defined in: packages/events-api/src/adapter.ts:18
The token used to authenticate signed requests from Slack's Events API.
waitForResponse
waitForResponse: boolean;
Defined in: packages/events-api/src/adapter.ts:33
When true prevents the adapter from responding by itself and leaves that up to listeners.
Methods
createServer()
createServer(): Promise<Server>
Defined in: packages/events-api/src/adapter.ts:76
Creates an HTTP server to listen for event payloads.
Returns
Promise<Server>
expressMiddleware()
expressMiddleware(): RequestHandler
Defined in: packages/events-api/src/adapter.ts:120
Returns a middleware-compatible adapter.
Returns
RequestHandler
requestListener()
requestListener(): RequestListener
Defined in: packages/events-api/src/adapter.ts:130
Creates a request listener.
Returns
RequestListener
start()
start(port): Promise<Server>
Defined in: packages/events-api/src/adapter.ts:87
Starts a server on the specified port.
Parameters
port
number
The port number to listen on.
Returns
Promise<Server>
The server from the built-in http module.
stop()
stop(): Promise<void>
Defined in: packages/events-api/src/adapter.ts:100
Stops the server started by SlackEventAdapter.start.
Returns
Promise<void>