Sign in
Notifications

List event subscriptions

List event subscriptions.

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

Path parameters

eventIdstring required
Example:invoice-ready

Formatted string ID of the notification event.

Response

A paginated list response for all subscriptions associated with an event.

Example response

{
  "data": [
    {
      "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ],
  "meta": {
    "page": {
      "size": 10
    }
  }
}

Changes

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

  • c80d57ed14ab431See the full diff
    • ▲

      the meta response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property meta/next from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property meta/previous from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property meta/size from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property meta/first from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property meta/last from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new enterprise-trial enum value to the data/items/entity_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added CursorMeta subschema #2 to the meta response property anyOf list for the response status 200

      response-property-any-of-added

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

  • 48b406d912db1See the full diff
    • ●

      added the new kai-enablement enum value to the data/items/entity_type response property for the response status 200

      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

  • 8ab3ec3ed3011See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

  • 3c0154b2053a11See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property detail became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property meta/first became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property meta/last became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 401

      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

  • 6333a0d3b09510See the full diff
    • ○

      removed EventSubscription subschema #1 from the data/items/ response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      added the required property data/items/channels to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/created_at to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/enabled to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/entities to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/entity_type to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/name to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/regions to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/updated_at to the response with the 200 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 data/items/channels from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/items/created_at from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/items/enabled from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/items/entities from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/items/entity_type from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/items/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/items/name from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/items/regions from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/items/updated_at from the response with the 200 status

      response-required-property-removed

    • ○

      added EventSubscription subschema #1 to the data/items/ response property allOf list for the response status 200

      response-property-all-of-added

  • 87c135153b842See the full diff
    • ●

      added the new dataplane enum value to the data/items/entity_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new dataplane-group enum value to the data/items/entity_type response property for the response status 200

      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