@slack/web-api

@slack/web-api

Version 6.7.2
Published 20 days ago
1.46 MB
11 dependencies
MIT license

Install

npm i @slack/web-api

yarn add @slack/web-api

pnpm add @slack/web-api

Overview

Official library for using the Slack Platform's Web API

Index

Variables

variable cursorPaginationEnabledMethods

const cursorPaginationEnabledMethods: Set<string>;

variable retryPolicies

const retryPolicies: {
    tenRetriesInAboutThirtyMinutes: RetryOptions;
    fiveRetriesInFiveMinutes: RetryOptions;
    rapidRetryPolicy: RetryOptions;
};

Functions

function addAppMetadata

addAppMetadata: ({ name, version }: { name: string; version: string }) => void;

Appends the app metadata into the User-Agent value
Parameter
appMetadata.name - name of tool to be counted in instrumentation
Parameter
appMetadata.version - version of tool to be counted in instrumentation

Classes

class Methods

abstract class Methods extends EventEmitter<WebClientEvent> {}

A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the apiCall class method.

constructor

protected constructor();

property admin

readonly admin: {
    apps: {
        approve: Method<AdminAppsApproveArguments, AdminAppsApproveResponse>;
        approved: {
            list: Method<
                AdminAppsApprovedListArguments,
                AdminAppsApprovedListResponse
            >;
        };
        clearResolution: Method<
            AdminAppsClearResolutionArguments,
            AdminAppsClearResolutionResponse
        >;
        requests: {
            cancel: Method<
                AdminAppsRequestsCancelArguments,
                AdminAppsRequestsCancelResponse
            >;
            list: Method<
                AdminAppsRequestsListArguments,
                AdminAppsRequestsListResponse
            >;
        };
        restrict: Method<AdminAppsRestrictArguments, AdminAppsRestrictResponse>;
        restricted: {
            list: Method<
                AdminAppsRestrictedListArguments,
                AdminAppsRestrictedListResponse
            >;
        };
        uninstall: Method<
            AdminAppsUninstallArguments,
            AdminAppsUninstallResponse
        >;
    };
    auth: {
        policy: {
            assignEntities: Method<
                AdminAuthPolicyAssignEntitiesArguments,
                AdminAuthPolicyAssignEntitiesResponse
            >;
            getEntities: Method<
                AdminAuthPolicyGetEntitiesArguments,
                AdminAuthPolicyGetEntitiesResponse
            >;
            removeEntities: Method<
                AdminAuthPolicyRemoveEntitiesArguments,
                AdminAuthPolicyRemoveEntitiesResponse
            >;
        };
    };
    barriers: {
        create: Method<
            AdminBarriersCreateArguments,
            AdminBarriersCreateResponse
        >;
        delete: Method<
            AdminBarriersDeleteArguments,
            AdminBarriersDeleteResponse
        >;
        list: Method<AdminBarriersListArguments, AdminBarriersListResponse>;
        update: Method<
            AdminBarriersUpdateArguments,
            AdminBarriersUpdateResponse
        >;
    };
    conversations: {
        archive: Method<
            AdminConversationsArchiveArguments,
            AdminConversationsArchiveResponse
        >;
        convertToPrivate: Method<
            AdminConversationsConvertToPrivateArguments,
            AdminConversationsConvertToPrivateResponse
        >;
        create: Method<
            AdminConversationsCreateArguments,
            AdminConversationsCreateResponse
        >;
        delete: Method<
            AdminConversationsDeleteArguments,
            AdminConversationsDeleteResponse
        >;
        disconnectShared: Method<
            AdminConversationsDisconnectSharedArguments,
            AdminConversationsDisconnectSharedResponse
        >;
        ekm: {
            listOriginalConnectedChannelInfo: Method<
                AdminConversationsEKMListOriginalConnectedChannelInfoArguments,
                AdminConversationsEkmListOriginalConnectedChannelInfoResponse
            >;
        };
        getConversationPrefs: Method<
            AdminConversationsGetConversationPrefsArguments,
            AdminConversationsGetConversationPrefsResponse
        >;
        getTeams: Method<
            AdminConversationsGetTeamsArguments,
            AdminConversationsGetTeamsResponse
        >;
        invite: Method<
            AdminConversationsInviteArguments,
            AdminConversationsInviteResponse
        >;
        rename: Method<
            AdminConversationsRenameArguments,
            AdminConversationsRenameResponse
        >;
        restrictAccess: {
            addGroup: Method<
                AdminConversationsRestrictAccessAddGroupArguments,
                AdminConversationsRestrictAccessAddGroupResponse
            >;
            listGroups: Method<
                AdminConversationsRestrictAccessListGroupsArguments,
                AdminConversationsRestrictAccessListGroupsResponse
            >;
            removeGroup: Method<
                AdminConversationsRestrictAccessRemoveGroupArguments,
                AdminConversationsRestrictAccessRemoveGroupResponse
            >;
        };
        getCustomRetention: Method<
            AdminConversationsGetCustomRetentionArguments,
            AdminConversationsGetCustomRetentionResponse
        >;
        setCustomRetention: Method<
            AdminConversationsSetCustomRetentionArguments,
            AdminConversationsSetCustomRetentionResponse
        >;
        removeCustomRetention: Method<
            AdminConversationsRemoveCustomRetentionArguments,
            AdminConversationsRemoveCustomRetentionResponse
        >;
        search: Method<
            AdminConversationsSearchArguments,
            AdminConversationsSearchResponse
        >;
        setConversationPrefs: Method<
            AdminConversationsSetConversationPrefsArguments,
            AdminConversationsSetConversationPrefsResponse
        >;
        setTeams: Method<
            AdminConversationsSetTeamsArguments,
            AdminConversationsSetTeamsResponse
        >;
        unarchive: Method<
            AdminConversationsUnarchiveArguments,
            AdminConversationsUnarchiveResponse
        >;
    };
    emoji: {
        add: Method<AdminEmojiAddArguments, AdminEmojiAddResponse>;
        addAlias: Method<
            AdminEmojiAddAliasArguments,
            AdminEmojiAddAliasResponse
        >;
        list: Method<AdminEmojiListArguments, AdminEmojiListResponse>;
        remove: Method<AdminEmojiRemoveArguments, AdminEmojiRemoveResponse>;
        rename: Method<AdminEmojiRenameArguments, AdminEmojiRenameResponse>;
    };
    inviteRequests: {
        approve: Method<
            AdminInviteRequestsApproveArguments,
            AdminInviteRequestsApproveResponse
        >;
        approved: {
            list: Method<
                AdminInviteRequestsApprovedListArguments,
                AdminInviteRequestsApprovedListResponse
            >;
        };
        denied: {
            list: Method<
                AdminInviteRequestsDeniedListArguments,
                AdminInviteRequestsDeniedListResponse
            >;
        };
        deny: Method<
            AdminInviteRequestsDenyArguments,
            AdminInviteRequestsDenyResponse
        >;
        list: Method<
            AdminInviteRequestsListArguments,
            AdminInviteRequestsListResponse
        >;
    };
    teams: {
        admins: {
            list: Method<
                AdminTeamsAdminsListArguments,
                AdminTeamsAdminsListResponse
            >;
        };
        create: Method<AdminTeamsCreateArguments, AdminTeamsCreateResponse>;
        list: Method<AdminTeamsListArguments, AdminTeamsListResponse>;
        owners: {
            list: Method<
                AdminTeamsOwnersListArguments,
                AdminTeamsOwnersListResponse
            >;
        };
        settings: {
            info: Method<
                AdminTeamsSettingsInfoArguments,
                AdminTeamsSettingsInfoResponse
            >;
            setDefaultChannels: Method<
                AdminTeamsSettingsSetDefaultChannelsArguments,
                AdminTeamsSettingsSetDefaultChannelsResponse
            >;
            setDescription: Method<
                AdminTeamsSettingsSetDescriptionArguments,
                AdminTeamsSettingsSetDescriptionResponse
            >;
            setDiscoverability: Method<
                AdminTeamsSettingsSetDiscoverabilityArguments,
                AdminTeamsSettingsSetDiscoverabilityResponse
            >;
            setIcon: Method<
                AdminTeamsSettingsSetIconArguments,
                AdminTeamsSettingsSetIconResponse
            >;
            setName: Method<
                AdminTeamsSettingsSetNameArguments,
                AdminTeamsSettingsSetNameResponse
            >;
        };
    };
    usergroups: {
        addChannels: Method<
            AdminUsergroupsAddChannelsArguments,
            AdminUsergroupsAddChannelsResponse
        >;
        addTeams: Method<
            AdminUsergroupsAddTeamsArguments,
            AdminUsergroupsAddTeamsResponse
        >;
        listChannels: Method<
            AdminUsergroupsListChannelsArguments,
            AdminUsergroupsListChannelsResponse
        >;
        removeChannels: Method<
            AdminUsergroupsRemoveChannelsArguments,
            AdminUsergroupsRemoveChannelsResponse
        >;
    };
    users: {
        assign: Method<AdminUsersAssignArguments, AdminUsersAssignResponse>;
        invite: Method<AdminUsersInviteArguments, AdminUsersInviteResponse>;
        list: Method<AdminUsersListArguments, AdminUsersListResponse>;
        remove: Method<AdminUsersRemoveArguments, AdminUsersRemoveResponse>;
        session: {
            list: Method<
                AdminUsersSessionListArguments,
                AdminUsersSessionListResponse
            >;
            reset: Method<
                AdminUsersSessionResetArguments,
                AdminUsersSessionResetResponse
            >;
            resetBulk: Method<
                AdminUsersSessionResetBulkArguments,
                AdminUsersSessionResetBulkResponse
            >;
            invalidate: Method<
                AdminUsersSessionInvalidateArguments,
                AdminUsersSessionInvalidateResponse
            >;
            getSettings: Method<
                AdminUsersSessionGetSettingsArguments,
                AdminUsersSessionGetSettingsResponse
            >;
            setSettings: Method<
                AdminUsersSessionSetSettingsArguments,
                AdminUsersSessionSetSettingsResponse
            >;
            clearSettings: Method<
                AdminUsersSessionClearSettingsArguments,
                AdminUsersSessionClearSettingsResponse
            >;
        };
        unsupportedVersions: {
            export: Method<
                AdminUsersUnsupportedVersionsExportArguments,
                AdminUsersUnsupportedVersionsExportResponse
            >;
        };
        setAdmin: Method<
            AdminUsersSetAdminArguments,
            AdminUsersSetAdminResponse
        >;
        setExpiration: Method<
            AdminUsersSetExpirationArguments,
            AdminUsersSetExpirationResponse
        >;
        setOwner: Method<
            AdminUsersSetOwnerArguments,
            AdminUsersSetOwnerResponse
        >;
        setRegular: Method<
            AdminUsersSetRegularArguments,
            AdminUsersSetRegularResponse
        >;
    };
};

