Webhooks
Get list of webhook delivery results for a document
Returns the webhook (resthook) delivery results recorded for a document.
get/v3/resthook_results
Query parameters
offsetinteger
The number of documents to skip before starting to collect the result set.
limitinteger
Example:20
The numbers of results to return.
documentstring required
Identifier of the document to return webhook delivery results for.
event'resume.parse.succeeded' | 'resume.parse.failed' | 'resume.parse.completed' | 'invoice.parse.succeeded' | 'invoice.parse.failed' | 'invoice.parse.completed' | 'invoice.validate.completed' | 'document.parse.succeeded' | 'document.parse.failed' | 'document.parse.completed' | 'document.validate.completed' | 'document.classify.succeeded' | 'document.classify.failed' | 'document.classify.completed' | 'document.rejected' | 'annotation.validated'
The event name to subscribe to.
Example:document.parse.succeeded
Filter results by event.
Response
All matching webhook delivery results.
Example response
{
"count": 10,
"results": [
{
"timestamp": "2022-09-30T08:38:33+00:00",
"document": {
"identifier": "RKvolqxA"
},
"event": "document.parse.succeeded",
"targetUrl": "https://my-site.com/receive",
"status": 200,
"content": "ok"
}
]
}