API docs by Redocly

Notification Hub - Notification HTTP API (v1)

Download OpenAPI specification:Download

The Notification Hub Service HTTP API

Notification

Sends the notification to different channels configured for the notification id or the name input param

Authorizations:
oauth2
query Parameters
api-version
string
Request Body schema:
required

The notification request payload

Array of objects or null (SendNotificationbyIdOrNameCommandItem)

Responses

Request samples

Content type
{
  • "notificationCommands": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Sends notification to different channels based on the channel type specified in the payload Note: This send notification without considering whether the notification type name exists in the system and hence the payload should include complete expected data.

Authorizations:
oauth2
query Parameters
api-version
string
Request Body schema:
required

The notification request payload

Array of objects or null (SendNotificationCommandItem)

Responses

Request samples

Content type
{
  • "notificationCommands": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

NotificationConfiguration

Save the configuration detail for a list of notification types

Authorizations:
oauth2
query Parameters
api-version
string
Request Body schema:
required

Save configuration request payload

Array of objects or null (NotificationTypeDTO)

Responses

Request samples

Content type
{
  • "notificationTypes": [
    ]
}

Deletes the notification configuration (soft-delete)

Authorizations:
oauth2
query Parameters
api-version
string
Request Body schema:
required

Delete configuration request payload

notificationTypeIds
Array of strings or null

Responses

Request samples

Content type
{
  • "notificationTypeIds": [
    ]
}

Response samples

Content type
application/json
true

Get Notification configuration detail by Unique Id

Authorizations:
oauth2
path Parameters
id
required
string
query Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "status": 1,
  • "channelDetails": [
    ]
}

Get Notification configuration detail by notification name

Authorizations:
oauth2
path Parameters
name
required
string
query Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "status": 1,
  • "channelDetails": [
    ]
}

Get configuration detail of all notification types in the system

Authorizations:
oauth2
query Parameters
onlyActive
boolean
Default: true

gets only active records if true

api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NotificationLookup

Get Notification lookups by Lookup category name

Authorizations:
oauth2
path Parameters
categoryName
required
string
query Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "notificationLookupId": "string",
  • "rowId": "string",
  • "lookupType": "string",
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "status": 0
}

Get all notification lookup in the system

Authorizations:
oauth2
query Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]