Notifications

Create a new subscription for an event

Create a new subscription for an event.

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

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

Changed in 7 of the 75 revisions of this API.18511

    • added the new enterprise-trial enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new kai-enablement enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new type enum value to the /////// response property for the response status

      response-property-enum-value-added

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed subschema #1 from the response body allOf list for the response status

      response-body-all-of-removed

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76b0fefddb0d91See the full diff
    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • added subschema #1 to the response body allOf list for the response status

      response-body-all-of-added

    • added the new dataplane enum value to the response property for the response status

      response-property-enum-value-added

    • added the new dataplane-group enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog