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

Qwiet alerting API

Notification and alerting related endpoints (such as webhooks)

Qwiet alerting API is one of 27 APIs that Qwiet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include alerting. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 4 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 4.0.0.

Requests are made against a single base URL, https://app.shiftleft.io/api/v4.

4 operations 2 paths 9 schemas 1 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.0
Base URL
https://app.shiftleft.io/api/v4
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Qwiet alerting API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken).

  • BearerToken — Use of the Qwiet API requires an access token, which is available via the Qwiet Dashboard (either under [Account Settings](https://app.shiftleft.io/user/profil…

Paths & Operations 4

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

alerting 4

Notification and alerting related endpoints (such as webhooks)

PUT
/orgs/{orgID}/alerting/webhook
Set up a webhook
SetUpWebhook 2 params body → 200default
DELETE
/orgs/{orgID}/alerting/webhook
Delete a webhook
DeleteWebhook 2 params → 200default
GET
/orgs/{orgID}/alerting/webhook
Get a webhook
GetWebhook 2 params → 200default
GET
/alerting/events
Get alerting events
GetAlertingEvents → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are RegisterWebhookRequest (6 properties), WebhookTokenRenewMetadata (5 properties), Error (4 properties), WebhookConfigurationResponse (3 properties). Each schema is shown below with its type and property counts.

WebhookConfigurationResponse
object
3 properties
WebhookTokenRenewMetadata
object
5 properties
Error
object
4 properties 3 required
TokenRenewalResponseHandling
object
3 properties
ListEventsResponse
object
1 property
RegisterWebhookResponse
object
2 properties
SuccessResponse
object
1 property 1 required
RegisterWebhookRequest
object
6 properties 2 required
AuthenticatedWebHookTokenConfiguration
object
Configuration for a webhook that requires a token
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qwiet-alerting-api-openapi.yml Raw ↑

Other APIs Qwiet publishes across the network.

Qwiet analyze API
Qwiet app_groups API
Qwiet app_labels API
Qwiet apps API
Qwiet autofix API
Qwiet azureboard API
Qwiet branches API
Qwiet comments API
Qwiet compounds API
Qwiet findings API
Qwiet org_backup API
Qwiet orgs API