Extension GC Notify Integration


Extension Basics

Title
GC Notify Integration
Name
ckanext-gcnotify
Type
Public extension
Description
CKAN Extension for GC Notify integration. Enables sending notifications through the Canadian Government GC Notify service.
CKAN versions
Download-Url (zip)
Last commit
6 months ago (2025-09-05 17:28:03)
Url to repo
Category
Content Management


Background Infos

Description (long)
Show details

ckanext-gcnotify

CKAN Extension for GC Notify integration.

Requirements

Compatibility with core CKAN versions:

CKAN version Compatible?
2.6 and earlier Not tested
2.7 Not tested
2.8 No
2.9 Yes
3.0 and later Yes

Installation

To install ckanext-gcnotify:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Clone the source and install it on the virtualenv:

    git clone --branch master --single-branch https://github.com/open-data/ckanext-gcnotify.git
    cd ckanext-gcnotify
    pip install -e .
    pip install -r requirements.txt
    
  3. Add gcnotify to the ckan.plugins setting in your CKAN config file

  4. Add ckanext.gcnotify.secret_key setting in your CKAN config file with the value of your GC Notify secret key (last 5 hex groups of your API key)

  5. Add ckanext.gcnotify.base_url setting in your CKAN config file with the value of your GC Notify base URI

  6. Add ckanext.gcnotify.template_ids setting in your CKAN config file with the values of your GC Notify template IDs in a dict (key is email action and value is template ID)

  7. Restart CKAN

Config settings

# GC Notify Secret key (required, default: None)
ckanext.gcnotify.secret_key = my_secret_key

# GC Notify base URI (required, default: None)
ckanext.gcnotify.base_url = my_base_uri

# GC Notify template IDs (required, default: None)
ckanext.gcnotify.template_ids = {
  "send_reset_link":"template_id",
  "send_invite":"template_id",
  "new_user_admin_note":"template_id",
  "new_user_note":"template_id",
  "send_username_recovery":"template_id"}

License

MIT

Version
Version release date
(not set)
Contact name
Open Government Initiative - Government of Canada
Contakt email
(not set)
Contact Url


Installation Guide

Configuration hints

Requires GC Notify API key and template IDs. Used for password reset, user invites, and admin notifications in Canadian government context.

Plugins to configure (ckan.ini)
gcnotify
CKAN Settings (ckan.ini)
# ckanext.gcnotify.secret_key = my_secret_key
# ckanext.gcnotify.base_url = my_base_uri
# ckanext.gcnotify.template_ids = {"send_reset_link":"template_id","send_invite":"template_id","new_user_admin_note":"template_id","new_user_note":"template_id","send_username_recovery":"template_id"}
DB migration to be executed
(not set)
<< back to Extensions