Object Reference for the Salesforce Platform

Overview of Salesforce Objects and Fields
Reference
Salesforce Object Behavior
Associated Objects (Feed, History, OwnerSharingRule, Share, and ChangeEvent Objects)
Custom Objects
FSL__Time_Dependency__c
Custom Metadata Type__mdt
Custom Object __c __c
Custom Object__Feed
Object Interfaces
Standard Objects
Data Model
PDF

Custom Object__Feed

Represents the feed, specifically posts and feed-tracked changes, on a custom object.

A custom object feed shows posts and changes to the object’s tracked fields. The object name is variable and uses Custom Object__Feed syntax, where Custom Object is the name of the custom object. For example, Textile__Feed represents a feed on the custom object Textile__c.

Supported Calls

delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules

In the internal org, users can delete all feed items they created. This rule varies in Experience Cloud sites where threaded discussions and delete-blocking are enabled. Site members can delete all feed items they created, provided the feed items don’t have content nested under them—like a comment, answer, or reply. Where the feed item has nested content, only feed moderators and users with the Modify All Data permission can delete threads.

To delete feed items they didn’t create, users must have one of these permissions:

  • Modify All Data
  • Modify All Records on the parent object, like Textile__c.
  • Moderate Chatter

    Users with the Moderate Chatter permission can delete only the feed items and comments they can see.

    Note

    Only users with this permission can delete items in unlisted groups.

Fields

Field Details
BestCommentId
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: The ID of the comment marked as best answer on a question post. This field is available in API version 44.0 and later.
Body
  • Type: textarea
  • Properties: Nillable, Sort
  • Description: The body of the post. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost.
CommentCount
  • Type: int
  • Properties: Filter, Group, Sort
  • Description: The number of comments associated with this feed item.

    In a feed that supports pre-moderation, CommentCount isn’t updated until a comment is published. For example, say that you comment on a post that already has one published comment and your comment triggers moderation. Now there are two comments on the post, but the count says there's only one. In a moderated feed, comments aren’t counted until approved by an admin or someone with Can Approve Feed Post and Comment or Modify All Data.

    Feed moderation has implications on how you retrieve feed comments. In a moderated feed, rather than retrieving comments by looping through CommentCount, go through pagination until the end of comments is returned.
ConnectionId
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your org.
ContentData
  • Type: base64
  • Properties: Nillable
  • Description: Available in API version 36.0 and earlier only. Required if Type is ContentPost. Encoded file data in any format, and can’t be 0 bytes. Setting this field automatically sets Type to ContentPost.
ContentDescription
  • Type: textarea
  • Properties: Nillable, Sort
  • Description: Available in API version 36.0 and earlier only. The description of the file specified in ContentData.
ContentFileName
  • Type: string
  • Properties: Group, Nillable, Sort
  • Description: Available in API version 36.0 and earlier only. This field is required if Type is ContentPost.The name of the file uploaded to the feed. Setting ContentFileName automatically sets Type to ContentPost.
ContentSize
  • Type: int
  • Properties: Group, Nillable, Sort
  • Description: Available in API version 36.0 and earlier only. The size of the file (in bytes) uploaded to the feed. This field is read-only and is automatically determined during insert.
ContentType
  • Type: string
  • Properties: Group, Nillable, Sort
  • Description: Available in API version 36.0 and earlier only. The MIME type of the file uploaded to the feed. This field is read-only and is automatically determined during insert.
FeedPostId
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: This field was removed in API version 22.0, and is available in earlier versions for backward compatibility only.

    ID of the associated FeedPost. A FeedPost represents the following types of changes in a feed item: changes to tracked fields, text posts, link posts, and content posts.
InsertedById
  • Type: reference
  • Properties: Group, Nillable, Sort
  • Description: ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the context user.
IsRichText
  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Description: Indicates whether the feed item Body contains rich text. If you post a rich text feed comment using SOAP API, set IsRichText to true and escape HTML entities from the body. Otherwise, the post is rendered as plain text.

    Rich text supports the following HTML tags:

    • <p>

      Though the <br> tag isn’t supported, you can use <p>&nbsp;</p> to create lines.

    • <a>
    • <b>
    • <code>
    • <i>
    • <u>
    • <s>
    • <ul>
    • <ol>
    • <li>
    • <img>

      The <img> tag is accessible only through the API and must reference files in Salesforce similar to this example: <img src="sfdc://069B0000000omjh"></img>

    In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation.