property api

readonly api: { test: Method<APITestArguments, ApiTestResponse> };

property apps

readonly apps: {
    connections: {
        open: Method<AppsConnectionsOpenArguments, AppsConnectionsOpenResponse>;
    };
    event: {
        authorizations: {
            list: Method<
                AppsEventAuthorizationsListArguments,
                AppsEventAuthorizationsListResponse
            >;
        };
    };
    uninstall: Method<AppsUninstallArguments, AppsUninstallResponse>;
};

property auth

readonly auth: {
    revoke: Method<AuthRevokeArguments, AuthRevokeResponse>;
    teams: { list: Method<AuthTeamsListArguments, AuthTeamsListResponse> };
    test: Method<AuthTestArguments, AuthTestResponse>;
};

property bookmarks

readonly bookmarks: {
    add: Method<BookmarksAddArguments, BookmarksAddResponse>;
    edit: Method<BookmarksEditArguments, BookmarksEditResponse>;
    list: Method<BookmarksListArguments, BookmarksListResponse>;
    remove: Method<BookmarksRemoveArguments, BookmarksRemoveResponse>;
};

property bots

readonly bots: { info: Method<BotsInfoArguments, BotsInfoResponse> };

property calls

readonly calls: {
    add: Method<CallsAddArguments, CallsAddResponse>;
    end: Method<CallsEndArguments, CallsEndResponse>;
    info: Method<CallsInfoArguments, CallsInfoResponse>;
    update: Method<CallsUpdateArguments, CallsUpdateResponse>;
    participants: {
        add: Method<CallsParticipantsAddArguments, CallsParticipantsAddResponse>;
        remove: Method<
            CallsParticipantsRemoveArguments,
            CallsParticipantsRemoveResponse
        >;
    };
};

property channels

