Skip to main content
GET
List the subscribable alert vocabulary

Authorizations

Authorization
string
header
required

A Barndoor API key, sent as Authorization: Bearer <key>. Keys are prefixed bdai_ and are opaque — do not attempt to decode one. Interchangeable with an OAuth 2.0 access token.

Scopes

openid

Issue an OIDC ID token identifying the caller.

profile

Read the caller's basic profile claims.

email

Read the caller's email address.

Response

Successful Response

The subscription vocabulary, enumerated server-side so new alert types appear to every client without a code change. alert_types is filtered to what the caller's organization is admitted to; categories and severities are the full closed label vocabularies the types reference. Fetch this before building a subscription set rather than hardcoding enum names.

alert_types
AlertTypeOption · object[]
required

Every alert type your organization may subscribe a channel to. Authoritative: types withheld here are gated off for this organization and subscribing to one is inert. Read this instead of hardcoding the enum — the set grows over time.

categories
LabeledOption · object[]
required

The categories your organization may see, in display order. A category whose every alert type is gated off for this organization is withheld entirely, so it needs no client-side handling; a category that is simply reserved and has no alert types yet is still listed and groups nothing.

severities
LabeledOption · object[]
required

The full severity vocabulary, unfiltered.