NtfcnDefinition

Represents a notification definition, including the criteria that trigger the notification and the channels, recipients, and content used to deliver it. This type extends the Metadata metadata type and inherits its fullName field.

NtfcnDefinition components have the suffix .ntfcnDefinition and are stored in the ntfcnDefinitions folder.

NtfcnDefinition components are available in API version 62.0 and later.

  • Type: string
  • Description: The description of the notification.
  • Type: string
  • Description: Required. The unique name of the NtfcnDefinition component. Inherited from the Metadata metadata type. This field isn’t updateable.
  • Type: string
  • Description: Required. The name of the notification.
  • Type: NtfcnCriteria[]
  • Description: The criteria that determine when the notification is triggered.

  • Type: string

  • Description: Required. Indicates whether the notification uses a standard or custom template.

  • Possible values:

    • Standard
    • Custom
  • Type: NtfcnChannelDef[]
  • Description: The channel definitions that specify how the notification is delivered, such as by email, Slack, or Microsoft Teams.
  • Type: string
  • Description: The API name of the sObject associated with the notification.
  • Type: string
  • Description: Required. The trigger object associated with the notification, such as Incident, Problem, ChangeRequest, or Release.
  • Type: string
  • Description: The API name of the junction object used to track associations, disassociations, and changes, such as ProblemIncident.

  • Type: string

  • Description: The status of the notification.

  • Possible values:

    • Active
    • Inactive
    • Draft

  • Type: string

  • Description: Required. Indicates when the notification is sent, such as when a record is created or updated.

  • Possible values:

    • Create
    • Update
    • Child Associate
    • Child Update
    • Parent Update
  • Type: string
  • Description: Required. The usage type of the notification. This field keeps the notification data model generic across products, such as IT Service.
  • Type: NtfcnCondition[]
  • Description: The conditions that make up the notification criteria.
  • Type: string
  • Description: The name of the notification criteria.
  • Type: string
  • Description: The custom logic expression used to evaluate the conditions in the notification criteria.

  • Type: string

  • Description: Required. The type of logic used to evaluate the conditions in the notification criteria.

  • Possible values:

    • And
    • Or
    • CustomLogic
  • Type: boolean
  • Description: Indicates whether the notification channel is active (true) or not (false).

  • Type: string

  • Description: Required. The channel used to deliver the notification.

  • Possible values:

    • Email
    • Slack
    • Teams
    • InApp
  • Type: NtfcnChannelCont[]
  • Description: The content delivered on the notification for this channel.
  • Type: NtfcnChannelRec[]
  • Description: The recipients of the notification for this channel.
  • Type: string
  • Description: Required. The API name of the field on the target object that’s evaluated by the condition, such as Status or Priority.

  • Type: string

  • Description: Required. The operator used to compare the field to the value.

  • Possible values:

    • Equals
    • GreaterThan
    • GreaterOrEqual
    • LessThan
    • LessOrEqual
    • Contains
    • DoesNotContain
  • Type: int
  • Description: Required. The order in which the condition is evaluated.
  • Type: string
  • Description: Required. The value that the field is compared to when the condition is evaluated.
  • Type: string
  • Description: Required. The user-defined label of the action.
  • Type: string
  • Description: Required. The developer name of the action.
  • Type: string
  • Description: The reference to the ID of the action target.
  • Type: string
  • Description: The type of action target, such as a Salesforce URL, Slack URL, in-app URL, or Microsoft Teams URL.
  • Type: string
  • Description: The email template included in the notification when the channel type is email.
  • Type: string
  • Description: The message body of the notification.
  • Type: string
  • Description: The title, or subject, of the notification.
  • Type: string
  • Description: The sender email address used for email notifications.
  • Type: boolean
  • Description: Indicates whether the recipient is active (true) or not (false).
  • Type: string
  • Description: Required. The identifier of the notification recipient. The recipient can be an email address, a channel ID, or a user field on an object.
  • Type: string
  • Description: Required. The type of recipient, such as an email address, user field, Slack channel, in-app channel, or Microsoft Teams channel.
  • Type: string
  • Description: The name of the destination Slack or Microsoft Teams app.
  • Type: string
  • Description: The workspace ID or team ID of the recipient’s Slack channel or Microsoft Teams channel.

A sample XML definition of a NtfcnDefinition component is shown here.

The following package.xml manifest retrieves the NtfcnDefinition component.

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.