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

Ziina Webhook API

Register or delete a webhook endpoint for payment events.

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

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

This API exposes 2 operations across 1 path, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api-v2.ziina.com/api.

2 operations 1 paths 2 schemas 1 DELETE1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api-v2.ziina.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 2

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

Webhook 2

Register or delete a webhook endpoint for payment events.

POST
/webhook
WebhookController_createWebhook body → default
DELETE
/webhook
WebhookController_deleteWebhook → default

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are SetWebhookRequestDto (2 properties), WebhookResponseDto (2 properties). Each schema is shown below with its type and property counts.

WebhookResponseDto
object
2 properties 1 required
SetWebhookRequestDto
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ziina-webhook-api-openapi.yml Raw ↑

Other APIs Ziina publishes across the network.

Ziina Account API
Ziina HealthCheck API
Ziina Log API
Ziina PaymentIntent API
Ziina Refund API
Ziina Transfer API