NtfcnDefinition

Represents the definition of a notification that’s configured for a specific object. For example, Notification for Creation of Problems is a setup definition that helps admins configure how, when, and the type of notifications that are shared across multiple channels such as Slack, Email, or In-App when a problem record is either created or updated. This object is available in API version 62.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update()

Supported REST API Calls

DELETE, GET, HEAD, PATCH, POST, Query

Usage

Use this object to query and manage Notification Definitions in your org. Client applications can create, update, delete, or query records associated with Notification Definition via the API.

Fields

CreatedById

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort
Description: The ID of the user who created this record.
Relationship Name: CreatedBy
Relationship Type: Lookup
Refers To: User

CreatedDate

Type: datetime
Properties: Create, Defaulted on create, Filter, Sort
Description: The date and time on which this record is created.

Description

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The description of a notification definition.

DeveloperName

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. This field is automatically generated, but you can supply your own value if you create the record using the API. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

Id

Type: id
Properties: Defaulted on create, Filter, Group, Sort
Description: The ID of this Notification Definition.

IsDeleted

Type: boolean
Properties: Defaulted on create, Filter, Group, Sort
Description: Indicates whether the notification definition is deleted or not.
Default value: false

Language

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The combined language and locale ISO code, which controls the language of the configuration item attribute picklist value definition.

LastModifiedById

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort
Description: The ID of the user who last modified this record.
Relationship Name: LastModifiedBy
Relationship Type: Lookup
Refers To: User

LastModifiedDate

Type: datetime
Properties: Create, Defaulted on create, Filter, Sort
Description: The date and time on which this record was last modified.

ManageableState

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Indicates the manageable state of the specified component that is contained in a package.
Possible values:
- beta—Managed-Beta
- deleted—Managed-Proposed-Deleted
- deprecated—Managed-Proposed-Deprecated
- deprecatedEditable—SecondGen-Installed-Deprecated
- installed—Managed-Installed
- installedEditable—SecondGen-Installed-Editable
- released—Managed-Released
- unmanaged—Unmanaged

MasterLabel

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The label for this configuration item type relation definition value. This display value is the internal label that doesn’t get translated.

NamespacePrefix

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

NotificationType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the type of notification definition. If the definition is shipped, it’s a template and if the admin creates a notification definition, it’s custom.
Possible values:
- Custom
- Template

ReferenceObject

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: The object for which a notification definition is created.
Possible values:
- ApprovalWorkItem—Approval Work Item
- Asset
- Case
- ChangeRequest—Change Request
- ChgAdvsryBoardMeeting—Change Advisory Board Meeting
- ChgAdvsryBoardRelChgReq—Change Advisory Board Related Change Request
- ChgAdvsryBrdMtgRelChgReq—Change Advisory Board Meeting Related Change Request
- CompPlcyCommsResponse—Compliance Policy Communication Response
- ComplianceEvidenceRequest—Compliance Evidence Request
- ComplianceIssue—Compliance Issue
- Incident
- Problem
- ProductRequest—Product Request
- ProductTransfer—Product Transfer
- Release
- RiskEvalSurveyInvt—Risk Evaluation Survey Invitation
- ServiceRequest—Service Request
- WorkOrder—Work Order

Status

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: Specifies the status of the definition.
Possible values:
- Active
- Draft
- Inactive

SystemModstamp

Type: datetime
Properties: Defaulted on create, Filter, Sort
Description: The date and time when this record was last modified by an automated process.

TriggerEventType

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: The type of event for which a notification is triggered, such as creation or modification of a record for an object.
Possible values:
- Insert—Create
- Update

UsageType

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: Specifies the usage type of the definition. Example: IT Service
Possible values:
- DirectNotification—Direct Notification
- ITServices—It services
- SLA