How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Affinda Webhooks API

Resthook-style webhook subscriptions for document parsing events. Create a subscription, receive a probe payload, and call the activation endpoint to confirm the receiver. Affinda delivers events such as document parsed, document failed, and validation completed to the registered URL.

Affinda Webhooks API is one of 16 APIs that Affinda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook, Event, and Integration. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against a single base URL, https://{region}.affinda.com.

6 operations 3 paths 17 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Server
https://{region}.affinda.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Affinda Webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Basic authentication using an API key, e.g. {Authorization: Bearer aff0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings pag…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 6

Manage webhook integrations with your apps. Affinda have implemented webhooks to allow the data extracted by Affinda to be 'pushed' to you when an event occurs (e.g. document pars…

GET
/v3/resthook_subscriptions
Get list of all resthook subscriptions
getAllResthookSubscriptions 2 params → 200400401default
POST
/v3/resthook_subscriptions
Create a resthook subscription
createResthookSubscription body → 201400401default
GET
/v3/resthook_subscriptions/{id}
Get specific resthook subscription
getResthookSubscription 1 param → 200400401default
PATCH
/v3/resthook_subscriptions/{id}
Update a resthook subscription
updateResthookSubscription 1 param body → 200400401default
DELETE
/v3/resthook_subscriptions/{id}
Delete a resthook subscription
deleteResthookSubscription 1 param → 204400401default
POST
/v3/resthook_subscriptions/activate
Activate a resthook subscription
activateResthookSubscription 1 param → 200400401default

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ResthookSubscription (9 properties), Organization (8 properties), ResthookSubscriptionCreate (5 properties), ResthookSubscriptionUpdate (4 properties). Each schema is shown below with its type and property counts.

PaletteColorOptions
object
4 properties 1 required
Organization_properties-identifier
string
Uniquely identify an organization.
targetUrl
string
URL of the resthook's receiver.
name
string
ResthookSubscriptionCreate
object
5 properties 2 required
version
string
Version of the resthook subscription. Determines the resthook body being fired.
ThemeConfig
object
4 properties
OrganizationRole
string
PaginatedResponse
object
3 properties 1 required
identifier
string
Uniquely identify a workspace.
ResthookEvent
string
The event name to subscribe to.
ResthookSubscription_properties-id
integer
Resthook subscription's ID.
ResthookSubscriptionWorkspace
object
3 properties 3 required
ResthookSubscriptionUpdate
object
4 properties
ResthookSubscription
object
9 properties 9 required
RequestError
object
2 properties 2 required
Organization
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-webhooks-api-openapi.yml Raw ↑

Other APIs Affinda publishes across the network.

Affinda Documents API
Affinda Document Types API
Affinda Workspaces API
Affinda Organizations API
Affinda Data Sources API
Affinda Annotations API
Affinda Validation Results API
Affinda Tags API
Affinda Usage API
Affinda Search and Match API
Affinda Add x-hidden to endpoints API
Affinda Deprecated End Points API
Where this information came from

This is an independent, third-party profile of Affinda Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.