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

Z League Webhooks API

The Webhooks API from Z League — 2 operation(s) for webhooks.

Z League Webhooks API is one of 2 APIs that Z League publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.

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

Requests are made against a single base URL, https://app.gomega.ai.

4 operations 2 paths 4 schemas 1 DELETE1 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://app.gomega.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Z League Webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Admin-issued Personal Access Token, e.g. Authorization: Bearer mega . The key carries scopes (publicapi:leads:read, publicapi:leads:write, publicapi:webhooks:m…

Paths & Operations 4

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

Webhooks 4
GET
/api/agents/crm/lead-webhooks
List webhooks
listWebhooks 1 param → 200401403429
POST
/api/agents/crm/lead-webhooks
Register a webhook
createWebhook 1 param body → 201400401403409429
PATCH
/api/agents/crm/lead-webhooks/{id}
Update / rotate a webhook
updateWebhook 2 params body → 200400401403404429
DELETE
/api/agents/crm/lead-webhooks/{id}
Delete a webhook
deleteWebhook 2 params → 200401403404429

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Webhook (9 properties), WebhookUpdateRequest (7 properties), WebhookCreateRequest (6 properties), Error (1 property). Each schema is shown below with its type and property counts.

Webhook
object
9 properties 8 required
Error
object
1 property 1 required
WebhookCreateRequest
object
6 properties 1 required
WebhookUpdateRequest
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

z-league-webhooks-api-openapi.yml Raw ↑

Other APIs Z League publishes across the network.

Z League Leads API