readonly channels: {
    archive: Method<ChannelsArchiveArguments, WebAPICallResult>;
    create: Method<ChannelsCreateArguments, WebAPICallResult>;
    history: Method<ChannelsHistoryArguments, WebAPICallResult>;
    info: Method<ChannelsInfoArguments, WebAPICallResult>;
    invite: Method<ChannelsInviteArguments, WebAPICallResult>;
    join: Method<ChannelsJoinArguments, WebAPICallResult>;
    kick: Method<ChannelsKickArguments, WebAPICallResult>;
    leave: Method<ChannelsLeaveArguments, WebAPICallResult>;
    list: Method<ChannelsListArguments, WebAPICallResult>;
    mark: Method<ChannelsMarkArguments, WebAPICallResult>;
    rename: Method<ChannelsRenameArguments, WebAPICallResult>;
    replies: Method<ChannelsRepliesArguments, WebAPICallResult>;
    setPurpose: Method<ChannelsSetPurposeArguments, WebAPICallResult>;
    setTopic: Method<ChannelsSetTopicArguments, WebAPICallResult>;
    unarchive: Method<ChannelsUnarchiveArguments, WebAPICallResult>;
};

property chat

readonly chat: {
    delete: Method<ChatDeleteArguments, ChatDeleteResponse>;
    deleteScheduledMessage: Method<
        ChatDeleteScheduledMessageArguments,
        ChatDeleteScheduledMessageResponse
    >;
    getPermalink: Method<ChatGetPermalinkArguments, ChatGetPermalinkResponse>;
    meMessage: Method<ChatMeMessageArguments, ChatMeMessageResponse>;
    postEphemeral: Method<ChatPostEphemeralArguments, ChatPostEphemeralResponse>;
    postMessage: Method<ChatPostMessageArguments, ChatPostMessageResponse>;
    scheduleMessage: Method<
        ChatScheduleMessageArguments,
        ChatScheduleMessageResponse
    >;
    scheduledMessages: {
        list: Method<
            ChatScheduledMessagesListArguments,
            ChatScheduledMessagesListResponse
        >;
    };
    unfurl: Method<ChatUnfurlArguments, ChatUnfurlResponse>;
    update: Method<ChatUpdateArguments, ChatUpdateResponse>;
};

property conversations

readonly conversations: {
    acceptSharedInvite: Method<
        ConversationsAcceptSharedInviteArguments,
        ConversationsAcceptSharedInviteResponse
    >;
    approveSharedInvite: Method<
        ConversationsApproveSharedInviteArguments,
        ConversationsApproveSharedInviteResponse
    >;
    archive: Method<ConversationsArchiveArguments, ConversationsArchiveResponse>;
    close: Method<ConversationsCloseArguments, ConversationsCloseResponse>;
    create: Method<ConversationsCreateArguments, ConversationsCreateResponse>;
    declineSharedInvite: Method<
        ConversationsDeclineSharedInviteArguments,
        ConversationsDeclineSharedInviteResponse
    >;
    history: Method<ConversationsHistoryArguments, ConversationsHistoryResponse>;
    info: Method<ConversationsInfoArguments, ConversationsInfoResponse>;
    invite: Method<ConversationsInviteArguments, ConversationsInviteResponse>;
    inviteShared: Method<
        ConversationsInviteSharedArguments,
        ConversationsInviteSharedResponse
    >;
    join: Method<ConversationsJoinArguments, ConversationsJoinResponse>;
    kick: Method<ConversationsKickArguments, ConversationsKickResponse>;
    leave: Method<ConversationsLeaveArguments, ConversationsLeaveResponse>;
    list: Method<ConversationsListArguments, ConversationsListResponse>;
    listConnectInvites: Method<
        ConversationsListConnectInvitesArguments,
        ConversationsListConnectInvitesResponse
    >;
    mark: Method<ConversationsMarkArguments, ConversationsMarkResponse>;
    members: Method<ConversationsMembersArguments, ConversationsMembersResponse>;
    open: Method<ConversationsOpenArguments, ConversationsOpenResponse>;
    rename: Method<ConversationsRenameArguments, ConversationsRenameResponse>;
    replies: Method<ConversationsRepliesArguments, ConversationsRepliesResponse>;
    setPurpose: Method<
        ConversationsSetPurposeArguments,
        ConversationsSetPurposeResponse
    >;
    setTopic: Method<
        ConversationsSetTopicArguments,
        ConversationsSetTopicResponse
    >;
    unarchive: Method<
        ConversationsUnarchiveArguments,
        ConversationsUnarchiveResponse
    >;
};

property dialog

readonly dialog: { open: Method<DialogOpenArguments, DialogOpenResponse> };

property dnd

readonly dnd: {
    endDnd: Method<DndEndDndArguments, DndEndDndResponse>;
    endSnooze: Method<DndEndSnoozeArguments, DndEndSnoozeResponse>;
    info: Method<DndInfoArguments, DndInfoResponse>;
    setSnooze: Method<DndSetSnoozeArguments, DndSetSnoozeResponse>;
    teamInfo: Method<DndTeamInfoArguments, DndTeamInfoResponse>;
};

property emoji

readonly emoji: { list: Method<EmojiListArguments, EmojiListResponse> };

property files

readonly files: {
    delete: Method<FilesDeleteArguments, FilesDeleteResponse>;
    info: Method<FilesInfoArguments, FilesInfoResponse>;
    list: Method<FilesListArguments, FilesListResponse>;
    revokePublicURL: Method<
        FilesRevokePublicURLArguments,
        FilesRevokePublicURLResponse
    >;
    sharedPublicURL: Method<
        FilesSharedPublicURLArguments,
        FilesSharedPublicURLResponse
    >;
    upload: Method<FilesUploadArguments, FilesUploadResponse>;
    comments: {
        delete: Method<
            FilesCommentsDeleteArguments,
            FilesCommentsDeleteResponse
        >;
    };
    remote: {
        info: Method<FilesRemoteInfoArguments, FilesRemoteInfoResponse>;
        list: Method<FilesRemoteListArguments, FilesRemoteListResponse>;
        add: Method<FilesRemoteAddArguments, FilesRemoteAddResponse>;
        update: Method<FilesRemoteUpdateArguments, FilesRemoteUpdateResponse>;
        remove: Method<FilesRemoteRemoveArguments, FilesRemoteRemoveResponse>;
        share: Method<FilesRemoteShareArguments, FilesRemoteShareResponse>;
    };
};

property groups

