BulkApi2JobEvent (Beta)

Notifies subscribers of changes to the status of Bulk API 2.0 query jobs and provides URLs for downloading partial results. This object is available in API version 63.0 and later.

Bulk API V2 query standard platform events is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Diretctory. Use of this pilot or beta service is at the Customer’s sole discretion.

Note

Supported Subscribers 

SubscriberSupported?
Apex Triggers 
Flows 
Processes 
Pub/Sub APIYes
Streaming API (CometD)Yes

Streaming API Subscription Channel 

/event/BulkApi2JobEvent

Event Delivery Allocation Enforced 

Yes

Fields 

Type 

Type: picklist

Description: Required. The type of event, either JOB_STATE or RESULT.

JobIdentifier 

Type: string

Description: Required. The Bulk API 2 query job’s ID.

JobState 

Type: picklist

Description: Required. The Bulk API 2 query job’s status. Possible values are:

  • Open—Salesforce received the job request.
  • UploadComplete—The job is queued and ready to be processed.
  • InProgress—Salesforce is processing the job.
  • JobComplete—Salesforce finished processing the job request.
  • Failed—The job failed.
  • Abort—The job has been aborted. See Abort a Query Job.

ResultType 

Type: picklist

Properties: Nillable

Description: The Bulk API 2 query job’s processing status, either PARTIAL or FINAL.

ResultUrl 

Type: string

Properties: Nillable

Description: The URL for retrieving the Bulk API 2 query job results.