Webhook Url to File (Anonymization)

POST{{your_url}}/your-path

This particular configuration is available in all Anonymization workspaces - Documents and Images.

The notification sends a JSON payload containing a SAS Token protected URL to the resulting anonymized file. You can then download and store this file in your server for safekeeping.

The following options are available:

• Endpoint: a publicly available URL where SmartDocumentor can send notifications to. Notifications are sent as HTTP POST requests, with a JSON body.

• Generated file format: the file format for the generated file once exported. Depending on the type of workspace, different formats may be available. Currently, PDF, JPEG and PNG are supported.

• Hours until generated file expires: SmartDocumentor sends you a SAS Token protected URL, which must have an expiration date. This field allows you to set the time, in hours, that the sent URL will expire once the notification is set, with a maximum of 168 hours (one week). For the best security, set this value to the lowest value possible that allows your server to download and store the file.

Example Request

JSON

{
  "taskId": 0,
  "totalPages": 0,
  "taskNumber": 0, // nullable
  "workspaceId": 0,
  "displayName": "string",
  "exportedFileUrl": "string",
  "exportedFileContentType": "string",
  "exportedFileExpiresOn": "0001-01-1T01:00:01Z",
  "lastCheckoutByUserName": "string",
  "lastCheckedOutBy": 0,
  "lastCheckedOutUntil": "string",
  "lastIntegratedBy": 0,
  "lastIntegratedByUserName": "string",
  "metadata": { // has any number of key/value pairs
      "Key_1": "Value_1" // strings non nullable, key will be unique throughout the metafields
  }
}

The following JSON fields are set in the request body:

• taskId: the unique ID that identifies your document/task in SmartDocumentor. It is the same ID that is returned when you call the [POST] Create Task API endpoint.

• totalPages: the total number of pages for this file.

• taskNumber: the unique ID that identifies this document within it's workspace.

• workspaceId: the unique ID that identifies the workspace this document belongs to.

• displayName: the display name of this document when shown within SmartDocumentor.

• exportedFileUrl: a SAS token protected URL that points to the generated file, in the selected format and with the configured expiration hours. Once this URL expires, the file will no longer be available, so make sure you download the file to your server/storage before the expiration date. Once the URL expires, requests will return 403 Forbidden.

• exportedFileContentType: the content-type/mime-type of the exported file, which matches the selected file format.

• exportedFileExpiresOn: the expiration date for the file, set according to your configuration. Make sure you download the file to your server/storage before the expiration date.

• lastCheckoutByUserName, lastCheckedOutBy, lastCheckedOutUntil: auditing information for the user that last reviewed the document.

• lastIntegratedBy, lastIntegratedByUserName: auditing information for the user that last finished reviewing the document.

• metadata key-value strings that store additional information for the document/task