LikeCount
  • Type: int
  • Properties: Filter, Group, Sort
  • Description: The number of likes associated with this feed item.
LinkUrl
  • Type: url
  • Properties: Nillable, Sort
  • Description: The URL of a LinkPost.
NetworkScope
  • Type: picklist
  • Properties: Group, Nillable, Restricted picklist, Sort
  • Description: Specifies whether this feed item is available in the default Experience Cloud site, a specific Experience Cloud site, or all sites. This field is available in API version 26.0 and later, if digital experiences is enabled for your org.

    NetworkScope can have the following values:

    • NetworkId—The ID of the Experience Cloud site in which the FeedItem is available. If left empty, the feed item is only available in the default Experience Cloud site.
    • AllNetworks—The feed item is available in all Experience Cloud sites.

    Note the following exceptions for NetworkScope:

    • Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope.
    • For feed items with a record parent, users can set NetworkScope only to AllNetworks.
    • You can’t filter a feed item on the NetworkScope field.
ParentId
  • Type: reference
  • Properties: Filter, Group, Sort
  • Description: ID of the custom object record that is tracked in the feed. The feed is displayed on the detail page for this record.
RelatedRecordId
  • Type: reference
  • Properties: Group, Nillable, Sort
  • Description: ID of the ContentVersion object associated with a ContentPost. This field is null for all posts except ContentPost.
Title
  • Type: string
  • Properties: Group, Nillable, Sort
  • Description: The title of the feed item. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name.
Type
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: The type of feed item:

    • ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging).

      For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence.

    • AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post.
    • AnnouncementPost—Not used.
    • ApprovalPost—generated when a user submits an approval.
    • BasicTemplateFeedItem—Not used.
    • CanvasPost—a post made by a canvas app posted on a feed.
    • CollaborationGroupCreated—generated when a user creates a public group.
    • CollaborationGroupUnarchived—Not used.
    • ContentPost—a post with an attached file.
    • CreatedRecordEvent—generated when a user creates a record from the publisher.
    • DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold.
    • DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed.
    • LinkPost—a post with an attached URL.
    • PollPost—a poll posted on a feed.
    • ProfileSkillPost—generated when a skill is added to a user’s Chatter profile.
    • QuestionPost—generated when a user posts a question.
    • ReplyPost—generated when Chatter Answers posts a reply.
    • RypplePost—generated when a user creates a Thanks badge in WDC.
    • TextPost—a direct text entry on a feed.
    • TrackedChange—a change or group of changes to a tracked field.
    • UserStatus—automatically generated when a user adds a post. Deprecated.

    The following values appear in the Type picklist for all feed objects but apply only to CaseFeed:

    • CaseCommentPost—generated event when a user adds a case comment for a case object
    • EmailMessageEvent—generated event when an email related to a case object is sent or received
    • CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event.
    • ChangeStatusPost—generated event when a user changes the status of a case
    • AttachArticleEvent—generated event when a user attaches an article to a case

    If you set Type to ContentPost, also specify ContentData and ContentFileName.
Visibility
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Specifies whether this feed item is available to all users or internal users only. This field is available in API version 26.0 and later, if digital experiences is enabled for your org.

    Visibility can have the following values:

    • AllUsers—The feed item is available to all users who have permission to see the feed item.
    • InternalUsers—The feed item is available to internal users only.

    Note the following exceptions for Visibility:

    • For record posts, Visibility is set to InternalUsers for all internal users by default.
    • External users can set Visibility only to AllUsers.
    • On user and group posts, only internal users can set Visibility to InternalUsers.

Usage

A feed for a custom object is automatically created when a user enables feed tracking for the custom object. Use feeds to track changes to the custom objects they serve. For example, Textile__Feed tracks changes to a Textile__c object. Use feed objects to retrieve the content of feed fields, such as type of feed or feed ID.

Note the following SOQL restrictions. No SOQL limit if logged-in user has View All Data permission. If not, specify a LIMIT clause of 1,000 records or fewer. SOQL ORDER BY on fields using relationships is not available. Use ORDER BY on fields on the root object in the SOQL query.

What About StandardObjectNameFeed Objects?

Similar to custom objects, standard objects can have associated feed objects. For a list of StandardObjectNameFeed objects, see StandardObjectName Feed.