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 Stream Webhook API

The Stream Webhook API from APIs.io Engineering Platform — 1 operation(s) for stream webhook.

This API exposes 3 operations across 1 path, and defines 9 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.

3 operations 1 paths 9 schemas 1 DELETE1 GET1 PUT

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 Stream Webhook 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 3

Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Stream Webhook 3
DELETE
/accounts/{account_id}/stream/webhook
APIs.io Engineering Platform Delete webhooks
stream-webhook-delete-webhooks 1 param body → 4XX200
GET
/accounts/{account_id}/stream/webhook
APIs.io Engineering Platform View webhooks
stream-webhook-view-webhooks 1 param → 4XX200
PUT
/accounts/{account_id}/stream/webhook
APIs.io Engineering Platform Create webhooks
stream-webhook-create-webhooks 1 param body → 4XX200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are stream_api-response-common-failure (4 properties), stream_api-response-common (3 properties), stream_webhook_request (1 property). Each schema is shown below with its type and property counts.

stream_notificationUrl
string
The URL where webhooks will be sent.
stream_account_identifier
string
The account identifier tag.
stream_webhook_response_single
stream_deleted_response
stream_api-response-common-failure
object
4 properties 4 required
stream_api-response-common
object
3 properties 3 required
stream_messages
array
stream_api-response-single
object
stream_webhook_request
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-stream-webhook-api-openapi.yml Raw ↑