API Guide

Notifications
Notification service APIs.
Topics:
• GET /notifications
• GET /notifications/smtp
• PUT /notifications/smtp
• DELETE /notifications/smtp
• POST /notifications/smtp/test
GET /notifications
Retrieves all the currently applied notification configurations.
API
GET /notifications
Description This API returns all the currently applied notification configurations.
Parameters None
Responses 200 — Response to get an all configurations request
{
"smtp":
{
"smtp_host": "string",
"port*": "integer",
"from_email_id*": "string",
"username": "string",
"password": "string",
"auth_required*": "boolean",
"ssl_required*": "boolean"
}
}
401 — You are not authorized to perform this operation
{
"new_object_id": "string",
"id": "string",
"message": "string",
"messageParams": [
"string"
],
"messages": [
{
"id": "string",
"message": "string",
"field_name": "string",
"messageParams": [
"string"
]
}
]
}
16
Notifications 131