AppAlert

Represents an alert message at the object, tab, or global level. This object is available in API version 65.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AdditionalMessage
Type
textarea
Properties
Create, Nillable, Update
Description
The additional details of the message that are communicated in the app alert. This field contains information such as the tag, alert action, URL, or color.
DisplayContextName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The context name related to the app alert display. Possible values are the object name or API name of the tab.
DisplayContextType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the context type related to the app alert display.
Possible values are:
  • Global
  • Object
  • Tab
EffectiveDate
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time that the alert becomes active.
ImageURL
Type
url
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Indicates whether the app alert is silent or not.
The default value is false.
IsSilent
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the app alert is silent or not.
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view.
Message
Type
textarea
Properties
Create, Nillable, Update
Description
The message communicated in the app alert.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the app alert.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner of this app alert record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
SnoozeUntilDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date until which the alert is snoozed.
Source
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The source of the app alert.
SourceSystemIdentifier
Type
string
Properties
Filter, Group, idLookup, Nillable, Sort
Description
The identifier of the record in the source system.
SourceSystemName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the system from which data is loaded into this object.
Subject
Type
textarea
Properties
Create, Update
Description
The subject of the app alert.
Type
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of app alert.
Possible values are:
  • GuidedAction
  • Notification
  • Recommendation
  • Announcement
ValidUntilDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the alert becomes invalid.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

AppAlertChangeEvent
Change events are available for the object.
AppAlertFeed
Feed tracking is available for the object.
AppAlertHistory
History is available for tracked fields of the object.
AppAlertShare
Sharing is available for the object.