The new results webhook is triggered when a new plagiarism result is found during the scan process. When you receive this webhook, the scan is still in progress.

score number

The current score of the scan up to this point.

developerPayload string

The developer payload that was provided in the submit method.

internet object

id string

Unique result ID to identify the result.

title string

Document title. Mostly extracted from the document content.

introduction string

Document brief introduction. Mostly extracted from the document content.

matchedWords integer

Unsigned Integer

Total matched words between this result and the scanned document.

url string<uri>

Public URL of the resource.

metadata object

tags array[object]

database object

id integer

Unique result ID to identify this result.

title string

Document title. Mostly extracted from the document content.

introduction string

Document brief introduction. Mostly extracted from the document content.

matchedWords integer

Unsigned Integer

Total matched words between this result and the scanned document.

scanId string

In case a result was found in the Copyleaks internal database, and was submitted by you, this will show the scan id of the specific result. Otherwise, this field will remain empty.

metadata object

finalUrl string<uri>

Final result url after all http redirects.

canonicalUrl string<uri>

Extracted canonical url from the result.

publishDate string<date-time>

Publication date of the result.

creationDate string<date-time>

Creation date of the result.

lastModificationDate string<date-time>

Last modification date of the result.

author string

Result author.

organization string

Result organization.

filename string

Result filename.

tags array[object]

code string

Unique ID that signifies the type of result tag.

title string

A simple name for this tag.

description string

Short text describing this tag.

batch object

id string

Unique result ID to identify this result.

title string

Document title. Mostly extracted from the document content.

introduction string

Document brief introduction. Mostly extracted from the document content.

matchedWords integer

Unsigned Integer

Total matched words between this result and the scanned document.

scanId string

The batch id that is unique for all scans in this batch.

metadata object

finalUrl string<uri>

Final result url after all http redirects.

canonicalUrl string<uri>

Extracted canonical url from the result.

publishDate string<date-time>

Publication date of the result.

creationDate string<date-time>

Creation date of the result.

lastModificationDate string<date-time>

Last modification date of the result.

author string

Result author.

organization string

Result organization.

filename string

Result filename.

tags array[object]

code string

Unique ID that signifies the type of result tag.

title string

A simple name for this tag.

description string

Short text describing this tag.

repositories object

id string

Unique result ID to identify this result.

title string

Document title. Mostly extracted from the document content.

introduction string

Document brief introduction. Mostly extracted from the document content.

matchedWords integer

Unsigned Integer

Total matched words between this result and the scanned document.

repositoryId string

The repository Id that has the result.

scanId string

The scanId of the matched results in the repository.

metadata object

finalUrl string<uri>

Final result url after all http redirects.

canonicalUrl string<uri>

Extracted canonical url from the result.

publishDate string<date-time>

Publication date of the result.

creationDate string<date-time>

Creation date of the result.

lastModificationDate string<date-time>

Last modification date of the result.

author string

Result author.

organization string

Result organization.

filename string

Result filename.

submittedBy string

Email of the user which added this document to the repository.

tags array[object]

code string

Unique ID that signifies the type of result tag.

title string

A simple name for this tag.

description string

Short text describing this tag.

Example

{
  "score": 0,
  "developerPayload": "string",
  "internet": [
    {
      "id": "string",
      "title": "string",
      "introduction": "string",
      "matchedWords": 0,
      "url": "string",
      "metadata": {
        "finalUrl": "string",
        "canonicalUrl": "string",
        "author": "string",
        "organization": "string",
        "filename": "string",
        "publishDate": "string",
        "creationDate": "string",
        "lastModificationDate": "string"
      }
    }
  ],
  "database": [
    {
      "id": "string",
      "title": "string",
      "introduction": "string",
      "matchedWords": 0,
      "scanId": "string",
      "metadata": {
        "finalUrl": "string",
        "canonicalUrl": "string",
        "author": "string",
        "organization": "string",
        "filename": "string",
        "publishDate": "string",
        "creationDate": "string",
        "lastModificationDate": "string"
      }
    }
  ],
  "batch": [
    {
      "id": "string",
      "title": "string",
      "introduction": "string",
      "matchedWords": 0,
      "scanId": "string",
      "metadata": {
        "finalUrl": "string",
        "canonicalUrl": "string",
        "author": "string",
        "organization": "string",
        "filename": "string",
        "publishDate": "string",
        "creationDate": "string",
        "lastModificationDate": "string"
      }
    }
  ],
  "repositories": [
    {
      "id": "string",
      "title": "string",
      "introduction": "string",
      "matchedWords": 0,
      "repositoryId": "string",
      "scanId": "string",
      "metadata": {
        "finalUrl": "string",
        "canonicalUrl": "string",
        "author": "string",
        "organization": "string",
        "filename": "string",
        "publishDate": "string",
        "creationDate": "string",
        "lastModificationDate": "string",
        "submittedBy": "string"
      }
    }
  ]
}

Next Steps

Webhooks Overview Learn about the different types of webhooks and how to handle them.

Export Method Learn how to export scan results, including new plagiarism results.

How to Display Scan Reports Understand how to present new results to your users effectively.