HEhere
Manage Subscriptions

Create a subscription

Changed on

Creates a subscription.

post/spaces/{spaceId}/subscriptions

Request

  • Base URL
    /hub (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /hub/spaces/{spaceId}/subscriptions
  • Auth
    • API key in query parameter access_token
    • or HTTP bearer

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

  • c9312a516dfcRevision changes
    • warning

      removed the request property /

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

  • d9e2b8df8c8aRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status