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 Webhooks, Events, 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.0.3, at version 3.0.0.
Requests are made against a single base URL, https://{region}.affinda.com.
Metadata
The identity and technical contract details declared by the specification.
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.
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…
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Affinda 12
Other APIs Affinda publishes across the network.