Sign in
Manage Subscriptions

Create a subscription

Creates a subscription.

post/spaces/{spaceId}/subscriptions

Path parameters

spaceIdstring required

The unique identifier of the space.

Request body

idstring

The uniques identifier for the subscription.

sourcestring

The source for the subscribed notification (usually the space).

destinationstring

The destination for the subscribed notification.

Example request

{
  "id": "my-subscription-id",
  "status": {
    "state": "ACTIVE"
  },
  "filter": {
    "jsonPath": "$[?(@.properties.type == 'building')]"
  }
}

Response

The subscription

idstring

The uniques identifier for the subscription.

sourcestring

The source for the subscribed notification (usually the space).

destinationstring

The destination for the subscribed notification.

Example response

{
  "id": "my-subscription-id",
  "status": {
    "state": "ACTIVE"
  },
  "filter": {
    "jsonPath": "$[?(@.properties.type == 'building')]"
  }
}

Changes

Changed in 3 of the 50 revisions of this API.44

  • c9312a516dfc22See the full diff
    • ●

      removed the request property /

      request-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

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

  • d9e2b8df8c8a2See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • fb8e107462aa2See the full diff
    • ●

      removed the request property

      request-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

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