Affinda · Example Payload

Affinda Webhook Subscription Example

Create a webhook subscription. Affinda probes the target URL and returns a probe value; activate by calling /v3/resthook_subscriptions/activate.

AIArtificial IntelligenceDocument ProcessingIntelligent Document ProcessingIDPOCRResume ParsingInvoice ParsingReceipt ParsingDocument ExtractionDocument ClassificationDocument SplittingRecruitmentBankingInsuranceLogisticsHealthcareGovernment

Affinda Webhook Subscription Example is an example object payload from Affinda, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationdescriptionrequestresponse

Example Payload

Raw ↑ 
{
  "operation": "POST /v3/resthook_subscriptions",
  "description": "Create a webhook subscription. Affinda probes the target URL and returns a probe value; activate by calling /v3/resthook_subscriptions/activate.",
  "request": {
    "method": "POST",
    "url": "https://api.affinda.com/v3/resthook_subscriptions",
    "headers": {
      "Authorization": "Bearer <AFFINDA_API_KEY>",
      "Content-Type": "application/json"
    },
    "body": {
      "targetUrl": "https://example.com/hooks/affinda",
      "event": "document.parse.succeeded",
      "version": "v3"
    }
  },
  "response": {
    "status": 201,
    "body": {
      "id": 4711,
      "targetUrl": "https://example.com/hooks/affinda",
      "event": "document.parse.succeeded",
      "version": "v3",
      "active": false,
      "createdDt": "2026-05-25T17:55:32.000Z"
    }
  }
}