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

Finicity Webhook Subscription API

APIs for Managing Partner Webhook Event Subscriptions

Finicity Webhook Subscription API is one of 41 APIs that Finicity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 12 operations across 8 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.43.0.

Requests are made against a single base URL, https://api.finicity.com.

12 operations 8 paths 20 schemas 2 DELETE5 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.43.0
Base URL
https://api.finicity.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Finicity Webhook Subscription API declares 2 security schemes for authenticating requests. An API key is passed in the header as Finicity-App-Key (FinicityAppKey). An API key is passed in the header as Finicity-App-Token (FinicityAppToken). By default, every request must be authenticated.

  • FinicityAppKey — The "Finicity-App-Key" from the developer dashboard
  • FinicityAppToken — A token returned by the /authentication API

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 2 DELETE, 5 GET, 1 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhook Subscription 12

APIs for Managing Partner Webhook Event Subscriptions

POST
/notification-subscriptions/webhooksdeprecated
Create Webhook Subscription
createWebhookSubscription 1 param body → 201400401
GET
/notification-subscriptions/webhooksdeprecated
List Webhook Subscriptions
listWebhookSubscriptions 3 params → 200400401404
GET
/notification-subscriptions/webhooks/{subscription_id}deprecated
Get Webhook Subscription Details
getWebhookSubscriptionById 2 params → 200400401404
PUT
/notification-subscriptions/webhooks/{subscription_id}deprecated
Update Webhook Subscription
updateWebhookSubscription 2 params body → 200400401404
DELETE
/notification-subscriptions/webhooks/{subscription_id}deprecated
Delete Webhook Subscription
deleteWebhookSubscription 2 params → 204401404
PUT
/notification-subscriptions/webhooks/{subscription_id}/events/{webhook_event_id}deprecated
Update Webhook Subscription Event
updateWebhookSubscriptionEvent 3 params body → 200400401404
DELETE
/notification-subscriptions/webhooks/{subscription_id}/events/{webhook_event_id}deprecated
Delete Webhook Subscription Event
deleteWebhookSubscriptionEvent 3 params → 204400401404
PUT
/notification-subscriptions/webhooks/{subscription_id}/events/{webhook_event_id}/statusdeprecated
Enable or Disable Webhook Subscription Event
changeWebhookSubscriptionEventStatus 3 params body → 200400401404
GET
/notification-subscriptions/webhooks/eventsdeprecated
List Available Webhook Subscription Events
listAvailableWebhookSubscriptionEvents 1 param → 200401404
PUT
/notification-subscriptions/webhooks/{subscription_id}/statusdeprecated
Enable or Disable All Webhook Events Under a Given Webhook Subscription
changeWebhookSubscriptionStatus 2 params body → 200400401404
GET
/notification-subscriptions/webhooks/{subscription_id}/test-subscriptionsdeprecated
Test Webhook Subscription Based on Subscription ID
testWebhookSubscription 2 params → 200400401404
GET
/notification-subscriptions/webhooks/{subscription_id}/events/{webhook_event_id}/test-subscriptionsdeprecated
Test Webhook Subscription Based on Subscription ID and Webhook Event ID
testWebhookSubscriptionBasedOnEventId 3 params → 200400401404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are SubscriptionDetail (6 properties), Event (5 properties), Error (5 properties), Subscriptions (5 properties). Each schema is shown below with its type and property counts.

WebhookEvent
object
3 properties 1 required
WebhookUrl
string
The webhook Url where the event notifications will be sent. The URL must be aligned with RFC 2396.
Event
object
5 properties 3 required
LimitResults
integer
The number of items you asked the list to be limited.
ErrorWrapper
object
A top level object for errors.
1 property 1 required
CountResults
integer
The number of subscriptions currently displayed in the response.
Status
string
The status of the event (e.g. active, inactive, pending, removed).
AvailableEvent
object
3 properties 3 required
Subscription
object
Request body to create or update a subscription.
2 properties 1 required
Errors
object
Object that contains the list of errors.
1 property 1 required
Condition
object
3 properties 1 required
EventStatusUpdate
object
1 property 1 required
WebhookEvents
array
List of webhook subscription event.
Error
object
A single error.
5 properties
SubscriptionDetail
object
6 properties 5 required
Subscriptions
object
5 properties 5 required
Events
array
List of events for the subscription.
ErrorList
array
The list of errors.
TotalResults
integer
The total number of items in the collection.
OffsetResults
integer
The number of items you asked the start of the list to be offset.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

finicity-webhook-subscription-api-openapi.yml Raw ↑

Other APIs Finicity publishes across the network.

Finicity Connect
Finicity Verification of Assets (VoA) API
Finicity Verification of Income & Employment (VoIE) API
Finicity Transaction Analysis (Cash Flow) API
Finicity Payments (Account Validation) API
Finicity Open Banking Data Access (FDX)
Finicity Account Validation Assistance API
Finicity Accounts API
Finicity Accounts (Simple) API
Finicity App Registration API
Finicity Authentication API
Finicity Balance Analytics API
Where this information came from

This is an independent, third-party profile of Finicity Webhook Subscription 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.