Edit Run Failed

Payload

{
  "eventId": "string",
  "payload": {
    "object": "edit_run",
    "id": "edr_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. Edit runs currently require a PDF.",
    "config": {},
    "output": {
      "editedFile": {
        "id": "file_Ab3cDE45Fg6hIj7KlM8nO",
        "presignedUrl": "https://extend-files.s3.amazonaws.com/..."
      }
    },
    "metrics": {
      "processingTimeMs": 1234,
      "pageCount": 5,
      "fieldCount": 10,
      "fieldsDetectedCount": 8,
      "fieldsAnnotatedCount": 10,
      "fieldDetectionTimeMs": 500,
      "fieldAnnotationTimeMs": 200,
      "fieldFillingTimeMs": 300
    },
    "usage": {
      "credits": 9
    }
  },
  "eventType": "edit_run.failed"
}

Triggered when an API-created EditRun fails before it finishes filling the document’s form fields.

If an internal FormDetectionRun created for a schema-less EditRun fails, the failure is reported through this parent edit_run.failed event. The internal run does not emit form_detection_run.failed.

Payload

The payload of this webhook request is an object.

eventIdstringRequired

Unique identifier for the event

payloadobjectRequired

Edit run object.

Response

200

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