POST
/
v3
/
resthook_subscriptions
Create a resthook subscription
curl --request POST \
  --url https://{region}.affinda.com/v3/resthook_subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "targetUrl": "https://my-site.com/receive",
  "event": "document.parse.succeeded",
  "organization": "mEFayXdO",
  "workspace": "mEFayXdO",
  "version": "v3"
}'
{
  "id": 123,
  "event": "document.parse.succeeded",
  "organization": {
    "identifier": "mEFayXdO",
    "name": "Grove Street King",
    "userRole": "admin",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
    "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad",
    "isTrial": true,
    "validationToolConfig": {
      "theme": {
        "palette": {
          "mode": "light",
          "background": "<string>",
          "text": {
            "primary": "<any>",
            "secondary": "<any>",
            "disabled": "<any>"
          },
          "divider": "<string>",
          "primary": {
            "main": "<any>",
            "light": "<any>",
            "dark": "<any>",
            "contrastText": "<any>"
          },
          "secondary": {
            "main": "<any>",
            "light": "<any>",
            "dark": "<any>",
            "contrastText": "<any>"
          },
          "success": {
            "main": "<any>",
            "light": "<any>",
            "dark": "<any>",
            "contrastText": "<any>"
          },
          "annotation": {
            "main": "<any>",
            "light": "<any>",
            "dark": "<any>",
            "contrastText": "<any>"
          },
          "error": {
            "main": "<any>",
            "light": "<any>",
            "dark": "<any>",
            "contrastText": "<any>"
          },
          "info": {
            "main": "<any>",
            "light": "<any>",
            "dark": "<any>",
            "contrastText": "<any>"
          },
          "warning": {
            "main": "<any>",
            "light": "<any>",
            "dark": "<any>",
            "contrastText": "<any>"
          }
        },
        "typography": {
          "fontFamily": "<string>",
          "fontSize": "<string>",
          "fontWeightRegular": "<string>",
          "fontWeightMedium": "<string>",
          "fontWeightBold": "<string>"
        },
        "borderRadius": 123,
        "fontUrl": "<string>"
      },
      "hideActions": true,
      "hideCollection": true,
      "hideEditPages": true,
      "hideExport": true,
      "hideFilename": true,
      "hideReject": true,
      "hideReparse": true,
      "hideRunOcr": true,
      "hideTags": true,
      "hideWarnings": true,
      "restrictDocumentSplitting": true,
      "disableCurrencyFormatting": true,
      "disableEditDocumentMetadata": true
    },
    "showCustomFieldCreation": true
  },
  "workspace": {
    "identifier": "mEFayXdO",
    "name": "<string>",
    "organization": {
      "identifier": "mEFayXdO",
      "name": "Grove Street King",
      "userRole": "admin",
      "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
      "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad",
      "isTrial": true,
      "validationToolConfig": {
        "theme": {
          "palette": {
            "mode": "light",
            "background": "<string>",
            "text": {
              "primary": "<any>",
              "secondary": "<any>",
              "disabled": "<any>"
            },
            "divider": "<string>",
            "primary": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "secondary": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "success": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "annotation": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "error": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "info": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            },
            "warning": {
              "main": "<any>",
              "light": "<any>",
              "dark": "<any>",
              "contrastText": "<any>"
            }
          },
          "typography": {
            "fontFamily": "<string>",
            "fontSize": "<string>",
            "fontWeightRegular": "<string>",
            "fontWeightMedium": "<string>",
            "fontWeightBold": "<string>"
          },
          "borderRadius": 123,
          "fontUrl": "<string>"
        },
        "hideActions": true,
        "hideCollection": true,
        "hideEditPages": true,
        "hideExport": true,
        "hideFilename": true,
        "hideReject": true,
        "hideReparse": true,
        "hideRunOcr": true,
        "hideTags": true,
        "hideWarnings": true,
        "restrictDocumentSplitting": true,
        "disableCurrencyFormatting": true,
        "disableEditDocumentMetadata": true
      },
      "showCustomFieldCreation": true
    }
  },
  "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 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

application/json
​
targetUrl
string
required

URL of the resthook's receiver.

Example:

"https://my-site.com/receive"

​
event
enum<string>
required

The event name to subscribe to.

Available options:
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
Example:

"document.parse.succeeded"

​
organization
string

Uniquely identify an organization. Specify to create an organization scope resthook. Not required if you're a member of only 1 organization.

Example:

"mEFayXdO"

​
workspace
string

Uniquely identify a workspace. Specify to create a workspace scope resthook.

Example:

"mEFayXdO"

​
version
enum<string>

Version of the resthook subscription. Determines the resthook body being fired.

Available options:
v1,
v2,
v3
Example:

"v3"

Response

Successfully created a resthook subscription.

​
id
integer
required

Resthook subscription's ID.

​
event
enum<string>
required

The event name to subscribe to.

Available options:
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
Example:

"document.parse.succeeded"

​
organization
object
required
​
workspace
object
required
​
targetUrl
string
required

URL of the resthook's receiver.

Example:

"https://my-site.com/receive"

​
active
boolean
required

Resthooks only fire for active subscriptions.

Example:

true

​
autoDeactivated
boolean
required

Resthook subscriptions can be auto deactivated if the receiver continuously returns error status code over a period of time.

Example:

true

​
autoDeactivateReason
string
required

The reason for the subscription being auto deactivated. May contains the error response that the receiver returned.

Example:

"Resthook fails after 10 retries. The last error received was: 500 - Internal server error."

​
version
enum<string>
required

Version of the resthook subscription. Determines the resthook body being fired.

Available options:
v1,
v2,
v3
Example:

"v3"