graphene-django/docs/subscriptions.rst

Subscriptions

The graphene-django project does not currently support GraphQL subscriptions out of the box. However, there are several community-driven modules for adding subscription support, and the provided GraphiQL interface supports running subscription operations over a websocket.

To implement websocket-based support for GraphQL subscriptions, you’ll need to do the following:

1. Install and configure django-channels.
2. Install and configure* a third-party module for adding subscription support over websockets. A few options include:
   • graphql-python/graphql-ws
   • datavance/django-channels-graphql-ws
   • jaydenwindle/graphene-subscriptions
3. Ensure that your application (or at least your GraphQL endpoint) is being served via an ASGI protocol server like daphne (built in to django-channels), uvicorn, or hypercorn.

Once your application is properly configured to handle subscriptions, you can use the GraphiQL interface to test subscriptions like any other operation.