Notification Service (2.4.0)

Download OpenAPI specification:Download

This is the spec that defines the API provided by the Notificaiton Service.

Subscriber

getSubscribers

Get all the subscribers from the notification service.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getSubscriber

Get the subscriber from the notification service given subscriber ID.

path Parameters
id
required
integer

ID of the subscriber entry

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "handler": "string",
  • "endpoint": "string",
  • "config": { }
}

deleteSubscriber

Delete the specified subscriber from the notification service.

path Parameters
id
required
integer

ID of the subscriber entry to be deleted.

Responses

Response samples

Content type
application/json
{
  • "message": "Subscriber is not found.",
  • "code": 101
}

Register

registerSubscriber

Register subscriber with the notification service.

Request Body schema: application/json

Register a new subscriber for notification messages.

handler
required
string
endpoint
required
string
config
required
object

Responses

Request samples

Content type
application/json
{
  • "handler": "string",
  • "endpoint": "string",
  • "config": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "handler": "string",
  • "endpoint": "string",
  • "config": { }
}