Skip to main content
POST
Create Subscription

Authorizations

X-API-Key
string
header
required

Query Parameters

entity_types
string[]
severity_filter
enum<string>[]
Available options:
critical,
high,
medium,
low,
informational
jurisdictions
string[]
tier
enum<string>
default:basic
Available options:
basic,
pro,
enterprise
webhook_url
string | null

Response

Successful Response

A new subscription plus the delivery status of its alert feed (#521).

id
string
required

Subscription ID

notice
string
required

Whether the subscribed alert feed has anything to deliver

entity_types
string[]

Sector filters

severity_filter
enum<string>[]

Minimum severity to receive

Available options:
critical,
high,
medium,
low,
informational
jurisdictions
string[]

Jurisdiction filters

tier
enum<string>
default:basic
Available options:
basic,
pro,
enterprise
webhook_url
string | null

Webhook URL for enterprise tier

created_at
string<date-time>