Jira.js - Jira Cloud API library
    Preparing search index...

    Interface EventNotification

    Details about a notification associated with an event.

    interface EventNotification {
        emailAddress?: string;
        expand?: string;
        field?: Version3Models.FieldDetails;
        group?: Version3Models.GroupName;
        id?: number;
        notificationType?: string;
        parameter?: string;
        projectRole?: Version3Models.ProjectRole;
        recipient?: string;
        user?: Version3Models.UserDetails;
    }
    Index

    Properties

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

    Properties

    emailAddress?: string

    The email address.

    expand?: string

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

    field?: Version3Models.FieldDetails
    group?: Version3Models.GroupName
    id?: number

    The ID of the notification.

    notificationType?: string

    Identifies the recipients of the notification.

    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.

    projectRole?: Version3Models.ProjectRole
    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.

    user?: Version3Models.UserDetails

    Settings

    Member Visibility

    On This Page

    Properties