Skip to main content

@slack/web-api / WebClientOptions

Interface: WebClientOptions

Defined in: packages/web-api/src/WebClient.ts:43

Properties​

allowAbsoluteUrls?​

optional allowAbsoluteUrls?: boolean;

Defined in: packages/web-api/src/WebClient.ts:71

Determines if a dynamic method name being an absolute URL overrides the configured slackApiUrl. When set to false, the URL used in Slack API requests will always begin with the slackApiUrl.

See https://docs.slack.dev/tools/node-slack-sdk/web-api/#call-a-method for more details.

Default​

true

fetch?​

optional fetch?: FetchFunction;

Defined in: packages/web-api/src/WebClient.ts:59

A custom fetch implementation conforming to the WHATWG Fetch standard. Defaults to globalThis.fetch. Use this to configure proxies, TLS, or other transport-level behavior.

headers?​

optional headers?: Record<string, string>;

Defined in: packages/web-api/src/WebClient.ts:62

logger?​

optional logger?: Logger;

Defined in: packages/web-api/src/WebClient.ts:51

logLevel?​

optional logLevel?: LogLevel;

Defined in: packages/web-api/src/WebClient.ts:52

maxRequestConcurrency?​

optional maxRequestConcurrency?: number;

Defined in: packages/web-api/src/WebClient.ts:53

rejectRateLimitedCalls?​

optional rejectRateLimitedCalls?: boolean;

Defined in: packages/web-api/src/WebClient.ts:61

retryConfig?​

optional retryConfig?: RetryOptions;

Defined in: packages/web-api/src/WebClient.ts:54

slackApiUrl?​

optional slackApiUrl?: string;

Defined in: packages/web-api/src/WebClient.ts:50

The base URL requests are sent to. Often unchanged, but might be set for testing techniques.

See https://docs.slack.dev/tools/node-slack-sdk/web-api/#custom-api-url for more information.

Default​

https://slack.com/api/

teamId?​

optional teamId?: string;

Defined in: packages/web-api/src/WebClient.ts:63

timeout?​

optional timeout?: number;

Defined in: packages/web-api/src/WebClient.ts:60