ProjectNotification Object

Description

Configured notification for a project.

Properties

amazonSnsSettings

Email settings for the notification. Required when notificationMethod is amazon-sns.

Type: ProjectNotificationAmazonSnsSettings object

Required: Conditional

createdDate

Date, in ISO 8601 format, at which the notification was created.

Type: string

emailSettings

Email settings for the notification. Required when notificationMethod is email.

Type: ProjectNotificationEmailSettings object

Required: Conditional

lastModifiedDate

Date, in ISO 8601 format, at which the notification was last modified.

Type: string

lastModifiedBy

User that last modified the notification details (method, level, etc.)

Type: string

notificationId

Unique ID of the project notification.

Type: string

notificationLevel

Level of notification.

Type: string

Allowed Values:

  • all

  • errors-only

Required: Yes

notificationMethod

Method of notification.

Type: string

Allowed Values:

  • email

  • slack

  • amazon-sns

Required: Yes

slackSettings

Slack settings for the notification. Required when notificationMethod is slack.

Type: ProjectNotificationSlackSettings object

Required: Conditional

Sample JSON

{
    "notificationId": "pn-12345678",
    "createdDate": "2023-01-29T00:00:00Z",
    "lastModifiedDate": "2023-01-29T00:00:00Z",
    "lastModifiedBy": "u-12345678",
    
    "notificationLevel": "errors-only",    
    "notificationMethod": "email",
    "emailSettings": {
        "emailAddresses" [
            "user1@example.com"
        ]
    }
}

Last updated