Form Detection Run Processed

Payload

{
  "eventId": "string",
  "payload": {
    "object": "form_detection_run",
    "id": "sgr_xK9mLPqRtN3vS8wF5hB2cQ",
    "file": {
      "object": "file",
      "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
      "name": "Invoices.pdf",
      "type": "PDF",
      "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
      "metadata": {},
      "createdAt": "2024-03-21T16:45:00Z",
      "updatedAt": "2024-03-21T16:45:00Z"
    },
    "status": "PROCESSING",
    "failureReason": "FILE_TYPE_NOT_SUPPORTED",
    "failureMessage": "File type not supported. Form schema detection currently requires a PDF.",
    "config": {},
    "output": {
      "schema": {
        "type": "object",
        "properties": {}
      },
      "annotatedSchema": {
        "type": "object",
        "properties": {}
      },
      "mappingResult": {
        "matches": [
          {
            "inputPath": "applicant.address.street",
            "formFieldKey": "applicant_address_street"
          }
        ],
        "unmatchedInputPaths": [
          "string"
        ],
        "unusedFormFieldKeys": [
          "string"
        ]
      }
    },
    "metrics": {
      "processingTimeMs": 1234,
      "pageCount": 5,
      "fieldCount": 10,
      "fieldsDetectedCount": 8,
      "fieldsAnnotatedCount": 10,
      "fieldDetectionTimeMs": 500,
      "fieldAnnotationTimeMs": 200
    },
    "usage": {
      "credits": 9
    }
  },
  "eventType": "form_detection_run.processed"
}

Triggered after a FormDetectionRun created directly through the Form Detection API finishes detecting and annotating form fields and generating the edit schema. Internal FormDetectionRuns created by EditRuns without a schema do not emit Form Detection webhooks. Only the parent EditRun emits a terminal webhook for those requests.

Payload

The payload of this webhook request is an object.

eventIdstringRequired

Unique identifier for the event

payloadobjectRequired

A run that detects fields in a PDF form and generates an edit schema.

Response

200

Return a 200 status to indicate that the webhook was received successfully