Subscriptions

Get an Installed App's Subscription

Get a specific subscription for the installed app.

get/installedapps/{installedAppId}/subscriptions/{subscriptionId}

Request

Response

The subscription

idstring ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$

The id of the subscription.

installedAppIdstring ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$

The id of the subscribing app.

sourceType'DEVICE' | 'CAPABILITY' | 'MODE' | 'DEVICE_LIFECYCLE' | 'DEVICE_HEALTH' | 'SECURITY_ARM_STATE' | 'HUB_HEALTH' | 'SCENE_LIFECYCLE'

The type of the event that is being subscribed to.

Example response

{
  "id": "5e1b134b-bd85-4125-9c25-4a8291e754aa",
  "installedAppId": "fb05c874-cf1d-406a-930c-69a081e0eaee",
  "sourceType": "DEVICE",
  "device": {
    "componentId": "main",
    "deviceId": "e457978e-5e37-43e6-979d-18112e12c961,",
    "capability": "contactSensor,",
    "attribute": "contact,",
    "stateChangeOnly": "true,",
    "subscriptionName": "contact_subscription',",
    "value": "*"
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.