Core API dev guides

Notification

9min

Introduction to Notification Service
The Notification Service is responsible for managing a common message-streaming platform that can be used to send and consume messages across platform applications and mobile apps.
﻿
Scope of Notification Service
Allow mobile applications to register and configure notification message format and delivery options for receiving notifications.
Send notifications to registered mobile applications in specified formats.
Allow tenants or apps to define filters on topics.
Mobile Notification
For mobile notifications, there is a notification service with a separate topic. For using a notification service to push notifications to mobile applications, first apps need to be registered with the notification service. Notification service uses Firebase Cloud Messaging (FCM) service to push notifications to mobile devices. 
Steps for Pushing Notifications
Register an App Notification Configuration in Notification Service
Before configuring an App in the notification service, first, add FCM App credentials including the project ID, the client email, and the private key in the Secure Data Storage (SDS) service vault. Then use this SDS ID when you configure the App.
To store notification data in SDS Vault:
Create an App in the SDS service.
Create a vault in the SDS service and provide decrypted read permission(010) to the App notification.
Store data in the vault created in the above step.
Register the Notification Configuration which acts as a default configuration if there is no other configuration defined in the Kafka event.
Send notification events to topic: <tenant>_mobile_notification_P0_<env>
e.g. delhivery_mobile_notification_P0_preprod
Attributes for App Registration 
Attribute Name
Data Type Expected
Description
name*
string
App name
appPlatform*
string
Enum: [Android, iOS]
appId*
string
Unique ApplicationID generated on Firebase.
enableNotification
boolean
default: true
accountConfig.android.projectId*
string
SDS key for the globally unique, user-assigned ID of the parent project for the app.
accountConfig.android.clientEmail*
string
SDS key for Firebase service account
accountConfig.android.privateKey*
string
SDS key for a private key for the Firebase service account
📘Note﻿
Attributes marked with (*) are mandatory
Attributes for App Notification
Attribute Name
Data Type Expected
Description
androidConfig.collapseKey*
string
Collapse key for the message
androidConfig.priority
string
FCM concept that controls when the message is delivered. Enum: [high, normal]
androidConfig.ttl
string
Time-to-live duration of the message in milliseconds.
androidConfig.restrictedPackageName
boolean
default: true
androidConfig.icon
string
SDS key for the globally unique, user-assigned ID of the parent project for the app.
androidConfig.color
string
﻿
androidConfig.sound
string
﻿
androidConfig.tag
string
﻿
androidConfig.clickAction
string
﻿
androidConfig.bodyLocKey
string
﻿
androidConfig.bodyLocArgs
Array<string>
﻿
androidConfig.titleLocKey
string
﻿
androidConfig.titleLocArgs
Array<string>
﻿
androidConfig.channelId
string
﻿
androidConfig.ticker
string
﻿
androidConfig.sticky
boolean
﻿
androidConfig.eventTimestamp
string
﻿
androidConfig.localOnly
string
﻿
androidConfig.notificationPriority
string
Enum [min, low, default, high, max]
androidConfig.defaultSound
boolean
﻿
androidConfig.defaultVibrateTimings
boolean
﻿
androidConfig.defaultLightSettings
boolean
﻿
androidConfig.vibrateTimingsMillis
Array<integer>
﻿
androidConfig.visibility
string
Enum [private, public, secret]
androidConfig.notificationCount
integer
﻿
androidConfig.imageUrl
string
﻿
IOS Device Push Notification
Attributes for IOS Device Push Notification
Attribute Name
Data Type expected
Description
name*
string
App name
appPlatform*
string
Enum: [Android, iOS]
appId*
string
Unique ApplicationID generated on Firebase.
enableNotification
boolean
default: true
accountConfig.ios.projectId*
string
SDS key for the globally unique, user-assigned ID of the parent project for the app
accountConfig.ios.clientEmail*
string
SDS key for Firebase service account
accountConfig.ios.privateKey*
string
SDS key for a private key for the Firebase service account
📘Note﻿
Attributes marked with (*) are mandatory
IOS Device Notification Configuration options
Attributes for IOS device notification configuration options
Attribute Name
Data Type Expected
Description
iosConfig.priority*
integer
Priority of notification (highest=10, lowest=5)
iosConfig.sound
string
Name of sound (default)
iosConfig.volume
float
Volume (highest=1.0 , lowest = 0.0)
iosConfig.criticalSound
boolean
Default: true
iosConfig.imageUrl
string
Image URL for the notification.
📘Note﻿
Attributes marked with (*) are mandatory
Reference request payload for Kafka Events
Kafka event payload
Kafka Event Payload for iOS Mobile Notification
Kafka Event Payload for Android Mobile Notification
{
	tenantId: string;
	requestId: string;
	source: {
    	name: string;
    	type: string;
    	user: { [key: string]: any };
	};
	event: {
    	appId: string;
    	tokens: [];
    	body: {
        	title?: string;
        	body?: string;
        	data?: { [key: string]: string };
    	};
	appPlatform: enum: [ios, android] 
    	config: {
        	collapseKey?: string;
        	priority?: "high" | "normal";
        	restrictedPackageName?: string;
        	ttl?: number;
        	bodyLocArgs?: Array<string>;
        	bodyLocKey?: string;
        	channelId?: string;
        	clickAction?: string;
        	color?: string;
        	defaultLightSettings?: boolean;
        	defaultSound?: boolean;
        	defaultVibrateTimings?: boolean;
        	eventTimestamp?: Date;
        	icon?: string;
        	imageUrl?: string;
        	localOnly?: boolean;
        	notificationCount?: number;
        	notificationPriority?: "min" | "low" | "default" | "high" | "max";
        	sound?: string;
        	sticky?: boolean;
        	tag?: string;
        	ticker?: string;
        	titleLocArgs?: Array<string>;
        	titleLocKey?: string;
        	vibrateTimingsMillis?: number[];
        	visibility?: "private" | "public" | "secret";
    	};
    	headers: {};
    	auth: {};
	};
}

