Notification

post

Receive Alerts or Notifications. If the severity is CRITICAL, the Notifications are processed (distributed) immediately. Or, the Notification is processed in batch.

get

Query a specific Notification by slug.

delete

Delete a specific Notification by slug.

delete

Delete the proccessed Notifications if the current timestamp minus their last modification timestamp is less than the age parameter, and the corresponding Transmissions will also be deteled. Please notice this API is only for proccessed Notifications (status = PROCCESSED). If the deletion purpose includes each kind of Notifications, please refer to /cleanup API.

get

Query the Notifications by sender name with limited returned records.

get

Query the Notifications by creation timestamp between start date and end date.

get

Query the Notifications by creation timestamp after start date.

get

Query the Notifications by creation timestamp before end date.

get

Query the Notifications by labels matching any one of them.

get

Fetch the unprocessed Notifications (status = NEW).

Subscription

get

List all Subscriptions.

post

Create a new Subscritpion.

put

Update a specific Subscription according to the slug in request body, and the Boolean value "true" will be returned to indicate updating successfully. If the slug doesn't exit, the 404 NotFound error will be returned.

get

Query a specific Subscription by slug.

delete

Delete a specific Subscription by slug.

get

Query the Subscription by subscribed categories and labels matching any one of them.

get

Query the Subscription by subscribed categories matching any one of them.

get

Query the Subscription by subscribed labels matching any one of them.

get

Query the Subscriptions by Receiver Name.

Transmission

get

Query the Transmissions associating a specific Notification by the Notification slug.

get

Query the Transmissions by creation timestamp between start date and end date.

get

Query the Transmissions by creation timestamp after start date.

get

Query the Transmissions by creation timestamp before end date.

get

Query the escalated Transmissions (status = ESCALATED)

get

Query the failed Transmissions (status = FAILED)

delete

Delete all the sent Transmissions (status = SENT) if the current timestamp minus their last modification timestamp is less than the age parameter.

delete

Delete all the escalated Transmissions (status = ESCALATED) if the current timestamp minus their last modification timestamp is less than the age parameter.

delete

Delete all the acknowledged Transmissions (status = ACKNOWLEDGED) if the current timestamp minus their last modification timestamp is less than the age parameter.

delete

Delete all the failed Transmissions (status = FAILED and resendCount >= resend limit) if the current timestamp minus their last modification timestamp is less than the age parameter.

Cleanup

delete

Delete all the Notifications if the current timestamp minus their last modification timestamp is less than a default age setting, and the corresponding Transmissions will also be deleted.

delete

Delete all the Notifications if the current timestamp minus their last modification timestamp is less than the age parameter, and the corresponding Transmissions will also be deleted.

Ping

get

Test service providing an indication that the service is available.