POST

New Result

The 'new result' webhook occurs when a new result is found during the scan process. Note that when you receive this webhook the scan is still running.

Name

Description

score

Current score of the scan up to this point.

Unsigned float

developerPayload

The developer payload that was provided in the submit method.

String

Max Length: 512 characters.

internet.id

Unique result ID to identify the result.

String

internet.title

Document title. Mostly extracted from the document content.

String

internet.introduction

Document brief introduction. Mostly extracted from the document content

String

internet.matchedWords

Total matched words between this result and the scanned document.

Unsigned Integer

internet.url

Public URL of the resource.

String (uri)

database.id

Unique result ID to identify this result.

Integer

database.title

Document title. Mostly extracted from the document content.

String

database.introduction

Document brief introduction. Mostly extracted from the document content.

String

database.matchedWords

Total matched words between this result and the scanned document.

Unsigned Integer

database.scanId

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.

String

batch.id

Unique result ID to identify this result.

String

batch.title

Document title. Mostly extracted from the document content.

String

batch.introduction

Document brief introduction. Mostly extracted from the document content.

String

batch.matchedWords

Total matched words between this result and the scanned document.

Unsigned Integer

batch.scanId

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

String

repositories.id

Unique result ID to identify this result.

String

repositories.title

Document title. Mostly extracted from the document content.

String

repositories.introduction

Document brief introduction. Mostly extracted from the document content.

String

repositories.matchedWords

Total matched words between this result and the scanned document.

Unsigned Integer

repositories.repositoryId

The repository Id that has the result.

String

repositories.scanId

The scanId of the matched results in the repository.

String

internet.metadata.finalUrlbatch.metadata.finalUrldatabase.metadata.finalUrlrepositories.metadata.finalUrl

Final result url after all http redirects.

String (uri)

internet.metadata.canonicalUrlbatch.metadata.canonicalUrldatabase.metadata.canonicalUrlrepositories.metadata.canonicalUrl

Extracted canonical url from the result.

String (uri)

internet.metadata.publishDatebatch.metadata.publishDatedatabase.metadata.publishDaterepositories.metadata.publishDate

Publication date of the result.

String (datetime)

internet.metadata.creationDatebatch.metadata.creationDatedatabase.metadata.creationDaterepositories.metadata.creationDate

Creation date of the result.

String (datetime)

internet.metadata.lastModificationDatebatch.metadata.lastModificationDate database.metadata.lastModificationDate  repositories.metadata.lastModificationDate

Last modification date of the result.

String (datetime)

internet.metadata.authorbatch.metadata.authordatabase.metadata.authorrepositories.metadata.author

Result author.

String

internet.metadata.organizationbatch.metadata.organizationdatabase.metadata.organizationrepositories.metadata.organization

Result organization.

String

internet.metadata.filenamebatch.metadata.filenamedatabase.metadata.filenamerepositories.metadata.filename

Result filename.

String

repositories.metadata.submittedBy

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

String

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"
      }
    }
  ]
}

Other resources:

Webhooks Security - Security aspects when protecting your endpoints from unauthorized access.

Do you have a technical question?

Use stackoverflow.com to get help from our development team and other Copyleaks users.

Ask a Question