Form Detection Run Failed

Payload

1 {
2   "eventId": "string",
3   "payload": {
4     "object": "form_detection_run",
5     "id": "sgr_xK9mLPqRtN3vS8wF5hB2cQ",
6     "file": {
7       "object": "file",
8       "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
9       "name": "Invoices.pdf",
10       "type": "PDF",
11       "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
12       "metadata": {},
13       "createdAt": "2024-03-21T16:45:00Z",
14       "updatedAt": "2024-03-21T16:45:00Z"
15     },
16     "status": "PROCESSING",
17     "failureReason": "FILE_TYPE_NOT_SUPPORTED",
18     "failureMessage": "File type not supported. Form schema detection currently requires a PDF.",
19     "config": {},
20     "output": {
21       "schema": {
22         "type": "object",
23         "properties": {}
24       },
25       "annotatedSchema": {
26         "type": "object",
27         "properties": {}
28       },
29       "mappingResult": {
30         "matches": [
31           {
32             "inputPath": "applicant.address.street",
33             "formFieldKey": "applicant_address_street"
34           }
35         ],
36         "unmatchedInputPaths": [
37           "string"
38         ],
39         "unusedFormFieldKeys": [
40           "string"
41         ]
42       }
43     },
44     "metrics": {
45       "processingTimeMs": 1234,
46       "pageCount": 5,
47       "fieldCount": 10,
48       "fieldsDetectedCount": 8,
49       "fieldsAnnotatedCount": 10,
50       "fieldDetectionTimeMs": 500,
51       "fieldAnnotationTimeMs": 200
52     },
53     "usage": {
54       "credits": 9
55     }
56   },
57   "eventType": "form_detection_run.failed"
58 }

Triggered when a FormDetectionRun created directly through the Form Detection API fails.

Internal FormDetectionRuns created by EditRuns without a schema do not emit this webhook. Their failures are reported through the parent edit_run.failed event.

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