Workspace Webhook

Setting up Webhook in FormX

Webhooks are a supported integration method within FormX Workspace.

Once a file is uploaded and processed in a Workspace, FormX can automatically send the extraction results to your specified webhook URL.

Prerequisite:

1. Create a workspace and use Workspace to process all uploaded documents.
2. If you intend to use the API to upload files to FormX and utilize webhooks, make sure to use the /v2/workspace endpoint instead of the /v2/extract endpoint.

Set up a webhook

To set up a webhook, please contact us at[email protected] with the following details:

1. Webhook endpoint: Your webhook endpoint.
2. Workspace ID: The workspace ID
3. Custom headers: Any custom headers you require (please specify both the header name and value).
4. Success or error response: Whether webhook should be delivered for both success or error response or either of them. By default both will be delivered.

Webhook Delivery and Retries

The Webhook handlers must respond with a status code within the 2xx range within 10 seconds. Otherwise, it would be considered a failed delivery.

FormX will retry up to 3 times, each with 30 minutes interval.

Webhook Payload Example

Success response aka "status": "ok"

{
  "data": {
		//extraction value
  },
  "status": "ok",
  "metadata": {
    "page_no": //page no if mulitple documents,
    "slice_no": //slice no if mulitple documents in an image,
    "orientation": //orientation,
    "extractor_type": //type of extractor
  },
  "extractor_id": //extractor id,
  "detailed_data": {
    //extraction value in detail
  }
}

Error response aka "status": "failed"

{
  "error": {
    "code": //error code,
    "message": //error message
  },
  "status": "failed",
  "metadata": {
    "page_no":  //page no if mulitple documents,
    "slice_no": //slice no if mulitple documents in an image,
    "extractor_type": //type of extractor
  },
  "extractor_id": //extractor id
}