readonly groups: {
    archive: Method<GroupsArchiveArguments, WebAPICallResult>;
    create: Method<GroupsCreateArguments, WebAPICallResult>;
    createChild: Method<GroupsCreateChildArguments, WebAPICallResult>;
    history: Method<GroupsHistoryArguments, WebAPICallResult>;
    info: Method<GroupsInfoArguments, WebAPICallResult>;
    invite: Method<GroupsInviteArguments, WebAPICallResult>;
    kick: Method<GroupsKickArguments, WebAPICallResult>;
    leave: Method<GroupsLeaveArguments, WebAPICallResult>;
    list: Method<GroupsListArguments, WebAPICallResult>;
    mark: Method<GroupsMarkArguments, WebAPICallResult>;
    open: Method<GroupsOpenArguments, WebAPICallResult>;
    rename: Method<GroupsRenameArguments, WebAPICallResult>;
    replies: Method<GroupsRepliesArguments, WebAPICallResult>;
    setPurpose: Method<GroupsSetPurposeArguments, WebAPICallResult>;
    setTopic: Method<GroupsSetTopicArguments, WebAPICallResult>;
    unarchive: Method<GroupsUnarchiveArguments, WebAPICallResult>;
};

property im

readonly im: {
    close: Method<IMCloseArguments, WebAPICallResult>;
    history: Method<IMHistoryArguments, WebAPICallResult>;
    list: Method<IMListArguments, WebAPICallResult>;
    mark: Method<IMMarkArguments, WebAPICallResult>;
    open: Method<IMOpenArguments, WebAPICallResult>;
    replies: Method<IMRepliesArguments, WebAPICallResult>;
};

property migration

readonly migration: {
    exchange: Method<MigrationExchangeArguments, MigrationExchangeResponse>;
};

property mpim

readonly mpim: {
    close: Method<MPIMCloseArguments, WebAPICallResult>;
    history: Method<MPIMHistoryArguments, WebAPICallResult>;
    list: Method<MPIMListArguments, WebAPICallResult>;
    mark: Method<MPIMMarkArguments, WebAPICallResult>;
    open: Method<MPIMOpenArguments, WebAPICallResult>;
    replies: Method<MPIMRepliesArguments, WebAPICallResult>;
};

property oauth

readonly oauth: {
    access: Method<OAuthAccessArguments, OauthAccessResponse>;
    v2: {
        access: Method<OAuthV2AccessArguments, OauthV2AccessResponse>;
        exchange: Method<OAuthV2ExchangeArguments, OauthV2ExchangeResponse>;
    };
};

property openid

readonly openid: {
    connect: {
        token: Method<OpenIDConnectTokenArguments, OpenIDConnectTokenResponse>;
        userInfo: Method<
            OpenIDConnectUserInfoArguments,
            OpenIDConnectUserInfoResponse
        >;
    };
};

property pins

readonly pins: {
    add: Method<PinsAddArguments, PinsAddResponse>;
    list: Method<PinsListArguments, PinsListResponse>;
    remove: Method<PinsRemoveArguments, PinsRemoveResponse>;
};

property reactions

readonly reactions: {
    add: Method<ReactionsAddArguments, ReactionsAddResponse>;
    get: Method<ReactionsGetArguments, ReactionsGetResponse>;
    list: Method<ReactionsListArguments, ReactionsListResponse>;
    remove: Method<ReactionsRemoveArguments, ReactionsRemoveResponse>;
};

property reminders

readonly reminders: {
    add: Method<RemindersAddArguments, RemindersAddResponse>;
    complete: Method<RemindersCompleteArguments, RemindersCompleteResponse>;
    delete: Method<RemindersDeleteArguments, RemindersDeleteResponse>;
    info: Method<RemindersInfoArguments, RemindersInfoResponse>;
    list: Method<RemindersListArguments, RemindersListResponse>;
};

property rtm

readonly rtm: {
    connect: Method<RTMConnectArguments, RtmConnectResponse>;
    start: Method<RTMStartArguments, RtmStartResponse>;
};

property search

readonly search: {
    all: Method<SearchAllArguments, SearchAllResponse>;
    files: Method<SearchFilesArguments, SearchFilesResponse>;
    messages: Method<SearchMessagesArguments, SearchMessagesResponse>;
};

property stars

readonly stars: {
    add: Method<StarsAddArguments, StarsAddResponse>;
    list: Method<StarsListArguments, StarsListResponse>;
    remove: Method<StarsRemoveArguments, StarsRemoveResponse>;
};

property team

readonly team: {
    accessLogs: Method<TeamAccessLogsArguments, TeamAccessLogsResponse>;
    billableInfo: Method<TeamBillableInfoArguments, TeamBillableInfoResponse>;
    billing: { info: Method<TeamBillingInfoArguments, TeamBillingInfoResponse> };
    info: Method<TeamInfoArguments, TeamInfoResponse>;
    integrationLogs: Method<
        TeamIntegrationLogsArguments,
        TeamIntegrationLogsResponse
    >;
    preferences: {
        list: Method<TeamPreferencesListArguments, TeamPreferencesListResponse>;
    };
    profile: { get: Method<TeamProfileGetArguments, TeamProfileGetResponse> };
};

property usergroups

readonly usergroups: {
    create: Method<UsergroupsCreateArguments, UsergroupsCreateResponse>;
    disable: Method<UsergroupsDisableArguments, UsergroupsDisableResponse>;
    enable: Method<UsergroupsEnableArguments, UsergroupsEnableResponse>;
    list: Method<UsergroupsListArguments, UsergroupsListResponse>;
    update: Method<UsergroupsUpdateArguments, UsergroupsUpdateResponse>;
    users: {
        list: Method<UsergroupsUsersListArguments, UsergroupsUsersListResponse>;
        update: Method<
            UsergroupsUsersUpdateArguments,
            UsergroupsUsersUpdateResponse
        >;
    };
};

property users

readonly users: {
    conversations: Method<
        UsersConversationsArguments,
        UsersConversationsResponse
    >;
    deletePhoto: Method<UsersDeletePhotoArguments, UsersDeletePhotoResponse>;
    getPresence: Method<UsersGetPresenceArguments, UsersGetPresenceResponse>;
    identity: Method<UsersIdentityArguments, UsersIdentityResponse>;
    info: Method<UsersInfoArguments, UsersInfoResponse>;
    list: Method<UsersListArguments, UsersListResponse>;
    lookupByEmail: Method<
        UsersLookupByEmailArguments,
        UsersLookupByEmailResponse
    >;
    setPhoto: Method<UsersSetPhotoArguments, UsersSetPhotoResponse>;
    setPresence: Method<UsersSetPresenceArguments, UsersSetPresenceResponse>;
    profile: {
        get: Method<UsersProfileGetArguments, UsersProfileGetResponse>;
        set: Method<UsersProfileSetArguments, UsersProfileSetResponse>;
    };
};