{
	tenantId: string;
	requestId: string;
	source: {
    	name: string;
    	type: string;
    	user: { [key: string]: any };
	};
	event: {
    	appId: string;
    	tokens: [];
    	body: {
        	title?: string;
        	body?: string;
        	data?: { [key: string]: string };
    	};
	appPlatform: enum: [ios, android] 
    	config: {
        	collapseKey?: string;
        	priority?: "high" | "normal";
        	restrictedPackageName?: string;
        	ttl?: number;
        	bodyLocArgs?: Array<string>;
        	bodyLocKey?: string;
        	channelId?: string;
        	clickAction?: string;
        	color?: string;
        	defaultLightSettings?: boolean;
        	defaultSound?: boolean;
        	defaultVibrateTimings?: boolean;
        	eventTimestamp?: Date;
        	icon?: string;
        	imageUrl?: string;
        	localOnly?: boolean;
        	notificationCount?: number;
        	notificationPriority?: "min" | "low" | "default" | "high" | "max";
        	sound?: string;
        	sticky?: boolean;
        	tag?: string;
        	ticker?: string;
        	titleLocArgs?: Array<string>;
        	titleLocKey?: string;
        	vibrateTimingsMillis?: number[];
        	visibility?: "private" | "public" | "secret";
    	};
    	headers: {};
    	auth: {};
	};
}
﻿
﻿

Updated 08 Aug 2023

Did this page help you?

Entity

Motion Tracking System

Docs powered by Archbee

TABLE OF CONTENTS

Introduction to Notification Service

Scope of Notification Service

Mobile Notification

Steps for Pushing Notifications

IOS Device Push Notification

IOS Device Notification Configuration options

Attribute Name	Data Type Expected	Description
name*	string	App name
appPlatform*	string	Enum: [Android, iOS]
appId*	string	Unique ApplicationID generated on Firebase.
enableNotification	boolean	default: true
accountConfig.android.projectId*	string	SDS key for the globally unique, user-assigned ID of the parent project for the app.
accountConfig.android.clientEmail*	string	SDS key for Firebase service account
accountConfig.android.privateKey*	string	SDS key for a private key for the Firebase service account