Skip to main content

Interface: WebClientOptions

Properties

adapter?

optional adapter: AxiosAdapter;

Custom functions for modifing and handling outgoing requests. Useful if you would like to manage outgoing request with a custom http client. See Axios adapter documentation for more information.

Default

undefined

Defined in

packages/web-api/src/WebClient.ts:111


agent?

optional agent: Agent;

Defined in

packages/web-api/src/WebClient.ts:85


attachOriginalToWebAPIRequestError?

optional attachOriginalToWebAPIRequestError: boolean;

Indicates whether to attach the original error to a Web API request error. When set to true, the original error object will be attached to the Web API request error.

Default

true

Defined in

packages/web-api/src/WebClient.ts:97


headers?

optional headers: Record<string, string>;

Defined in

packages/web-api/src/WebClient.ts:89


logger?

optional logger: Logger;

Defined in

packages/web-api/src/WebClient.ts:81


logLevel?

optional logLevel: LogLevel;

Defined in

packages/web-api/src/WebClient.ts:82


maxRequestConcurrency?

optional maxRequestConcurrency: number;

Defined in

packages/web-api/src/WebClient.ts:83


rejectRateLimitedCalls?

optional rejectRateLimitedCalls: boolean;

Defined in

packages/web-api/src/WebClient.ts:88


requestInterceptor?

optional requestInterceptor: RequestInterceptor;

Custom function to modify outgoing requests. See Axios interceptor documentation for more details.

Default

undefined

Defined in

packages/web-api/src/WebClient.ts:103


retryConfig?

optional retryConfig: RetryOptions;

Defined in

packages/web-api/src/WebClient.ts:84


slackApiUrl?

optional slackApiUrl: string;

Defined in

packages/web-api/src/WebClient.ts:80


teamId?

optional teamId: string;

Defined in

packages/web-api/src/WebClient.ts:90


timeout?

optional timeout: number;

Defined in

packages/web-api/src/WebClient.ts:87


tls?

optional tls: TLSOptions;

Defined in

packages/web-api/src/WebClient.ts:86