property views

readonly views: {
    open: Method<ViewsOpenArguments, ViewsOpenResponse>;
    publish: Method<ViewsPublishArguments, ViewsPublishResponse>;
    push: Method<ViewsPushArguments, ViewsPushResponse>;
    update: Method<ViewsUpdateArguments, ViewsUpdateResponse>;
};

property workflows

readonly workflows: {
    stepCompleted: Method<
        WorkflowsStepCompletedArguments,
        WorkflowsStepCompletedResponse
    >;
    stepFailed: Method<
        WorkflowsStepFailedArguments,
        WorkflowsStepFailedResponse
    >;
    updateStep: Method<
        WorkflowsUpdateStepArguments,
        WorkflowsUpdateStepResponse
    >;
};

method apiCall

abstract apiCall: (
    method: string,
    options?: WebAPICallOptions
) => Promise<WebAPICallResult>;

class WebClient

class WebClient extends Methods {}

A client for Slack's Web API
This client provides an alias for each Web API method. Each method is a convenience wrapper for calling the WebClient#apiCall method using the method name as the first parameter.

constructor

constructor(
    token?: string,
    {
        slackApiUrl,
        logger,
        logLevel,
        maxRequestConcurrency,
        retryConfig,
        agent,
        tls,
        timeout,
        rejectRateLimitedCalls,
        headers,
        teamId,
    }?: WebClientOptions
);

Parameter token
An API token to authenticate/authorize with Slack (usually start with xoxp, xoxb)

property slackApiUrl

readonly slackApiUrl: string;

The base URL for reaching Slack's Web API. Consider changing this value for testing purposes.

property token

readonly token?: string;

Authentication and authorization token for accessing Slack Web API (usually begins with xoxp or xoxb)

method apiCall

apiCall: (
    method: string,
    options?: WebAPICallOptions
) => Promise<WebAPICallResult>;

Generic method for calling a Web API method
Parameter method
the Web API method to call https://api.slack.com/methods
Parameter options
options

method paginate

paginate: {
    (
        method: string,
        options?: WebAPICallOptions
    ): AsyncIterable<WebAPICallResult>;
    (
        method: string,
        options: WebAPICallOptions,
        shouldStop: PaginatePredicate
    ): Promise<void>;
    <R extends PageReducer<any>, A extends PageAccumulator<R>>(
        method: string,
        options: WebAPICallOptions,
        shouldStop: PaginatePredicate,
        reduce?: PageReducer<A>
    ): Promise<A>;
};

Iterate over the result pages of a cursor-paginated Web API method. This method can return two types of values, depending on which arguments are used. When up to two parameters are used, the return value is an async iterator which can be used as the iterable in a for-await-of loop. When three or four parameters are used, the return value is a promise that resolves at the end of iteration. The third parameter, shouldStop, is a function that is called with each page and can end iteration by returning true. The fourth parameter, reduce, is a function that is called with three arguments: accumulator, page, and index. The accumulator is a value of any type you choose, but it will contain undefined when reduce is called for the first time. The page argument and index arguments are exactly what they say they are. The reduce function's return value will be passed in as accumulator the next time its called, and the returned promise will resolve to the last value of accumulator.
The for-await-of syntax is part of ES2018. It is available natively in Node starting with v10.0.0. You may be able to use it in earlier JavaScript runtimes by transpiling your source with a tool like Babel. However, the transpiled code will likely sacrifice performance.
Parameter method
the cursor-paginated Web API method to call https://api.slack.com/docs/pagination
Parameter options
options
Parameter shouldStop
a predicate that is called with each page, and should return true when pagination can end.
Parameter reduce
a callback that can be used to accumulate a value that the return promise is resolved to

Interfaces

interface AdminAppsApproveArguments

interface AdminAppsApproveArguments extends WebAPICallOptions, TokenOverridable {}

property app_id

app_id?: string;

property request_id

request_id?: string;

property team_id

team_id?: string;

interface AdminAppsApprovedListArguments

interface AdminAppsApprovedListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property enterprise_id

enterprise_id?: string;

property team_id

team_id?: string;

interface AdminAppsClearResolutionArguments

interface AdminAppsClearResolutionArguments extends WebAPICallOptions {}

property app_id

app_id: string;

property enterprise_id

enterprise_id?: string;

property team_id

team_id?: string;

interface AdminAppsRequestsCancelArguments

interface AdminAppsRequestsCancelArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property enterprise_id

enterprise_id?: string;

property request_id

request_id: string;

property team_id

team_id?: string;

interface AdminAppsRequestsListArguments

interface AdminAppsRequestsListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property team_id

team_id?: string;

interface AdminAppsRestrictArguments

interface AdminAppsRestrictArguments extends WebAPICallOptions, TokenOverridable {}

property app_id

app_id?: string;

property request_id

request_id?: string;

property team_id

team_id?: string;

interface AdminAppsRestrictedListArguments

interface AdminAppsRestrictedListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property enterprise_id

enterprise_id?: string;

property team_id

team_id?: string;

interface AdminAppsUninstallArguments

interface AdminAppsUninstallArguments extends WebAPICallOptions {}

property app_id

app_id: string;

property enterprise_id

enterprise_id?: string;

property team_ids

team_ids?: string[];

interface AdminAuthPolicyAssignEntitiesArguments

interface AdminAuthPolicyAssignEntitiesArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property entity_ids

entity_ids: string[];

property entity_type

entity_type: string;

property policy_name

policy_name: string;

interface AdminAuthPolicyGetEntitiesArguments

interface AdminAuthPolicyGetEntitiesArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property entity_type

entity_type?: string;

property policy_name

policy_name: string;

interface AdminAuthPolicyRemoveEntitiesArguments

interface AdminAuthPolicyRemoveEntitiesArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property entity_ids

entity_ids: string[];

property entity_type

entity_type: string;

property policy_name

policy_name: string;

interface AdminBarriersCreateArguments

interface AdminBarriersCreateArguments extends WebAPICallOptions, TokenOverridable {}

