curl --request POST \
--url https://{region}.affinda.com/v2/resthook_subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"targetUrl": "https://my-site.com/receive",
"event": "document.parse.succeeded",
"version": "v3"
}
'import requests
url = "https://{region}.affinda.com/v2/resthook_subscriptions"
payload = {
"targetUrl": "https://my-site.com/receive",
"event": "document.parse.succeeded",
"version": "v3"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
targetUrl: 'https://my-site.com/receive',
event: 'document.parse.succeeded',
version: 'v3'
})
};
fetch('https://{region}.affinda.com/v2/resthook_subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 2,
"event": "document.parse.succeeded",
"targetUrl": "https://my-site.com/receive",
"active": true,
"autoDeactivated": true,
"autoDeactivateReason": "Resthook fails after 10 retries. The last error received was: 500 - Internal server error.",
"version": "v3"
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}Create a resthook subscription
After a subscription is successfully created, we’ll send a POST request to your target URL with a X-Hook-Secret header.
You need to response to this request with a 200 status code to confirm your subscribe intention.
Then, you need to use the X-Hook-Secret to activate the subscription using the /resthook_subscriptions/activate endpoint.
For more information and detailed instructions, see our webhooks documentation here.
curl --request POST \
--url https://{region}.affinda.com/v2/resthook_subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"targetUrl": "https://my-site.com/receive",
"event": "document.parse.succeeded",
"version": "v3"
}
'import requests
url = "https://{region}.affinda.com/v2/resthook_subscriptions"
payload = {
"targetUrl": "https://my-site.com/receive",
"event": "document.parse.succeeded",
"version": "v3"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
targetUrl: 'https://my-site.com/receive',
event: 'document.parse.succeeded',
version: 'v3'
})
};
fetch('https://{region}.affinda.com/v2/resthook_subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 2,
"event": "document.parse.succeeded",
"targetUrl": "https://my-site.com/receive",
"active": true,
"autoDeactivated": true,
"autoDeactivateReason": "Resthook fails after 10 retries. The last error received was: 500 - Internal server error.",
"version": "v3"
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}Authorizations
Basic authentication using an API key, e.g. {Authorization: Bearer 75z0bb4fbdf97b7e4111ff6c0015471094155f91}.
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
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, submission.completed "document.parse.succeeded"
Response
Successfully created a resthook subscription.
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, submission.completed "document.parse.succeeded"

