Skip to main content

Django integration for Intercom API

Project description

travis coveralls requiresio

Django integration for Intercom API

Installation

To use you need to add aa_intercom to your INSTALLED_APPS, and then migrate the project.

Setting up user model

aa-intercom requires a few fields in the user model to be set. To make it work, you need to apply the aa_intercom.mixins.IntercomUserMixin to your custom user model (if you do not have your own custom user model set, check the documentation).

Configuration

The last thing is to specify Intercom credentials

INTERCOM_APP_ID = "your app id"
INTERCOM_ID_PREFIX = ''
INTERCOM_API_ACCESS_TOKEN = 'your api key'

Make sure, you have the CACHES set (see: docs), and also as this app uses Celery, you need to have it configured.

Commands

aa-intercom provides a few useful management commands, which should be run chronically:

  • resend_intercom_events - resends all events in case something went wrong

  • update_intercom_users - push all users to the Intercom API

Support

  • Django 1.11

  • Python 2.7, 3.6

Project details


Supported by

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