Update notification
Update notification.
Path Parameters
ID of the notification.
Body
application/json
Body
Request body schema for updating notification status.
NotificationUpdatePayload
Status of the notification.
Status of the notification.
Allowed values:READUNREADARCHIVED
Response
application/json
Response
View a single notification.
Notification
Properties of a notification.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Status of the notification.
Allowed values:READUNREADARCHIVED
Region associated to a notification.
Allowed values:USEUAUMEIN*
Allowed values:plan-and-usageorganizationdev-portalcloud-gatewaysregional-event-namespacegateway-manageradvanced-analytics
ID of the entity. Use ‘*’ to represent all entities of this type.
Metadata associated with the notification to build actionable links.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
List available user configurations
List available user configurations.
Query Parameters
Filters a collection of configurations.
Show Child Parameters
Response
application/json
Response
A paginated list response for all notification events and user subscriptions.
Properties of an event.
Show Child Parameters
Authentication
Query Parameters
List event subscriptions
List event subscriptions.
Path Parameters
Formatted string ID of the notification event.
Example:invoice-ready
Response
application/json
Response
A paginated list response for all subscriptions associated with an event.
Properties associated with an event subscription.
Show Child Parameters
Any OfPagination metadata.
Show Child Parameters
Authentication
Path Parameters
Create a new subscription for an event
Create a new subscription for an event.
Path Parameters
Formatted string ID of the notification event.
Example:invoice-ready
Body
application/json
Body
Request body schema for creating/updating event subscription.
EventSubscription
Properties associated with an event subscription.
Region associated to a notification.
Allowed values:USEUAUMEIN*
ID of the entity. Use ‘*’ to represent all entities of this type.
Channel subscription details for an event.
Show Child Parameters
Enable/Disable complete subscription within an event.
User provided name of the subscription.
Response
application/json
Response
Response containing specific subscription details associated with an event.
EventSubscriptionResponse
Properties associated with an event subscription.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Allowed values:billing-invoiceaccess-tokenwebhookdev-portaldataplane-groupregional-event-entitydataplanealerting-eventskai-enablemententerprise-trial
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Region associated to a notification.
Allowed values:USEUAUMEIN*
ID of the entity. Use ‘*’ to represent all entities of this type.
Channel subscription details for an event.
Show Child Parameters
Enable/Disable complete subscription within an event.
User provided name of the subscription.
Authentication
Path Parameters
Body
Get subscription for an event
Get subscription for an event.
Path Parameters
Formatted string ID of the notification event.
Example:invoice-ready
Subscription ID of the user configuration.
Response
application/json
Response
Response containing specific subscription details associated with an event.
EventSubscriptionResponse
Properties associated with an event subscription.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Allowed values:billing-invoiceaccess-tokenwebhookdev-portaldataplane-groupregional-event-entitydataplanealerting-eventskai-enablemententerprise-trial
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Region associated to a notification.
Allowed values:USEUAUMEIN*
ID of the entity. Use ‘*’ to represent all entities of this type.
Channel subscription details for an event.
Show Child Parameters
Enable/Disable complete subscription within an event.
User provided name of the subscription.