notification_types

Creates, updates, deletes, gets or lists a notification_types resource.

Overview

Name	notification_types
Type	Resource
Id	confluent.notifications.notification_types

Fields

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").
description	string	Human readable description of the notification type
api_version	string	APIVersion defines the schema version of this representation of a resource.
category	string	Represents the group with which the notification is associated. Notifications are grouped under certain categories for better organization. - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are grouped here. - ACCOUNT: All Confluent account related notifications are grouped here. For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category.
display_name	string	Human readable display name of the notification type
is_included_in_plan	boolean	Whether this notification is available to subscribe or not as per the user's current billing plan.
kind	string	Kind defines the object this REST resource represents.
metadata	``	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
severity	string	Severity indicates the impact of this notification. - CRITICAL: a high impact notification which needs immediate attention. - WARN: a warning notification which can be addressed now or later. - INFO: an informational notification.
subscription_priority	string	Indicates whether the notification is auto-subscribed and if the user can opt-out. - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it.

Methods

Name	Accessible by	Required Params	Description
get_notifications_v1notification_type	SELECT	id	Make a request to read a notification type.
list_notifications_v1notification_types	SELECT		Retrieve a sorted, filtered, paginated list of all notification types.

SELECT examples

Retrieve a sorted, filtered, paginated list of all notification types.

SELECT
id,
description,
api_version,
category,
display_name,
is_included_in_plan,
kind,
metadata,
severity,
subscription_priority
FROM confluent.notifications.notification_types
;