django-slack Integration

5.19.0 · active · verified Fri Apr 17

django-slack provides easy-to-use integration between Django projects and the Slack group chat and IM tool. It simplifies sending messages and notifications to Slack channels. Currently at version 5.19.0, it is actively maintained with regular updates, typically released multiple times a year to follow Django versions or introduce new features and fixes.

Common errors

```
ModuleNotFoundError: No module named 'django_slack'
```
cause Attempting to import from the old package name 'django_slack' after upgrading to version 4.0.0 or later.

fix Change all imports from `from django_slack import ...` to `from slack import ...` (e.g., `from slack import slack_message`).
```
ImproperlyConfigured: Either SLACK_TOKEN or SLACK_WEBHOOK_URL must be defined in your settings.
```
cause Neither a Slack API token nor an incoming webhook URL has been configured in your Django settings.

fix Add `SLACK_TOKEN = 'xoxb-YOUR-SLACK-BOT-TOKEN'` or `SLACK_WEBHOOK_URL = 'https://hooks.slack.com/services/...'` to your `settings.py`.
```
AttributeError: module 'slack.signals' has no attribute 'slack_message_pre_send'
```
cause You are trying to connect to a signal that was removed or renamed in django-slack version 5.0.0.

fix Update your signal connections to use the new `slack.signals.message_sending` or `slack.signals.message_sent` signals. Consult the documentation for their updated signatures.
```
requests.exceptions.ConnectionError: HTTPSConnectionPool(host='hooks.slack.com', port=443): Max retries exceeded with url: ...
```
cause Indicates a network issue, an incorrect `SLACK_WEBHOOK_URL` or `SLACK_TOKEN`, or a firewall blocking outbound requests to Slack.

fix Verify your `SLACK_WEBHOOK_URL` or `SLACK_TOKEN` is correct. Check network connectivity from your server to Slack. Ensure no firewall rules are preventing outgoing HTTPS connections to `hooks.slack.com` or `slack.com`.

Warnings

breaking The `slack.signals.slack_message_pre_send` and `slack.signals.slack_message_post_send` signals were removed in version 5.0.0.
Fix: Migrate to the new `slack.signals.message_sending` and `slack.signals.message_sent` signals, which provide similar functionality with a different signature. Review the official documentation for updated signal usage.
breaking The `SLACK_INCOMING_WEBHOOK_URL` setting was renamed to `SLACK_WEBHOOK_URL` for consistency in version 5.0.0.
Fix: Update your `settings.py` to use `SLACK_WEBHOOK_URL`. The old setting might still work as a fallback but is considered deprecated.
gotcha The primary import path for modules changed from `django_slack` to `slack` in version 4.0.0.
Fix: Ensure all imports use `from slack import ...` (e.g., `from slack import slack_message`) instead of `from django_slack import ...`.
gotcha Understanding the difference between `SLACK_TOKEN` and `SLACK_WEBHOOK_URL` is crucial for correct setup.
Fix: `SLACK_WEBHOOK_URL` is for incoming webhooks (simpler setup, limited features), while `SLACK_TOKEN` is for using the full Slack Web API (requires an app token, provides more control). Choose based on your integration needs and configure the respective setting in `settings.py`.

Install

pip install django-slack Install stable version

Imports

slack_message
wrong:
```
from django_slack import slack_message
```
correct:
```
from slack import slack_message
```
The primary function for sending messages; import path changed from 'django_slack' in older versions.
slack_notify
```
from slack.api import slack_notify
```
A lower-level function for sending messages, typically used when direct API calls are preferred over the high-level 'slack_message' which can use webhooks or tokens.
Message
```
from slack.messages import Message
```
Used for constructing structured Slack message objects programmatically.

Quickstart

This quickstart demonstrates how to send a simple Slack message. It includes a minimal Django settings configuration to make the snippet runnable outside of a full Django project (e.g., as a standalone script). In a real Django project, ensure 'slack' is in `INSTALLED_APPS` and `SLACK_WEBHOOK_URL` (or `SLACK_TOKEN`) is defined in your `settings.py`.

import os
from django.conf import settings
import django

# Configure Django settings minimally for a standalone script
# In a full Django project, these settings would be in your settings.py
if not settings.configured:
    settings.configure(
        INSTALLED_APPS=['slack'],
        # Replace with your actual Slack Incoming Webhook URL
        # or SLACK_TOKEN if using the full API
        SLACK_WEBHOOK_URL=os.environ.get(
            'SLACK_WEBHOOK_URL',
            'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX' # Placeholder URL
        ),
        # A secret key is required by Django for settings.configure
        SECRET_KEY='a-secret-key-for-demo-purposes-only',
        DEBUG=True,
        # Minimal database and timezone settings for django.setup() to work
        DATABASES={'default': {'ENGINE': 'django.db.backends.sqlite3', 'NAME': ':memory:',}},
        USE_TZ=True,
        TIME_ZONE='UTC',
    )
    django.setup()

from slack import slack_message

# Send a simple message to a specific Slack channel
# Ensure the channel exists and your webhook/token has permissions
slack_message(
    text='Hello from Django-Slack! This is a quickstart test message.',
    channel='#general', # Replace with your target channel name
    username='DjangoBot',
    icon_emoji=':rocket:'
)

print("Attempted to send message to Slack. Check your configured channel.")
# Note: Actual delivery depends on correct Slack configuration and network access.

view raw JSON →