Subscription
A subscription registers a workspace user or a notification destination as a subscriber of a dashboard schedule. Each time the schedule runs, the subscriber receives a snapshot of the published dashboard, unless the subscription is refresh-only. See Manage scheduled dashboard updates and subscriptions.
Subscription object
A subscription registers a workspace user or a notification destination as a subscriber of a dashboard schedule. Each time the schedule runs, the subscriber receives a snapshot of the published dashboard, unless the subscription is refresh-only. See Manage scheduled dashboard updates and subscriptions.
- subscription_idstringOutput only
UUID identifying the subscription.
- schedule_idstringOutput only
UUID identifying the schedule to which the subscription belongs.
- dashboard_idstringOutput only
UUID identifying the dashboard to which the subscription belongs.
- subscriberobject
The subscriber that receives the dashboard snapshot. Exactly one of
user_subscriberanddestination_subscribermust be set.Show child attributesHide child attributes
- user_subscriberobject
The workspace user who receives the subscription.
Show child attributesHide child attributes
- user_idint64
The ID of the workspace user who receives the subscription, as returned by the Workspace Users API.
- destination_subscriberobject
The notification destination that receives the subscription, such as an email list or a Slack or Microsoft Teams channel. Workspace admins configure notification destinations.
Show child attributesHide child attributes
- destination_idstring
The UUID of the notification destination that receives the subscription, as returned by the Notification Destinations API.
- created_by_user_idint64Output only
UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule.
- etagstring
The etag of the subscription. It must be left empty on create. It can be passed as the
etagparameter of the delete method to make sure the subscription has not changed since it was read.
- create_timestringOutput only
A timestamp indicating when the subscription was created.
- update_timestringOutput only
A timestamp indicating when the subscription was last updated.
- skip_notifyboolean
Whether the subscription is refresh-only. When true, each scheduled run refreshes the dashboard data for the subscriber without sending a notification. Defaults to false. Refresh-only subscriptions are only allowed on dashboards published without embedded credentials.
Get schedule subscription GA
GET
Get schedule subscription.
The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access.
Account-level users who are not members of the workspace cannot call this endpoint, even if the dashboard has been shared with them.
API scopes: dashboards
Parameters
- dashboard_idstringRequiredpath
UUID identifying the dashboard to which the subscription belongs.
- schedule_idstringRequiredpath
UUID identifying the schedule to which the subscription belongs.
- subscription_idstringRequiredpath
UUID identifying the subscription.
Response
Returns the Subscription object.
List schedule subscriptions GA
GET
List schedule subscriptions.
The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access.
Account-level users who are not members of the workspace cannot call this endpoint, even if the dashboard has been shared with them.
API scopes: dashboards
Parameters
- dashboard_idstringRequiredpath
UUID identifying the dashboard to which the subscriptions belong.
- schedule_idstringRequiredpath
UUID identifying the schedule to which the subscriptions belong.
- page_sizeint32[ 1 .. 100 ]query
The number of subscriptions to return per page.
- page_tokenstringquery
A page token, received from a previous
ListSubscriptionscall. Use this to retrieve the subsequent page.
Response
Returns a list of Subscription objects.
Create schedule subscription GA
POST
Create schedule subscription. Subscribes a workspace user or a notification destination to the schedule, so that it receives a snapshot of the dashboard each time the schedule runs. Subscribing yourself requires CAN VIEW permission on the dashboard; subscribing another user or a notification destination requires CAN EDIT. On dashboards published without embedded credentials, you can only subscribe yourself. If the subscriber is already subscribed to the schedule, the existing subscription is returned.
The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access.
Account-level users who are not members of the workspace cannot call this endpoint, even if the dashboard has been shared with them.
API scopes: dashboards
Parameters
- dashboard_idstringRequiredpath
UUID identifying the dashboard to which the subscription belongs.
- schedule_idstringRequiredpath
UUID identifying the schedule to which the subscription belongs.
Request body
The subscription to create. A schedule is limited to 100 subscriptions.
- subscriberobjectRequired
The subscriber that receives the dashboard snapshot. Exactly one of
user_subscriberanddestination_subscribermust be set.Show child attributesHide child attributes
- user_subscriberobject
The workspace user who receives the subscription.
Show child attributesHide child attributes
- user_idint64Required
The ID of the workspace user who receives the subscription, as returned by the Workspace Users API.
- destination_subscriberobject
The notification destination that receives the subscription, such as an email list or a Slack or Microsoft Teams channel. Workspace admins configure notification destinations.
Show child attributesHide child attributes
- destination_idstringRequired
The UUID of the notification destination that receives the subscription, as returned by the Notification Destinations API.
- skip_notifyboolean
Whether the subscription is refresh-only. When true, each scheduled run refreshes the dashboard data for the subscriber without sending a notification. Defaults to false. Refresh-only subscriptions are only allowed on dashboards published without embedded credentials.
Response
Returns the Subscription object.
Delete schedule subscription GA
DELETE
Delete schedule subscription. The subscriber receives no further snapshots from the schedule. Deleting your own subscription requires CAN VIEW permission on the dashboard; deleting another user's or a notification destination's subscription requires CAN EDIT.
The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access.
Account-level users who are not members of the workspace cannot call this endpoint, even if the dashboard has been shared with them.
API scopes: dashboards
Parameters
- dashboard_idstringRequiredpath
UUID identifying the dashboard to which the subscription belongs.
- schedule_idstringRequiredpath
UUID identifying the schedule to which the subscription belongs.
- subscription_idstringRequiredpath
UUID identifying the subscription.
- etagstringquery
The etag of the subscription, as returned when it was read. If it is provided and no longer matches, the request fails with ABORTED and the subscription is not deleted.