EntityTypes

string

Allowed values:billing-invoiceaccess-tokenwebhookdev-portaldataplane-groupregional-event-entitydataplanealerting-eventskai-enablemententerprise-trial

UserConfiguration

object

Properties of an event.

event_idstringrequired
event_titlestringrequired
event_descriptionstringrequired
event_namespacestringrequired

Allowed values:plan-and-usageorganizationdev-portalcloud-gatewaysregional-event-namespacegateway-manageradvanced-analytics

event_subscription_countintegerrequired

Default:0

default_subscriptionarray[object]required
Show Child Parameters
Example

DefaultSubscription

object
channelstringrequired

Allowed values:EMAILIN_APP

enabledbooleanrequired
Example

EventSubscriptionResponse

object

Properties associated with an event subscription.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

entity_typestringrequired

Allowed values:billing-invoiceaccess-tokenwebhookdev-portaldataplane-groupregional-event-entitydataplanealerting-eventskai-enablemententerprise-trial

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

regionsarray[string]required

Region associated to a notification.

Allowed values:USEUAUMEIN*

entitiesarray[string]required

ID of the entity. Use ‘*’ to represent all entities of this type.

channelsarray[object]required

Channel subscription details for an event.

Show Child Parameters
enabledbooleanrequired

Enable/Disable complete subscription within an event.

namestringrequired

User provided name of the subscription.

Example

EventSubscription

object

Properties associated with an event subscription.

regionsarray[string]required

Region associated to a notification.

Allowed values:USEUAUMEIN*

entitiesarray[string]required

ID of the entity. Use ‘*’ to represent all entities of this type.

channelsarray[object]required

Channel subscription details for an event.

Show Child Parameters
enabledbooleanrequired

Enable/Disable complete subscription within an event.

namestringrequired

User provided name of the subscription.

Example