Affinda's document.parse.completed fires on failures too: check ready/failed before using data

TL;DR

For "document.parse.failed": the payload always carries the document identifier: use it to GET /v3/documents/{id} and fetch the full result; never assume the webhook body has the data you need.

document.parse.failed

Steps

1. Affinda's document.parse.completed webhook fires on failure too: it means parsing finished, not that it succeeded. Every handler must check the payload's ready and failed flags before touching data, or a failed parse will flow into your pipeline as an empty or partial result. Prefer subscribing to the explicit events (document.parse.succeeded, document.parse.failed) and routing them to different code paths. The same applies to document.classify.completed vs document.classify.succeeded/failed. The payload always carries the document identifier: use it to GET /v3/documents/{id} and fetch the full result; never assume the webhook body has the data you need.

When to use

You are seeing this: Affinda's document.parse.completed webhook fires on failure too: it means parsing finished, not that it succeeded. Use this skill when you run into "Affinda's document.parse.completed fires on failures too: check ready/failed before using data".

When not to use

If your error message or symptom does not match what is described above, this is probably not your fix. Search for your exact error text instead of forcing this one to fit.

Versions

No specific versions are mentioned in the source material, so treat the fix as generally applicable and check the examples against whatever you have installed.

Why this happens

The original report does not dig into a root cause. It documents the symptom and the fix that resolved it.

Edge cases

• Also subscribe to the specific outcome you need (document.parse.succeeded / document.parse.failed) instead of assuming completed means parsed.

Source: Web source (neversight/learn-skills.dev Affinda SKILL.md on github.com, summarizing docs.affinda.com webhooks reference): Affinda webhook events are not all successes. document.parse.completed fires when parsing finishes, whether it succeeded or failed, so your handler must check the ready/failed flags in the payload. Also subscribe to the specific outcome you need (document.parse.succeeded / document.parse.failed) instead of assuming completed means parsed.

Verified resolution: Affinda's document.parse.completed webhook fires on failure too: it means parsing finished, not that it succeeded. Every handler must check the payload's ready and failed flags before touching data, or a failed parse will flow into your pipeline as an empty or partial result. Prefer subscribing to the explicit events (document.parse.succeeded, document.parse.failed) and routing them to different code paths. The same applies to document.classify.completed vs document.classify.succeeded/failed. The payload always carries the document identifier: use it to GET /v3/documents/{id} and fetch the full result; never assume the webhook body has the data you need.

Source URL: https://github.com/neversight/learn-skills.dev/blob/HEAD/data/skills-md/affinda/skills/affinda/SKILL.md