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

ZenAdmin Webhooks API

The Webhooks API from ZenAdmin — 4 operation(s) for webhooks.

ZenAdmin Webhooks API is one of 6 APIs that ZenAdmin 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 authentication docs.

This API exposes 6 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://console.zenadmin.ai/api/external.

6 operations 4 paths 5 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://console.zenadmin.ai/api/external
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

ZenAdmin Webhooks API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyHeader). It accepts HTTP bearer tokens (ApiKeyBearer). By default, every request must be authenticated.

  • ApiKeyHeader — Per-key API key. Shown once at creation. Rate limit 60 req/min (burst 120).
  • ApiKeyBearer — The API key may alternatively be sent as: Authorization Bearer .

Paths & Operations 6

Across 4 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.

Webhooks 6
POST
/webhooks/subscriptions
Create webhook subscription
createWebhookSubscription body → 200400401
GET
/webhooks/subscriptions
List webhook subscriptions
listWebhookSubscriptions → 200401
PATCH
/webhooks/subscriptions/{id}
Update webhook subscription
updateWebhookSubscription 1 param body → 200401404
DELETE
/webhooks/subscriptions/{id}
Delete webhook subscription
deleteWebhookSubscription 1 param → 200401404
GET
/webhooks/deliveries
List webhook deliveries
listWebhookDeliveries → 200401
POST
/webhooks/deliveries/{id}/redeliver
Redeliver webhook event
redeliverWebhookDelivery 1 param → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are MetaData (3 properties), WebhookSubscription (3 properties), WebhookDelivery (3 properties), WebhookSubscriptionCreate (2 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties 2 required
WebhookDelivery
object
3 properties
WebhookSubscriptionCreate
object
2 properties 2 required
WebhookSubscription
object
3 properties
MetaData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zenadmin-webhooks-api-openapi.yml Raw ↑

Other APIs ZenAdmin publishes across the network.

ZenAdmin Catalog API
ZenAdmin Context API
ZenAdmin Devices API
ZenAdmin Employees API
ZenAdmin Orders API