Create a new subscription for an event

Create a new subscription for an event.

post
https://global.api.konghq.com/v1/notifications/configurations/{eventId}/subscriptions

Path Parameters

eventIdstringrequired

Formatted string ID of the notification event.

Example:invoice-ready

Body

application/json

Request body schema for creating/updating event subscription.

EventSubscription

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.

Response

application/json

Response containing specific subscription details associated with an event.

EventSubscriptionResponse

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-groupdataplanekai-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.

post/notifications/configurations/{eventId}/subscriptions

Body

{ "name": "Control Plane Global", "regions": [ "US", "EU" ], "entities": [ "control-plane-1", "control-plane-2" ], "channels": [ { "type": "IN_APP", "enabled": true }, { "type": "EMAIL", "enabled": true } ], "enabled": true, "created_at": "2023-01-01T00:00:00.000Z", "updated_at": "2023-01-01T00:00:00.000Z" }
 
application/json

Get subscription for an event

Get subscription for an event.

get
https://global.api.konghq.com/v1/notifications/configurations/{eventId}/subscriptions/{subscriptionId}

Path Parameters

eventIdstringrequired

Formatted string ID of the notification event.

Example:invoice-ready

subscriptionIdstringrequired

Subscription ID of the user configuration.

Response

application/json

Response containing specific subscription details associated with an event.

EventSubscriptionResponse

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-groupdataplanekai-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.

get/notifications/configurations/{eventId}/subscriptions/{subscriptionId}
 
application/json

Update subscription for an event

Update subscription for an event.

patch
https://global.api.konghq.com/v1/notifications/configurations/{eventId}/subscriptions/{subscriptionId}

Path Parameters

eventIdstringrequired

Formatted string ID of the notification event.

Example:invoice-ready

subscriptionIdstringrequired

Subscription ID of the user configuration.

Body

application/json

Request body schema for creating/updating event subscription.

EventSubscription

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.

Response

application/json

Response containing specific subscription details associated with an event.

EventSubscriptionResponse

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-groupdataplanekai-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.

patch/notifications/configurations/{eventId}/subscriptions/{subscriptionId}

Body

{ "name": "Control Plane Global", "regions": [ "US", "EU" ], "entities": [ "control-plane-1", "control-plane-2" ], "channels": [ { "type": "IN_APP", "enabled": true }, { "type": "EMAIL", "enabled": true } ], "enabled": true, "created_at": "2023-01-01T00:00:00.000Z", "updated_at": "2023-01-01T00:00:00.000Z" }
 
application/json

Delete subscription associated with event

Delete subscription associated with event.

delete
https://global.api.konghq.com/v1/notifications/configurations/{eventId}/subscriptions/{subscriptionId}

Path Parameters

eventIdstringrequired

Formatted string ID of the notification event.

Example:invoice-ready

subscriptionIdstringrequired

Subscription ID of the user configuration.

Response

No Content

delete/notifications/configurations/{eventId}/subscriptions/{subscriptionId}
 

ListCursorMeta

Any Of
pageobjectrequired
Show Child Parameters
Example