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

Hyperline Webhooks API

The Webhooks API from Hyperline — 3 operation(s) for webhooks.

Hyperline Webhooks API is one of 7 APIs that Hyperline 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 3 paths, and defines 1 schema. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://api.hyperline.co/v1, https://sandbox.api.hyperline.co/v1.

5 operations 3 paths 1 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.hyperline.co/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — Authenticate with your Hyperline API key passed as a bearer token in the Authorization header - Authorization: Bearer .

Paths & Operations 5

Across 3 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
GET
/webhook-endpoints
List webhook endpoints
listWebhookEndpoints → 200
POST
/webhook-endpoints
Create a webhook endpoint
createWebhookEndpoint body → 201
PATCH
/webhook-endpoints/{id}
Update a webhook endpoint
updateWebhookEndpoint 1 param → 200
DELETE
/webhook-endpoints/{id}
Delete a webhook endpoint
deleteWebhookEndpoint 1 param → 204
GET
/webhook-messages
List delivered webhook messages
listWebhookMessages → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is WebhookEndpoint (3 properties). Each schema is shown below with its type and property counts.

WebhookEndpoint
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperline-webhooks-api-openapi.yml Raw ↑

Other APIs Hyperline publishes across the network.

Hyperline Billable Events API
Hyperline Customers API
Hyperline Invoices API
Hyperline Payments API
Hyperline Products API
Hyperline Subscriptions API