property barriered_from_usergroup_ids

barriered_from_usergroup_ids: string[];

property primary_usergroup_id

primary_usergroup_id: string;

property restricted_subjects

restricted_subjects: string[];

interface AdminBarriersDeleteArguments

interface AdminBarriersDeleteArguments extends WebAPICallOptions, TokenOverridable {}

property barrier_id

barrier_id: string;

interface AdminBarriersListArguments

interface AdminBarriersListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

interface AdminBarriersUpdateArguments

interface AdminBarriersUpdateArguments extends WebAPICallOptions, TokenOverridable {}

property barrier_id

barrier_id: string;

property barriered_from_usergroup_ids

barriered_from_usergroup_ids: string[];

property primary_usergroup_id

primary_usergroup_id: string;

property restricted_subjects

restricted_subjects: string[];

interface AdminConversationsArchiveArguments

interface AdminConversationsArchiveArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

interface AdminConversationsConvertToPrivateArguments

interface AdminConversationsConvertToPrivateArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

interface AdminConversationsCreateArguments

interface AdminConversationsCreateArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property description

description?: string;

property is_private

is_private: boolean;

property name

name: string;

property org_wide

org_wide?: boolean;

property team_id

team_id?: string;

interface AdminConversationsDeleteArguments

interface AdminConversationsDeleteArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

interface AdminConversationsDisconnectSharedArguments

interface AdminConversationsDisconnectSharedArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

property leaving_team_ids

leaving_team_ids?: string[];

interface AdminConversationsEKMListOriginalConnectedChannelInfoArguments

interface AdminConversationsEKMListOriginalConnectedChannelInfoArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property channel_ids

channel_ids?: string[];

property team_ids

team_ids?: string[];

interface AdminConversationsGetConversationPrefsArguments

interface AdminConversationsGetConversationPrefsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

interface AdminConversationsGetCustomRetentionArguments

interface AdminConversationsGetCustomRetentionArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

interface AdminConversationsGetTeamsArguments

interface AdminConversationsGetTeamsArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property channel_id

channel_id: string;

interface AdminConversationsInviteArguments

interface AdminConversationsInviteArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

property user_ids

user_ids: string[];

interface AdminConversationsRemoveCustomRetentionArguments

interface AdminConversationsRemoveCustomRetentionArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

interface AdminConversationsRenameArguments

interface AdminConversationsRenameArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

property name

name: string;

interface AdminConversationsRestrictAccessAddGroupArguments

interface AdminConversationsRestrictAccessAddGroupArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

property group_id

group_id: string;

property team_id

team_id?: string;

interface AdminConversationsRestrictAccessListGroupsArguments

interface AdminConversationsRestrictAccessListGroupsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

property team_id

team_id?: string;

interface AdminConversationsRestrictAccessRemoveGroupArguments

interface AdminConversationsRestrictAccessRemoveGroupArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

property group_id

group_id: string;

property team_id

team_id: string;

interface AdminConversationsSearchArguments

interface AdminConversationsSearchArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property query

query?: string;

property search_channel_types

search_channel_types?: string[];

property sort

sort?: 'relevant' | 'name' | 'member_count' | 'created';

property sort_dir

sort_dir?: 'asc' | 'desc';

property team_ids

team_ids?: string[];

interface AdminConversationsSetConversationPrefsArguments

interface AdminConversationsSetConversationPrefsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

property prefs

prefs: Record<string, unknown>;

interface AdminConversationsSetCustomRetentionArguments

interface AdminConversationsSetCustomRetentionArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

property duration_days

duration_days: number;

interface AdminConversationsSetTeamsArguments

interface AdminConversationsSetTeamsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

property org_channel

org_channel?: boolean;

property target_team_ids

target_team_ids?: string[];

property team_id

team_id?: string;

interface AdminConversationsUnarchiveArguments

interface AdminConversationsUnarchiveArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_id

channel_id: string;

interface AdminEmojiAddAliasArguments

interface AdminEmojiAddAliasArguments extends WebAPICallOptions, TokenOverridable {}

property alias_for

alias_for: string;

property name

name: string;

interface AdminEmojiAddArguments

interface AdminEmojiAddArguments extends WebAPICallOptions, TokenOverridable {}

property name

name: string;

property url

url: string;

interface AdminEmojiListArguments

interface AdminEmojiListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

interface AdminEmojiRemoveArguments

interface AdminEmojiRemoveArguments extends WebAPICallOptions, TokenOverridable {}

property name

name: string;

interface AdminEmojiRenameArguments

interface AdminEmojiRenameArguments extends WebAPICallOptions, TokenOverridable {}

property name

name: string;

property new_name

new_name: string;

interface AdminInviteRequestsApproveArguments

interface AdminInviteRequestsApproveArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property invite_request_id

invite_request_id: string;

property team_id

team_id: string;

interface AdminInviteRequestsApprovedListArguments

interface AdminInviteRequestsApprovedListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property team_id

team_id: string;

interface AdminInviteRequestsDeniedListArguments

interface AdminInviteRequestsDeniedListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property team_id

team_id: string;

interface AdminInviteRequestsDenyArguments

interface AdminInviteRequestsDenyArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property invite_request_id

invite_request_id: string;

property team_id

team_id: string;

interface AdminInviteRequestsListArguments

interface AdminInviteRequestsListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property team_id

team_id: string;

interface AdminTeamsAdminsListArguments

interface AdminTeamsAdminsListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property team_id

team_id: string;

interface AdminTeamsCreateArguments

interface AdminTeamsCreateArguments extends WebAPICallOptions, TokenOverridable {}

property team_description

team_description?: string;

property team_discoverability

team_discoverability?: string;

property team_domain

team_domain: string;

property team_name

team_name: string;

interface AdminTeamsListArguments

interface AdminTeamsListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

interface AdminTeamsOwnersListArguments

interface AdminTeamsOwnersListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property team_id

team_id: string;

interface AdminTeamsSettingsInfoArguments

interface AdminTeamsSettingsInfoArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property team_id

team_id: string;

interface AdminTeamsSettingsSetDefaultChannelsArguments

interface AdminTeamsSettingsSetDefaultChannelsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_ids

channel_ids: string[];

property team_id

team_id: string;

interface AdminTeamsSettingsSetDescriptionArguments

interface AdminTeamsSettingsSetDescriptionArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property description

description: string;

property team_id

team_id: string;

