Operations with Specific NotificationSettings

This resource lets you work with the notification settings of your YouTrack service: read and configure Email and Jabber server settings to enable notifications to users.

Resource	/api/admin/globalSettings/notificationSettings
Returned entity	NotificationSettings. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a Specific NotificationSettings. `POST`: Update a Specific NotificationSettings.

NotificationSettings attributes

Represents the Notifications settings of the YouTrack service.

This table describes attributes of the NotificationSettings entity.

To receive an attribute in the response from server, specify it explicitly in the request parameter fields.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
emailSettings	EmailSettings	Settings for sending emails. `Read-only`.
jabberSettings	JabberSettings	Settings for sending jabber messages. `Read-only`.

Read a Specific NotificationSettings

Read the Notification settings of your YouTrack service.

Required permissions

Requires permission: Low-level Admin Read

Request syntax

GET /api/admin/globalSettings/notificationSettings?{fields}

Request parameters

Parameter	Type	Description
fields	String	A list of NotificationSettings attributes that should be returned in the response. If no field is specified,only the `entityID` is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/globalSettings/notificationSettings?fields=emailSettings(isEnabled,host,port,mailProtocol,anonymous,login,from,replyTo),jabberSettings(isEnabled,host,port,login,serviceName)
            

Sample response body

{
  "emailSettings": {
    "isEnabled": true,
    "port": 587,
    "from": "youtrack@service.myjetbrains.com",
    "login": null,
    "mailProtocol": "SMTP_TLS",
    "anonymous": false,
    "replyTo": null,
    "host": null,
    "$type": "EmailSettings"
  },
  "jabberSettings": {
    "isEnabled": true,
    "port": 5222,
    "login": null,
    "serviceName": "myjetbrains.com",
    "host": "talk.google.com",
    "$type": "JabberSettings"
  },
  "$type": "NotificationSettings"
}
            

Update a Specific NotificationSettings

Change the Notification settings of your YouTrack service.

Required permissions

Requires Low-level Admin Write permission.

Request syntax

POST /api/admin/globalSettings/notificationSettings?{fields}

Request parameters

Parameter	Type	Description
fields	String	A list of NotificationSettings attributes that should be returned in the response. If no field is specified,only the `entityID` is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/globalSettings/notificationSettings?fields=emailSettings(isEnabled,from,replyTo),jabberSettings(isEnabled)
            

Sample request body

{
  "jabberSettings": {
    "isEnabled": false
  },
  "emailSettings": {
    "from": "youtrack@example.myjetbrains.com"
  }
}
            

Sample response body

{
  "emailSettings": {
    "isEnabled": true,
    "from": "youtrack@example.myjetbrains.com",
    "replyTo": null,
    "$type": "EmailSettings"
  },
  "jabberSettings": {
    "isEnabled": false,
    "$type": "JabberSettings"
  },
  "$type": "NotificationSettings"
}
            

Last modified: 28 October 2020