Interface EventNotification

Details about a notification associated with an event.

interface EventNotification {
    emailAddress?: string;
    expand?: string;
    field?: FieldDetails;
    group?: GroupName;
    id?: number;
    notificationType?:
        | "Group"
        | "User"
        | "CurrentAssignee"
        | "Reporter"
        | "CurrentUser"
        | "ProjectLead"
        | "ComponentLead"
        | "ProjectRole"
        | "EmailAddress"
        | "AllWatchers"
        | "UserCustomField"
        | "GroupCustomField";
    parameter?: string;
    projectRole?: ProjectRole;
    recipient?: string;
    user?: UserDetails;
}

Properties

emailAddress? expand? field? group? id? notificationType? parameter? projectRole? recipient? user?

Properties

OptionalemailAddress

emailAddress?: string

The email address.

Optionalexpand

expand?: string

Expand options that include additional event notification details in the response.

Optionalfield

field?: FieldDetails

The custom user or group field.

Optionalgroup

group?: GroupName

The specified group.

Optionalid

id?: number

The ID of the notification.

OptionalnotificationType

notificationType?:
    | "Group"
    | "User"
    | "CurrentAssignee"
    | "Reporter"
    | "CurrentUser"
    | "ProjectLead"
    | "ComponentLead"
    | "ProjectRole"
    | "EmailAddress"
    | "AllWatchers"
    | "UserCustomField"
    | "GroupCustomField"

Identifies the recipients of the notification.

Optionalparameter

parameter?: string

As a group's name can change, use of recipient is recommended. The identifier associated with the notificationType value that defines the receiver of the notification, where the receiver isn't implied by notificationType value. So, when notificationType is:

  • User The parameter is the user account ID.
  • Group The parameter is the group name.
  • ProjectRole The parameter is the project role ID.
  • UserCustomField The parameter is the ID of the custom field.
  • GroupCustomField The parameter is the ID of the custom field.

OptionalprojectRole

projectRole?: ProjectRole

The specified project role.

Optionalrecipient

recipient?: string

The identifier associated with the notificationType value that defines the receiver of the notification, where the receiver isn't implied by the notificationType value. So, when notificationType is:

  • User, recipient is the user account ID.
  • Group, recipient is the group ID.
  • ProjectRole, recipient is the project role ID.
  • UserCustomField, recipient is the ID of the custom field.
  • GroupCustomField, recipient is the ID of the custom field.

Optionaluser

user?: UserDetails

The specified user.

Settings

Member Visibility

On This Page

Properties