Getting Started with Slack Web API

Introduction

One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes.

Learn more about the Slack Web API: https://api.slack.com/web

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install slackapi-sdk==1.0.1

You can also view the package at: https://pypi.python.org/pypi/slackapi-sdk/1.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from slackwebapi.configuration import Environment
from slackwebapi.http.auth.oauth_2 import AuthorizationCodeAuthCredentials
from slackwebapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from slackwebapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from slackwebapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from slackwebapi.models.oauth_scope import OauthScope
from slackwebapi.slackwebapi_client import SlackwebapiClient

client = SlackwebapiClient(
    authorization_code_auth_credentials=AuthorizationCodeAuthCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_redirect_uri='OAuthRedirectUri',
        oauth_scopes=[
            OauthScope.ADMIN,
            OauthScope.ADMIN_APPSREAD
        ]
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from slackwebapi.slackwebapi_client import SlackwebapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = SlackwebapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses the following authentication schemes.

• slackAuth (OAuth 2 Authorization Code Grant)

List of APIs

• Admin Apps
• Admin Apps Approved
• Admin Apps Requests
• Admin Apps Restricted
• Admin Conversations
• Admin Conversations Ekm
• Admin Conversations Restrict Access
• Admin Emoji
• Admin Invite Requests
• Admin Invite Requests Approved
• Admin Invite Requests Denied
• Admin Teams Admins
• Admin Teams
• Admin Teams Owners
• Admin Teams Settings
• Admin Usergroups
• Admin Users
• Admin Users Session
• Api
• Apps Event Authorizations
• Apps Permissions
• Apps Permissions Resources
• Apps Permissions Scopes
• Apps Permissions Users
• Apps
• Auth
• Bots
• Calls
• Calls Participants
• Chat
• Chat Scheduled Messages
• Conversations
• Dialog
• Dnd
• Emoji
• Files Comments
• Files
• Files Remote
• Migration
• Oauth
• Oauth V 2
• Pins
• Reactions
• Reminders
• Rtm
• Search
• Stars
• Team
• Team Profile
• Usergroups
• Usergroups Users
• Users
• Users Profile
• Views
• Workflows

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime