v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB

Webhook API

Get list of all resthook subscriptions

Returns your resthook subscriptions.

get/v2/resthook_subscriptions

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.

Response

All matching resthook subscriptions.

countinteger required

Number of items in results.

nextstring nullable

URL to request next page of results.

previousstring nullable

URL to request previous page of results.

Example response

{
  "count": 10,
  "results": [
    {
      "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"
      },
      "workspace": {
        "identifier": "mEFayXdO",
        "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"
        }
      },
      "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"
    }
  ]
}