Notifications API - GET a notification configuration
Gets parameters of the specified notification configuration.
The request produces an application/json payload.
| GET |
|
Authentication
To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string |
The ID of the required notification configuration. |
path | required |
Response
Response codes
| Code | Description |
|---|---|
| 200 | Success |
Response body
The NotificationConfig object
Configuration of a notification. The actual set of fields depends on the type of the notification.
See the Notifications API - JSON models help topic for example models of every notification type.
| Element | Type | Description |
|---|---|---|
| id | string | The ID of the notification configuration. |
| name | string | The name of the notification configuration. |
| alertingProfile | string | The ID of the associated alerting profile. |
| active | boolean | The configuration is enabled ( |
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
{
"type": "JIRA",
"id": "acbed0c4-4ef1-4303-991f-102510a69322",
"name": "REST example",
"alertingProfile": "4f5e00f4-39b3-455a-820b-3514843615f3",
"active": true,
"username": "john.smith",
"password": "",
"url": "https://my-jira.atlassian.net/rest/api/2/",
"projectKey": "DEV",
"issueType": "Task",
"summary": "Problem {ProblemID}: {ProblemTitle}",
"description": "{ProblemDetailsText}\n"
}