WorkBadge

Represents information about who the badge was given to and which badge was given. A WorkBadge record is created for each recipient of a WorkBadgeDefinition.

Supported Calls

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

Additional Considerations and Related Objects

WorkBadge is a lookup to WorkThanks. Each WorkBadge record must derive a SourceId from WorkThanks. There can be multiple WorkBadge records tied to a single WorkThanks record.

Fields

Field Name Details
DefinitionId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. Salesforce unique ID for the given WorkBadgeDefinition record given.
This is a relationship field.
Relationship Name
Definition
Relationship Type
Lookup
Refers To
WorkBadgeDefinition
Description
Type
textarea
Properties
Nillable
Description
The description of the WorkBadgeDefinition.
GiverId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the badge giver. Can’t be the same as RecipientId.
This is a relationship field.
Relationship Name
Giver
Relationship Type
Lookup
Refers To
User
ImageUrl
Type
url
Properties
Filter, Group, Nillable, Sort
Description
The URL of the badge image.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The time stamp that indicates when the current user last viewed a record that is related to this WorkBadge.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The time stamp that indicates when the current user last viewed this WorkBadge. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
Message
Type
textarea
Properties
Nillable
Description
The message accompanying the thanks badge.
NetworkId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the community that this WorkBadge is associated with. This field is available only if digital experiences is enabled in your org.
RecipientId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. Salesforce unique ID for User who is the Recipient of Badge. Can’t be the same as GiverId
This is a relationship field.
Relationship Name
Recipient
Relationship Type
Lookup
Refers To
User
RewardId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Salesforce unique ID for Reward given with badge (if Reward Badge)
SourceId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Salesforce unique ID for Thanks record referenced to this badge.
This is a relationship field.
Relationship Name
Source
Relationship Type
Lookup
Refers To
WorkThanks

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.

WorkBadgeChangeEvent (API version 62.0)
Change events are available for the object.