Once the export request is done, a completion webhook is fired. When the webhook reaches your servers, please verify that all the requested data was copied correctly. To check that the commands finished successfully, check:
  1. The completed flag should be equal to true.
  2. Each task.isHealthy should be equal to true.
  3. Each task.httpStatusCode should be equal to 2xx (200, 204, …).
​
completed
boolean
This flag gives an indication of whether the scan was completed without internal errors on the Copyleaks side. Possible values: true (Completed successfully), false (Error)
​
developerPayload
string
The developer payload that was provided in the submit method.
​
tasks
array[object]
A List of completed tasks.

​
Example

{
  "completed": true,
  "developerPayload": "This is my payload",
  "tasks": [
    {
      "endpoint": "https://yourserver.com/export/export-id/results/my-result-id",
      "httpStatusCode": 200,
      "isHealthy": true
    },
    {
      "endpoint": "https://yourserver.com/export/export-id/pdf-report",
      "httpStatusCode": 200,
      "isHealthy": true
    },
    {
      "endpoint": "https://yourserver.com/export/export-id/crawled-version",
      "httpStatusCode": 200,
      "isHealthy": true
    }
  ]
}

​
Next Steps

Export Method

Learn how to initiate export requests for various scan artifacts.

Webhooks Overview

Understand the different types of webhooks and how to handle them.

How to Display Scan Reports

Learn how to present exported scan data to your users.