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

APIs.io Engineering Platform Webhooks API

The **Webhooks** endpoints enable you to manage [custom webhooks](https://learning.postman.com/docs/running-collections/collection-webhooks/).

This API exposes 1 operation across 1 path, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

1 operations 1 paths 5 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

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

Webhooks 1

The Webhooks endpoints enable you to manage [custom webhooks](https://learning.postman.com/docs/running-collections/collection-webhooks/).

POST
/webhooks
APIs.io Engineering Platform Create a webhook
createWebhook 1 param body → 200400401403500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are featureUnavailable403Error (4 properties), createWebhookParamMissing400Error (1 property), createWebhookResponse (1 property), createWebhookRequest (1 property). Each schema is shown below with its type and property counts.

workspaceId
string
featureUnavailable403Error
object
4 properties
createWebhookRequest
object
1 property
createWebhookResponse
object
1 property
createWebhookParamMissing400Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-webhooks-api-openapi.yml Raw ↑