Skip to main content
POST
Create alert settings

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Alert settings

config
object
required
entity_id
string
required

entity_id is the id of the monitored entity: subscription id, subscription_line_item id, or group id, matching entity_type.

entity_type
enum<string>
required
Available options:
wallet,
feature,
subscription,
subscription_line_item,
group
parent_entity_id
string

parent_entity_id is the subscription id that owns a line-item or group alert. Required when entity_type is "subscription_line_item" or "group"; omitted for subscription-level alerts.

parent_entity_type
enum<string>
Available options:
wallet,
feature,
subscription,
subscription_line_item,
group

Response

Created

config
object
created_at
string<date-time>
created_by
string
enabled
boolean
entity_id
string
entity_type
enum<string>
Available options:
wallet,
feature,
subscription,
subscription_line_item,
group
environment_id
string
id
string
parent_entity_id
string
parent_entity_type
string
status
enum<string>
Available options:
published,
deleted,
archived
tenant_id
string
updated_at
string<date-time>
updated_by
string