Skip to main content

A simple Django app to integrates with https://www.tawk.to/ chat.

Project description

django-tawkto

django-tawkto is a simple Django app to it integrates with https://www.tawk.to/ chat.

Requirements

Python 3.7 to 3.10 supported.

Django 2.2 to 4.0 supported.

Quick start

Install the stable release from pypi (using pip):

pip install django-tawkto

Add tawkto to your INSTALLED_APPS setting like this:

INSTALLED_APPS = [
    ...
    'tawkto',
]

Add TAWKTO_ID_SITE in settings.py:

TAWKTO_ID_SITE='<tawkto id site>'

(Optional) Add TAWKTO_API_KEY:

TAWKTO_API_KEY='<tawkto api key>'

(Optional) For secure site (requires TAWKTO_API_KEY):

TAWKTO_IS_SECURE=True

In HTML:

{% load tawkto_tags %}

<!DOCTYPE html>
<html lang="en">
<head>
    ...
</head>
<body>
    ...
    {% tawkto_script %}
</body>
</html>

(Optional) Add visitor name and email:

{% tawkto_script user_name=request.user.get_full_name user_email=request.user.email %}

(Optional) Use a different widget for a given property (default is the default value):

TAWKTO_WIDGET_ID = "default"

or

{% tawkto_script widget_id='somewidgetid' %}

(Optional) Use a different tawkto property:

{% tawkto_script id_site='tawktosideit' api_key='tawktoapikey'%}

(Optional) If you want to hide the chat for superuser (default is True):

TAWKTO_EXCLUDE_SUPERUSERS = True

(Optional) Set custom metadata regarding this chat/visitor:

  • is_secure must be True.
  • You must provide a valid email.
  • Metadata is represented by key and value.
  • The key is of the string data type and can contain only alphanumeric characters and ‘-‘ (dash).
  • More in https://developer.tawk.to/jsapi/ setAttributes section.
# view.py
def view(request):
    context = {'metadata': {'attr-1': 'value1', 'attr-2': 'value2'}}
    return render(request, 'template.html', context)

In template:

{% tawkto_script is_secure=True user_email=example@example.com extra_attributes=metadata %}

metadata-image

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-tawkto-0.5.1.tar.gz (4.6 kB view hashes)

Uploaded source

Built Distribution

django_tawkto-0.5.1-py3-none-any.whl (5.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page