Skip to main content

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 slack-api-sdk-apimatic==1.1.2

You can also view the package at: https://pypi.python.org/pypi/slack-api-sdk-apimatic/1.1.2

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 30
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
authorization_code_auth_credentials AuthorizationCodeAuthCredentials The credential object for OAuth 2 Authorization Code Grant

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

Name Description
PRODUCTION Default

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for slack-api-sdk-apimatic 1.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for slack-api-sdk-apimatic 1.1.2
File Size Uploaded Provenance Actions
slack_api_sdk_apimatic-1.1.2.tar.gz 141.8 kB Without provenance Details for slack_api_sdk_apimatic-1.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for slack-api-sdk-apimatic 1.1.2
File Interpreter ABI Platform Actions
slack_api_sdk_apimatic-1.1.2-py3-none-any.whl Python 3 none any Details for slack_api_sdk_apimatic-1.1.2-py3-none-any.whl

Total release size: 703.7 kB

Release files / slack_api_sdk_apimatic-1.1.2.tar.gz

Download URL slack_api_sdk_apimatic-1.1.2.tar.gz
Size 141.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7a747ba952e38757bc84a51146cc179d1f092c1a5aa57737bf20bd8046b015d6
BLAKE2b-256 checksum
How to use checksums
8d39257d3c070227ab6b0a4396995a528b89ab769e3be465157d68fa0290166b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / slack_api_sdk_apimatic-1.1.2-py3-none-any.whl

Download URL slack_api_sdk_apimatic-1.1.2-py3-none-any.whl
Size 561.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9f9a506f771a92f808f5fc31db225233aea0555c11357dcd67b33c84eebade4d
BLAKE2b-256 checksum
How to use checksums
cec13033d7b674eefac028e1e779da7d697e75d987ea9aa1510bb62b8b479e09
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for slack-api-sdk-apimatic 1.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.1.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page