Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ntropy webhooks API

The webhooks API from Ntropy — 2 operation(s) for webhooks.

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

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

This API exposes 5 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

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

5 operations 2 paths 12 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ntropy.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ntropy webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (APIKeyHeader).

Paths & Operations 5

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

webhooks 5
POST
/v3/webhooks
Create a webhook
post-webhook-v-3-webhooks-post 1 param body → 200422
GET
/v3/webhooks
List all webhooks
get-webhooks-v-3-webhooks-get 1 param → 200422
GET
/v3/webhooks/{id}
Retrieve a webhook
get-webhook-v-3-webhooks-id-get 2 params → 200422
PATCH
/v3/webhooks/{id}
Update a webhook
patch-webhook-v-3-webhooks-id-patch 2 params body → 200422
DELETE
/v3/webhooks/{id}
Delete a webhook
delete-webhook-v-3-webhooks-id-delete 2 params → 204404422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Webhook (6 properties), WebhookPatch (4 properties), WebhookBase (3 properties), ValidationError (3 properties). Each schema is shown below with its type and property counts.

ValidationErrorLocItems
HTTPValidationError
object
1 property
ValidationError
object
3 properties 3 required
PagedResponse_Webhook
object
2 properties 2 required
WebhookBase
object
3 properties 2 required
WebhookPatch
object
4 properties
WebhookBaseEventsItems
string
WebhookPatchEventsItems
string
WebhookUrl
string
Webhooks_delete_webhook_v3_webhooks__id__delete_Response_204
object
Empty response body
WebhookEventsItems
string
Webhook
object
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntropy-webhooks-api-openapi.yml Raw ↑

Other APIs Ntropy publishes across the network.

Ntropy Account Holder API
Ntropy accountHolders API
Ntropy Bank statements API
Ntropy bankStatements API
Ntropy batches API
Ntropy categories API
Ntropy Enrichment API
Ntropy entities API
Ntropy Labels API
Ntropy Misc API
Ntropy personalization API
Ntropy recurrence API