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

Keygen Webhooks API

Webhook endpoints and events.

Keygen Webhooks API is one of 12 APIs that Keygen 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 7 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.keygen.sh/v1/accounts/{account}.

7 operations 4 paths 7 schemas 1 DELETE3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.keygen.sh/v1/accounts/{account}
Authentication
HTTP Bearer, HTTP Bearer, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 3

Keygen Webhooks API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (token) (bearerAuth). It accepts HTTP bearer tokens (license-key) (licenseKeyAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — Admin, environment, product, user, or license bearer token in the Authorization: Bearer header.
  • licenseKeyAuth — A license key passed as Authorization: License for license validation and self-service actions.
  • basicAuth — HTTP Basic (email:password) used only to generate a user token.

Paths & Operations 7

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

Webhooks 7

Webhook endpoints and events.

POST
/webhook-endpoints
Create a webhook endpoint
createWebhookEndpoint body → 201
GET
/webhook-endpoints
List all webhook endpoints
listWebhookEndpoints → 200
GET
/webhook-endpoints/{id}
Retrieve a webhook endpoint
retrieveWebhookEndpoint 1 param → 200
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-events
List all webhook events
listWebhookEvents → 200
POST
/webhook-events/{id}/actions/retry
Retry a webhook event
retryWebhookEvent 1 param → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PageLinks (5 properties), WebhookEventResource (3 properties), WebhookEndpointResource (3 properties), WebhookEventCollectionDocument (2 properties). Each schema is shown below with its type and property counts.

WebhookEventDocument
object
1 property
WebhookEndpointCollectionDocument
object
2 properties
WebhookEventCollectionDocument
object
2 properties
PageLinks
object
5 properties
WebhookEndpointDocument
object
1 property
WebhookEndpointResource
object
3 properties
WebhookEventResource
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keygen-webhooks-api-openapi.yml Raw ↑

Other APIs Keygen publishes across the network.

Keygen Artifacts API
Keygen Components API
Keygen Entitlements API
Keygen Licenses API
Keygen Machines API
Keygen Policies API
Keygen Processes API
Keygen Products API
Keygen Releases API
Keygen Tokens API
Keygen Users API