POST
/
v2
/
resthook_subscriptions
Create a resthook subscription
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"
}'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

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

application/json

Response

201
application/json

Successfully created a resthook subscription.

The response is of type object.