Notifications

Create a new subscription for an event

Changed on

Create a new subscription for an event.

post/v1/notifications/configurations/{eventId}/subscriptions

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/notifications/configurations/{eventId}/subscriptions
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

eventIdstring required
Example:invoice-ready

Formatted string ID of the notification event.

Request body

regionsNotificationRegion[] required
entitiesstring[] required
enabledboolean required

Enable/Disable complete subscription within an event.

namestring required

User provided name of the subscription.

Response

Response containing specific subscription details associated with an event.

idstring uuid required

Contains a unique identifier used for this resource.

entity_type'billing-invoice' | 'access-token' | 'webhook' | 'dev-portal' | 'dataplane-group' | 'dataplane' | 'kai-enablement' | 'enterprise-trial' required
created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

regionsNotificationRegion[] required
entitiesstring[] required
enabledboolean required

Enable/Disable complete subscription within an event.

namestring required

User provided name of the subscription.

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status