POST
Completed
The "completed" event occurs once the scan process has been completed and the scan finished successfully. Successful scans provide you all the output information from the scan process. The data that is attached to the request body contains the following parts:
Name
Description
status
IntegerPossible values:
0
: Success 1
: Error 2
: CreditsChecked 3
: Indexed developerPayload
StringMax Length: 512 characters
scannedDocument.scanId
String
scannedDocument.totalWords
Unsigned Integer
scannedDocument.totalExcluded
Unsigned Integer
scannedDocument.credits
Integer
scannedDocument.creationTime
String (datetime)Timezone: UTC+0
scannedDocument.metadata.finalUrl
String (uri)
scannedDocument.metadata.canonicalUrl
String (uri)
scannedDocument.metadata.publishDate
String (datetime)
scannedDocument.metadata.creationDate
String (datetime)
scannedDocument.metadata.lastModificationDate
String (datetime)
scannedDocument.metadata.author
String
scannedDocument.metadata.organization
String
scannedDocument.metadata.filename
String
results.internet.id
String
results.internet.title
String
results.internet.introduction
String
results.internet.matchedWords
Unsigned Integer
results.internet.url
String (uri)
results.database.id
Integer
results.database.title
String
results.database.introduction
String
results.database.matchedWords
Unsigned Integer
results.database.scanId
String
results.batch.id
String
results.batch.title
String
results.batch.introduction
String
results.batch.matchedWords
Unsigned Integer
results.batch.scanId
String
results.repositories.id
String
results.repositories.title
String
results.repositories.introduction
String
results.repositories.matchedWords
Unsigned Integer
results.repositories.repositoryId
String
results.repositories.scanId
String
results.internet.metadata.finalUrl results.batch.metadata.finalUrl results.database.metadata.finalUrl results.repositories.metadata.finalUrl
String (uri)
results.internet.metadata.canonicalUrl results.batch.metadata.canonicalUrl results.database.metadata.canonicalUrl results.repositories.metadata.canonicalUrl
String (uri)
results.internet.metadata.publishDate results.batch.metadata.publishDate results.database.metadata.publishDate results.repositories.metadata.publishDate
String (datetime)
results.internet.metadata.creationDate results.batch.metadata.creationDate results.database.metadata.creationDate results.repositories.metadata.creationDate
String (datetime)
results.internet.metadata.lastModificationDate results.batch.metadata.lastModificationDate results.database.metadata.lastModificationDate results.repositories.metadata.lastModificationDate
String (datetime)
results.internet.metadata.author results.batch.metadata.author results.database.metadata.author results.repositories.metadata.author
String
results.internet.metadata.organization results.batch.metadata.organization results.database.metadata.organization results.repositories.metadata.organization
String
results.internet.metadata.filename results.batch.metadata.filename results.database.metadata.filename results.repositories.metadata.filename
String
results.repositories.metadata.submittedBy
String
results.score.identicalWords
Unsigned Integer
results.score.minorChangedWords
Unsigned Integer
results.score.relatedMeaningWords
Unsigned Integer
results.score.aggregatedScore
Unsigned float
notifications.alerts[]
Object Array
notifications.alerts[].code
String
notifications.alerts[].title
String
notifications.alerts[].message
String
notifications.alerts[].helpLink
String
notifications.alerts[].severity
Unsigned IntegerPossible values:
0
: Very Low 1
: Low 2
: Medium 3
: High 4
: Very High notifications.alerts[].additionalData
String
Example
{ "status": 0, "developerPayload": "Custom developer payload", "scannedDocument": { "scanId": "string", "totalWords": 0, "totalExcluded": 0, "credits": 0, "creationTime": "string", "metadata": { "finalUrl": "string", "canonicalUrl": "string", "author": "string", "organization": "string", "filename": "string", "publishDate": "string", "creationDate": "string", "lastModificationDate": "string" } }, "results": { "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" } } ], "score": { "identicalWords": 0, "minorChangedWords": 0, "relatedMeaningWords": 0, "aggregatedScore": 0 } }, "downloadableReport": { "status": "Success = 0", "report": "string" }, "notifications": { "alerts": [ { "code": "string", "title": "string", "message": "string", "helpLink": "string", "severity": 0, "additionalData": "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.