Skip to main content

Sendgrid Mail tracking for Django, store sendgrid tracking info into django models.

Project description

Django Sendgrid Tracking

Travis codecov Python Versions PyPI Version MIT licensed Documentation Status

Sendgrid Mail tracking for Django, store sendgrid tracking info into django models.

This library allows to track the email sent using Sendgrid by storing information collected from a webhook into django models.

Table of Contents

Installation

Prerequisites

  • Python version 3.6+

  • Sendgrid account and API configuration

Environment Variables

This library uses django-sendgrid-v5 which requires the following in your settings.py:

EMAIL_BACKEND = "sendgrid_backend.SendgridBackend"
SENDGRID_API_KEY = os.environ["SENDGRID_API_KEY"]

You can find more information and other settings here

Install package

Install the library with pip

$ pip install django-sendgrid-tracking

Quick Start

Below the steps to start using django-sendgrid-tracking in your django project using your sendgrid account.

Enable django

To enable django_sendgrid_tracking in your project you to add it to INSTALLED_APPS in your projects settings.py file

INSTALLED_APPS = (
    ...
    'django_sendgrid_tracking'
    ...
)

Run django migrate to create django-sendgrid-tracking related models

$ python manage.py migrate

In addition to that you need to expose for sendgrid the webhook endpoint

from django.conf.urls import url
from django_sendgrid_tracking import views

...
urlpatterns = [
    ...
    url(r'sendgrid_webhook', views.event_hooks, name='sendgrid_webhook'),
    ...
]

Enable sendgrid

Now you need to provide this endpoint URL to Sendgrid from the console (Setting -> Mail Settings -> Event WebHook):

sendgrid-webhook-configuration

In this case your webhook would be available at http://www.mywebsite.com/sendgrid_webhook/ N.B. remember to append a slash at the end of it since it will be a POST request

Use cases

The most simple use case would be to analyse internal statics or troubleshoot pitfall in the application flow. As an example we can see for which reason a particular user didn’t confirm the email address

e.g.

sent_email = SentMail.object.filter(
    to_email__mail=user.mail,
    categories__category_code='confirm_email'
)
print(sent_email.open_flag)
# True the user opened the email
print(sent_email.click_flag)
# False the user didn't click on the confirmation link
# Maybe something is wrong with the content of the email?

Another use case is in the case of referral program we can show the user the status of the sent invitation

e.g.

use-case-referral

(example from https://www.omologherifiuti.it)

About

django-sendgrid-tracking is a library extracted from different website implemented by the author in django

If you’ve instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

Any contribution is appreciated!! (see CONTRIBUTING)

License

The MIT License (MIT)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-sendgrid-tracking-1.0.6.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

django_sendgrid_tracking-1.0.6-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file django-sendgrid-tracking-1.0.6.tar.gz.

File metadata

  • Download URL: django-sendgrid-tracking-1.0.6.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.9

File hashes

Hashes for django-sendgrid-tracking-1.0.6.tar.gz
Algorithm Hash digest
SHA256 d02ed36b49a20f7782120f996a1421e4bd7882a71ac439db36a6d4c94e655623
MD5 efe71b3957af9d45871f180155b989b4
BLAKE2b-256 0d089f017c366a794ef59adc0e929a105852559f41b910d412b9885ca3555e26

See more details on using hashes here.

File details

Details for the file django_sendgrid_tracking-1.0.6-py3-none-any.whl.

File metadata

  • Download URL: django_sendgrid_tracking-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.9

File hashes

Hashes for django_sendgrid_tracking-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ab914c4c94881575dbcb7f4f983b0877d08185f6b14731301b0fcf94e258d959
MD5 a4319904090d2e0b40078eeaa327de39
BLAKE2b-256 3927d19d079771b14c45cb7fe502730516c2376987ddfea98fc8641d27c749c1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page