standardization.processed.success

webhook

Fired when document data has been successfully standardized against a schema.

Payload

eventType

const

enum

required

eventType is always 'standardization.processed.success' for this event.

Allowed:

documentId

string

required

Unique identifier of the document.

standardizationId

string

required

Unique identifier of the standardization.

schemaId

string

Defaults to null

Unique identifier of the schema used for standardization.

dataset

string

Defaults to null

The dataset to which the document belongs.

jobId

string

required

Unique identifier of the job.

data

object

required

Standardized data, can be a deeply nested structure.

metadata

object

Metadata associated with the originally submitted document.

numPages

integer

Defaults to null

Number of pages in the document.

pages

array of integers

Defaults to null

List of zero-indexed page numbers the standardization was restricted to. If null, the standardization ran against the full document.

pages

filename

string

Defaults to null

The name of the file as submitted by the user.

dataTooBig

boolean

Defaults to null

True if the data field was omitted due to payload size limits. Use GET /standardization/{standardizationId} to fetch the full data.

transformationJobId

string

Defaults to null

Set when transformations were requested. A transformation.processed event follows when they finish.

transformationErrorMessage

string

Defaults to null

Set instead of transformationJobId when the requested transformations could not be started.