interface AdminTeamsSettingsSetDiscoverabilityArguments

interface AdminTeamsSettingsSetDiscoverabilityArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property discoverability

discoverability: 'open' | 'invite_only' | 'closed' | 'unlisted';

property team_id

team_id: string;

interface AdminTeamsSettingsSetIconArguments

interface AdminTeamsSettingsSetIconArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property image_url

image_url: string;

property team_id

team_id: string;

interface AdminTeamsSettingsSetNameArguments

interface AdminTeamsSettingsSetNameArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property name

name: string;

property team_id

team_id: string;

interface AdminUsergroupsAddChannelsArguments

interface AdminUsergroupsAddChannelsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_ids

channel_ids: string | string[];

property team_id

team_id?: string;

property usergroup_id

usergroup_id: string;

interface AdminUsergroupsAddTeamsArguments

interface AdminUsergroupsAddTeamsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property auto_provision

auto_provision?: boolean;

property team_ids

team_ids: string | string[];

property usergroup_id

usergroup_id: string;

interface AdminUsergroupsListChannelsArguments

interface AdminUsergroupsListChannelsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property include_num_members

include_num_members?: boolean;

property team_id

team_id?: string;

property usergroup_id

usergroup_id: string;

interface AdminUsergroupsRemoveChannelsArguments

interface AdminUsergroupsRemoveChannelsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property channel_ids

channel_ids: string | string[];

property usergroup_id

usergroup_id: string;

interface AdminUsersAssignArguments

interface AdminUsersAssignArguments extends WebAPICallOptions, TokenOverridable {}

property is_restricted

is_restricted?: boolean;

property is_ultra_restricted

is_ultra_restricted?: boolean;

property team_id

team_id: string;

property user_id

user_id: string;

interface AdminUsersInviteArguments

interface AdminUsersInviteArguments extends WebAPICallOptions, TokenOverridable {}

property channel_ids

channel_ids: string;

property custom_message

custom_message?: string;

property email

email: string;

property email_password_policy_enabled

email_password_policy_enabled?: boolean;

property guest_expiration_ts

guest_expiration_ts?: string;

property is_restricted

is_restricted?: boolean;

property is_ultra_restricted

is_ultra_restricted?: boolean;

property real_name

real_name?: string;

property resend

resend?: boolean;

property team_id

team_id: string;

interface AdminUsersListArguments

interface AdminUsersListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property team_id

team_id: string;

interface AdminUsersRemoveArguments

interface AdminUsersRemoveArguments extends WebAPICallOptions, TokenOverridable {}

property team_id

team_id: string;

property user_id

user_id: string;

interface AdminUsersSessionClearSettingsArguments

interface AdminUsersSessionClearSettingsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property user_ids

user_ids: string[];

interface AdminUsersSessionGetSettingsArguments

interface AdminUsersSessionGetSettingsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property user_ids

user_ids: string[];

interface AdminUsersSessionInvalidateArguments

interface AdminUsersSessionInvalidateArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property session_id

session_id: string;

property team_id

team_id: string;

interface AdminUsersSessionListArguments

interface AdminUsersSessionListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property team_id

team_id?: string;

property user_id

user_id?: string;

interface AdminUsersSessionResetArguments

interface AdminUsersSessionResetArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property mobile_only

mobile_only?: boolean;

property user_id

user_id: string;

property web_only

web_only?: boolean;

interface AdminUsersSessionResetBulkArguments

interface AdminUsersSessionResetBulkArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property mobile_only

mobile_only?: boolean;

property user_ids

user_ids: string[];

property web_only

web_only?: boolean;

interface AdminUsersSessionSetSettingsArguments

interface AdminUsersSessionSetSettingsArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property desktop_app_browser_quit

desktop_app_browser_quit?: boolean;

property duration

duration?: number;

property user_ids

user_ids: string[];

interface AdminUsersSetAdminArguments

interface AdminUsersSetAdminArguments extends WebAPICallOptions, TokenOverridable {}

property team_id

team_id: string;

property user_id

user_id: string;

interface AdminUsersSetExpirationArguments

interface AdminUsersSetExpirationArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property expiration_ts

expiration_ts: number;

property team_id

team_id: string;

property user_id

user_id: string;

interface AdminUsersSetOwnerArguments

interface AdminUsersSetOwnerArguments extends WebAPICallOptions, TokenOverridable {}

property team_id

team_id: string;

property user_id

user_id: string;

interface AdminUsersSetRegularArguments

interface AdminUsersSetRegularArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property team_id

team_id: string;

property user_id

user_id: string;

interface AdminUsersUnsupportedVersionsExportArguments

interface AdminUsersUnsupportedVersionsExportArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property date_end_of_support

date_end_of_support?: number;

property date_sessions_started

date_sessions_started?: number;

interface APITestArguments

interface APITestArguments extends WebAPICallOptions {}

interface AppsConnectionsOpenArguments

interface AppsConnectionsOpenArguments extends WebAPICallOptions {}

interface AppsEventAuthorizationsListArguments

interface AppsEventAuthorizationsListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property event_context

event_context: string;

interface AppsUninstallArguments

interface AppsUninstallArguments extends WebAPICallOptions {}

property client_id

client_id: string;

property client_secret

client_secret: string;

interface AuthRevokeArguments

interface AuthRevokeArguments extends WebAPICallOptions, TokenOverridable {}

property test

test: boolean;

interface AuthTeamsListArguments

interface AuthTeamsListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property include_icon

include_icon?: boolean;

interface AuthTestArguments

interface AuthTestArguments extends WebAPICallOptions, TokenOverridable {}

interface BookmarksAddArguments

interface BookmarksAddArguments extends WebAPICallOptions, TokenOverridable {}

property channel_id

channel_id: string;

property emoji

emoji?: string;

property entity_id

entity_id?: string;

property link

link?: string;

property parent_id

parent_id?: string;

property title

title: string;

property type

type: string;

interface BookmarksEditArguments

interface BookmarksEditArguments extends WebAPICallOptions, TokenOverridable {}

property bookmark_id

bookmark_id: string;

property channel_id

channel_id: string;

property emoji

emoji?: string;

property link

link?: string;

property title

title?: string;

interface BookmarksListArguments

interface BookmarksListArguments extends WebAPICallOptions, TokenOverridable {}

property channel_id

channel_id: string;

interface BookmarksRemoveArguments

interface BookmarksRemoveArguments extends WebAPICallOptions, TokenOverridable {}

