web

web / lib/jobs/types/task-outputs

lib/jobs/types/task-outputs

Typed output interfaces for Payload CMS workflow tasks.

Each task handler returns { output: TaskOutput } where the output follows these contracts. The error model uses throw/needsReview:

• Task returns data -> workflow continues to next task
• Task returns { needsReview: true } -> workflow handler pauses for review
• Task throws -> Payload retries (transient errors), then onFail marks FAILED

Interfaces

SheetInfo

Sheet info returned by dataset-detection for workflow orchestration.

Properties

index

index: number

ingestJobId

ingestJobId: string | number

name

name: string

rowCount

rowCount: number

DatasetDetectionOutput

Output from dataset-detection task.

Properties

sheetsDetected?

optional sheetsDetected?: number

ingestJobsCreated?

optional ingestJobsCreated?: number

sheets?

optional sheets?: SheetInfo[]

reason?

optional reason?: string

AnalyzeDuplicatesOutput

Output from analyze-duplicates task.

Properties

needsReview?

optional needsReview?: boolean

totalRows?

optional totalRows?: number

uniqueRows?

optional uniqueRows?: number

internalDuplicates?

optional internalDuplicates?: number

externalDuplicates?

optional externalDuplicates?: number

skipped?

optional skipped?: boolean

reason?

optional reason?: string

DetectSchemaOutput

Output from detect-schema task.

Properties

fieldCount?

optional fieldCount?: number

totalRowsProcessed?

optional totalRowsProcessed?: number

reason?

optional reason?: string

ValidateSchemaOutput

Output from validate-schema task.

Properties

needsReview?

optional needsReview?: boolean

requiresApproval?

optional requiresApproval?: boolean

hasBreakingChanges?

optional hasBreakingChanges?: boolean

hasChanges?

optional hasChanges?: boolean

newFields?

optional newFields?: number

failed?

optional failed?: boolean

failureReason?

optional failureReason?: string

reason?

optional reason?: string

CreateSchemaVersionOutput

Output from create-schema-version task.

Properties

schemaVersionId?

optional schemaVersionId?: string | number

versionNumber?

optional versionNumber?: number

skipped?

optional skipped?: boolean

reason?

optional reason?: string

GeocodeBatchOutput

Output from geocode-batch task.

Properties

needsReview?

optional needsReview?: boolean

totalRows?

optional totalRows?: number

uniqueLocations?

optional uniqueLocations?: number

geocoded?

optional geocoded?: number

failed?

optional failed?: number

skipped?

optional skipped?: boolean

reason?

optional reason?: string

CreateEventsOutput

Output from create-events-batch task.

Properties

eventCount?

optional eventCount?: number

duplicatesSkipped?

optional duplicatesSkipped?: number

errors?

optional errors?: number

reason?

optional reason?: string

UrlFetchOutput

Output from url-fetch task.

Properties

ingestFileId?

optional ingestFileId?: string | number

reason?

optional reason?: string

ScraperExecutionOutput

Output from scraper-execution task.

Properties

ingestFileId?

optional ingestFileId?: string | number

hasOutput?

optional hasOutput?: boolean

reason?

optional reason?: string