Authorizations
Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}
.
You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.
Body
URL of the resthook's receiver.
"https://my-site.com/receive"
The event name to subscribe to.
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
"document.parse.succeeded"
Uniquely identify an organization. Specify to create an organization scope resthook. Not required if you're a member of only 1 organization.
"mEFayXdO"
Uniquely identify a workspace. Specify to create a workspace scope resthook.
"mEFayXdO"
Version of the resthook subscription. Determines the resthook body being fired.
v1
, v2
, v3
"v3"
Response
Successfully created a resthook subscription.
Resthook subscription's ID.
The event name to subscribe to.
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
"document.parse.succeeded"
URL of the resthook's receiver.
"https://my-site.com/receive"
Resthooks only fire for active subscriptions.
true
Resthook subscriptions can be auto deactivated if the receiver continuously returns error status code over a period of time.
true
The reason for the subscription being auto deactivated. May contains the error response that the receiver returned.
"Resthook fails after 10 retries. The last error received was: 500 - Internal server error."
Version of the resthook subscription. Determines the resthook body being fired.
v1
, v2
, v3
"v3"