SearchIndexJobStatusEvent

Notifies subscribers of changes to the status of the Data Cloud search index job, such as index refresh status and index run-time status. This object is available in API version 60.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

Subscriber	Supported?
Apex Triggers
Flows
Processes
Pub/Sub API
Streaming API (CometD)

Subscription Channel

/event/SearchIndexJobStatusEvent

Event Delivery Allocation Enforced

Yes

Special Access Rules

SearchIndexJobStatusEvent is available only if Data Cloud is enabled.

Fields

ApiName

Type: string

Properties: Nillable

Description: The search index API name.

ErrorCode

Type: string

Properties: Nillable

Description: Reference code for the type of error that occurred.

EventCreationDate

Type: dateTime

Properties: Nillable

Description: The date and time when the event occurred.

EventPublishDate

Type: dateTime

Properties: Nillable

Description: The date and time when the event was published.

EventType

Type: string

Properties: Nillable

Description: The type of event that occurred.

EventUuid

Type: string

Properties: Nillable

Description: A universally unique identifier (UUID) that identifies a platform event message.

IndexRefreshedOn

Type: dateTime

Properties: Nillable

Description: The date and time of the last refresh on the index.

ReplayId

Type: string

Properties: Nillable

Description: Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.

RuntimeStatus

Type: string

Properties: Nillable

Description: The last run status of the search index such as Ready, In Progress, or Failed.

SchemaVersion

Type: string

Properties: Nillable

Description: The version of the event schema.