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 Notification Webhooks API

The Notification Webhooks API from APIs.io Engineering Platform — 2 operation(s) for notification webhooks.

This API exposes 5 operations across 2 paths, and defines 20 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.

5 operations 2 paths 20 schemas 1 DELETE2 GET1 POST1 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 Notification 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 5

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

Notification Webhooks 5
GET
/accounts/{account_id}/alerting/v3/destinations/webhooks
APIs.io Engineering Platform List webhooks
notification-webhooks-list-webhooks 1 param → 4XX200
POST
/accounts/{account_id}/alerting/v3/destinations/webhooks
APIs.io Engineering Platform Create a webhook
notification-webhooks-create-a-webhook 1 param body → 4XX201
DELETE
/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}
APIs.io Engineering Platform Delete a webhook
notification-webhooks-delete-a-webhook 2 params → 4XX200
GET
/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}
APIs.io Engineering Platform Get a webhook
notification-webhooks-get-a-webhook 2 params → 4XX200
PUT
/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}
APIs.io Engineering Platform Update a webhook
notification-webhooks-update-a-webhook 2 params body → 4XX200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are aaa_webhooks (8 properties), aaa_result_info (4 properties), aaa_schemas-api-response-common-failure (3 properties), aaa_api-response-common (3 properties). Each schema is shown below with its type and property counts.

aaa_id_response
aaa_webhook-id
string
The unique identifier of a webhook
aaa_created_at
string
Timestamp of when the webhook destination was created.
aaa_schemas-single_response
aaa_api-response-single
object
aaa_components-schemas-name
string
The name of the webhook destination. This will be included in the request body when you receive a webhook notification.
aaa_result_info
object
4 properties
aaa_uuid
string
UUID
aaa_api-response-common
object
3 properties 3 required
aaa_schemas-api-response-common-failure
object
3 properties 3 required
aaa_last_success
string
Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.
aaa_url
string
The POST endpoint to call when dispatching a notification.
aaa_account-id
string
The account id
aaa_webhooks_components-schemas-response_collection
aaa_api-response-collection
object
aaa_last_failure
string
Timestamp of the last time an attempt to dispatch a notification to this webhook failed.
aaa_webhooks
object
8 properties
aaa_secret
string
Optional secret that will be passed in the cf-webhook-auth header when dispatching generic webhook notifications or formatted for supported destinations. Secre…
aaa_components-schemas-type
string
Type of webhook endpoint.
aaa_messages
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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