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

Yapily Webhooks API

Webhook endpoints

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

This API exposes 4 JSON Schema definitions.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 5 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 12.4.0.

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

5 operations 4 paths 7 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
12.4.0
Base URL
https://api.yapily.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Yapily Webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the [Yapily Console](https://conso…

Paths & Operations 5

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

Webhooks 5

Webhook endpoints

GET
/webhook/events/categories
Get Webhook Categories
getWebhookEventsCategories → 200401400500
POST
/webhook/events
Register Webhook Event
registerWebhook 1 param body → 201401400406500
GET
/webhook/events
Retrieve All Webhook Events
getRegisteredWebhooks 1 param → 200401400500
DELETE
/webhook/events/{webhook_id}
Delete Webhook Event
deleteWebhook 2 params → 200401400404500
POST
/webhook/secrets/{webhook_id}
Reset Webhook Secret
webhookSecretReset 2 params body → 201401400404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are RegisteredWebhook (5 properties), CategoryStructure (2 properties), Metadata (1 property), ApiErrorResponseV2 (1 property). Each schema is shown below with its type and property counts.

RegisteredWebhook
object
5 properties
RegisteredWebhookWithStatus
WebhookStatusType
string
WebhookMetadata
object
Any data (under 10kB total) that should be associated with the Webhook. A copy of this data will be returned on every Webhook trigger.
CategoryStructure
object
2 properties
ApiErrorResponseV2
object
API Error Response
1 property
Metadata
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-webhooks-api-openapi.yml Raw ↑

Other APIs Yapily publishes across the network.

Yapily Institutions API
Yapily Consents and Authorisations API
Yapily Payments API (PIS)
Yapily Data Plus API
Yapily Application Beneficiaries API
Yapily Application Management API
Yapily Authorisations API
Yapily Constraints API
Yapily Financial Data API
Yapily Hosted Consent Pages API
Yapily Hosted Payment Pages API
Yapily Notifications API