Notification service (2.0.0)

Download OpenAPI specification:Download

fabric OMS notification service APIs for multi tenant service

Notification Server Controller

These endpoints help in triggering notification emails for the respective events which the user has subscribed for.

Listen to user and emit notifications

This listener processes the request body and emit notification events to webhook service

SecurityAuthorization or context
Request
header Parameters
tenant-key
required
string

tenant id

Request Body schema: application/json
id
string
notificationType
string
documentType
string
Array of objects (OrderContact)
Responses
200

Notifications emitted Successfully

400

Bad Request

403

Duplicated Entity

404

Not Found

500

Internal Server Error

post/send
Request samples
application/json
{
  • "id": "string",
  • "notificationType": "string",
  • "documentType": "string",
  • "overrideContactInfo": [
    ]
}
Response samples
application/json
[
  • {
    }
]

Listen to user and emit acknowledgment

This listener processes the acknowledgement body and adds audit-logs

SecurityAuthorization or context
Request
header Parameters
tenant-key
required
string

tenant id

Request Body schema: application/json
id
string
documentType
string
notificationType
string
notificationDate
string
Responses
200

acknowledgment emitted

400

Bad Request

403

Duplicated Entity

404

Not Found

500

Internal Server Error

post/acknowledgment
Request samples
application/json
{
  • "id": "123456789",
  • "documentType": "ORDER",
  • "notificationType": "string",
  • "notificationDate": "2022-07-14T10:27:28-05:00"
}
Response samples
application/json
{
  • "id": "123456789",
  • "documentType": "ORDER",
  • "notificationType": "string",
  • "notificationDate": "2022-07-14T10:27:28-05:00"
}