property bookmark_id

bookmark_id: string;

property channel_id

channel_id: string;

interface BotsInfoArguments

interface BotsInfoArguments extends WebAPICallOptions, TokenOverridable {}

property bot

bot?: string;

property team_id

team_id?: string;

interface CallsAddArguments

interface CallsAddArguments extends WebAPICallOptions, TokenOverridable {}

property created_by

created_by?: string;

property date_start

date_start?: number;

property desktop_app_join_url

desktop_app_join_url?: string;

property external_display_id

external_display_id?: string;

property external_unique_id

external_unique_id: string;

property join_url

join_url: string;

property title

title?: string;

property users

users?: CallUser[];

interface CallsEndArguments

interface CallsEndArguments extends WebAPICallOptions, TokenOverridable {}

property duration

duration?: number;

property id

id: string;

interface CallsInfoArguments

interface CallsInfoArguments extends WebAPICallOptions, TokenOverridable {}

property id

id: string;

interface CallsParticipantsAddArguments

interface CallsParticipantsAddArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property id

id: string;

property users

users: CallUser[];

interface CallsParticipantsRemoveArguments

interface CallsParticipantsRemoveArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property id

id: string;

property users

users: CallUser[];

interface CallsUpdateArguments

interface CallsUpdateArguments extends WebAPICallOptions, TokenOverridable {}

property desktop_app_join_url

desktop_app_join_url?: string;

property id

id: string;

property join_url

join_url?: string;

property title

title?: string;

interface ChannelsArchiveArguments

interface ChannelsArchiveArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

interface ChannelsCreateArguments

interface ChannelsCreateArguments extends WebAPICallOptions, TokenOverridable {}

property name

name: string;

property team_id

team_id?: string;

property validate

validate?: boolean;

interface ChannelsHistoryArguments

interface ChannelsHistoryArguments
    extends WebAPICallOptions,
        TokenOverridable,
        TimelinePaginationEnabled {}

property channel

channel: string;

property count

count?: number;

property unreads

unreads?: boolean;

interface ChannelsInfoArguments

interface ChannelsInfoArguments
    extends WebAPICallOptions,
        TokenOverridable,
        LocaleAware {}

property channel

channel: string;

interface ChannelsInviteArguments

interface ChannelsInviteArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

property user

user: string;

interface ChannelsJoinArguments

interface ChannelsJoinArguments extends WebAPICallOptions, TokenOverridable {}

property name

name: string;

property validate

validate?: boolean;

interface ChannelsKickArguments

interface ChannelsKickArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

property user

user: string;

interface ChannelsLeaveArguments

interface ChannelsLeaveArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

interface ChannelsListArguments

interface ChannelsListArguments
    extends WebAPICallOptions,
        TokenOverridable,
        CursorPaginationEnabled {}

property exclude_archived

exclude_archived?: boolean;

property exclude_members

exclude_members?: boolean;

property team_id

team_id?: string;

interface ChannelsMarkArguments

interface ChannelsMarkArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

property ts

ts: string;

interface ChannelsRenameArguments

interface ChannelsRenameArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

property name

name: string;

property validate

validate?: boolean;

interface ChannelsRepliesArguments

interface ChannelsRepliesArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

property thread_ts

thread_ts: string;

interface ChannelsSetPurposeArguments

interface ChannelsSetPurposeArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

property purpose

purpose: string;

interface ChannelsSetTopicArguments

interface ChannelsSetTopicArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

property topic

topic: string;

interface ChannelsUnarchiveArguments

interface ChannelsUnarchiveArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

interface ChatDeleteArguments

interface ChatDeleteArguments extends WebAPICallOptions, TokenOverridable {}

property as_user

as_user?: boolean;

property channel

channel: string;

property ts

ts: string;

interface ChatDeleteScheduledMessageArguments

interface ChatDeleteScheduledMessageArguments
    extends WebAPICallOptions,
        TokenOverridable {}

property as_user

as_user?: boolean;

property channel

channel: string;

property scheduled_message_id

scheduled_message_id: string;

interface ChatGetPermalinkArguments

interface ChatGetPermalinkArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

property message_ts

message_ts: string;

interface ChatMeMessageArguments

interface ChatMeMessageArguments extends WebAPICallOptions, TokenOverridable {}

property channel

channel: string;

property text

text: string;

interface ChatPostEphemeralArguments

interface ChatPostEphemeralArguments extends WebAPICallOptions, TokenOverridable {}

property as_user

as_user?: boolean;

property attachments

attachments?: MessageAttachment[];

property blocks

blocks?: (KnownBlock | Block)[];

property channel

channel: string;

property icon_emoji

icon_emoji?: string;

property icon_url

icon_url?: string;

property link_names

link_names?: boolean;

property parse

parse?: 'full' | 'none';

property text

text?: string;

property thread_ts

thread_ts?: string;

property user

user: string;

property username

username?: string;

interface ChatPostMessageArguments

interface ChatPostMessageArguments extends WebAPICallOptions, TokenOverridable {}

property as_user

as_user?: boolean;

property attachments

attachments?: MessageAttachment[];

property blocks

blocks?: (KnownBlock | Block)[];

property channel

channel: string;

property icon_emoji

icon_emoji?: string;

@slack/web-api

Install

Overview

Index

Variables

Functions

Classes

Interfaces

Enums

Type Aliases

Variables

variable cursorPaginationEnabledMethods

variable retryPolicies

Functions

function addAppMetadata

Parameter

Parameter

Classes

class Methods

constructor

property admin

property api

property apps

property auth

property bookmarks

property bots

property calls

property channels

property chat

property conversations

property dialog

property dnd

property emoji

property files

property groups

property im

property migration

property mpim

property oauth

property openid

property pins

property reactions

property reminders

property rtm

property search

property stars

property team

property usergroups

property users

property views

property workflows

method apiCall

class WebClient

constructor

Parameter token

property slackApiUrl

property token

method apiCall

Parameter method

Parameter options

method paginate

Parameter method

Parameter options

Parameter shouldStop

Parameter reduce

Interfaces

interface AdminAppsApproveArguments

property app_id

property request_id

property team_id

interface AdminAppsApprovedListArguments

property enterprise_id

property team_id

interface AdminAppsClearResolutionArguments

property app_id

property enterprise_id

property team_id

interface AdminAppsRequestsCancelArguments

property enterprise_id

property request_id