aasaanjobs-notificationhub

Python Aasaanjobs/Waahjobs NotificationHub Client

Python SDK to communicate with Aasaanjobs/Waahjobs Notification Hub and send notifications to users.

Supported Notification Channels

• Short Messaging Service (SMS)
• Email
• WhatsApp
• Mobile Push (FCM)

Installation

pip install aasaanjobs-notificationhub

Usage

Each notification is referred to as Task in this library. A single Task can contain multiple channels, i.e., a single Task can contain both Email and WhatsApp notification data. This Task is then validated via Protocol Buffers and pushed to corresponding Notification Hub Amazon SQS queue.

For Transactional notifications NOTIFICATION_HUB_SQS_QUEUE_NAME environment variable should be configured.

For Marketing notifications NOTIFICATION_HUB_MARKETING_SQS_QUEUE_NAME environment variable should be configured.

For OTP notifications NOTIFICATION_HUB_OTP_SQS_QUEUE_NAME environment variable should be configured.

Configuration

Each application which uses this library must configure Amazon SQS configurations to successfully send notification task to Hub.

The following keys can be defined in the settings module if Django application or can be defined as environment variables

Setting	Description
NOTIFICATION_HUB_SQS_ACCESS_KEY_ID	Access Key of the IAM role which has access to the Hub SQS
NOTIFICATION_HUB_SQS_SECRET_ACCESS_KEY	Secret Access Key of the IAM role which has access to the Hub SQS
NOTIFICATION_HUB_SQS_REGION	AWS Region where the Hub SQS resides
NOTIFICATION_HUB_SQS_QUEUE_NAME	Name of the Hub SQS Queue
NOTIFICATION_HUB_MARKETING_SQS_QUEUE_NAME	Name of the Hub Marketing SQS Queue
NOTIFICATION_HUB_OTP_SQS_QUEUE_NAME	Name of the Hub OTP SQS Queue