StatusDashboard
DashboardsSubscriptions

Get subscription config

Retrieve the subscription channel configuration for a dashboard.

View Markdown

GET /app/dashboards/{id}/subscriptions

Returns the current subscription channel configuration for a dashboard.


Path parameters

ParameterDescription
idThe UUID of the dashboard.

Request

See API Basics for required headers.

This endpoint takes no request body.


Sample request

curl https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/subscriptions \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Sample response

Status: 200 OK

{
  "email":   { "enabled": true },
  "sms":     { "enabled": false },
  "webhook": { "enabled": true },
  "teams":   { "enabled": false },
  "gchat":   { "enabled": false }
}

Response fields

Same field meanings as Update subscription config.

FieldTypeDescription
email.enabledbooleanCustomer intent: whether email subscriptions are enabled on this dashboard.
sms.enabledbooleanCustomer intent: whether SMS subscriptions are enabled on this dashboard.
webhook.enabledbooleanCustomer intent: whether webhook subscriptions are enabled on this dashboard.
teams.enabledbooleanCustomer intent: whether Microsoft Teams subscriptions are enabled on this dashboard.
gchat.enabledbooleanCustomer intent: whether Google Chat subscriptions are enabled on this dashboard.

This endpoint returns saved toggle state only. For the effective public availability (plan + toggle), see subscriptions on GET /dashboard/status.


Error responses

StatusWhen
404Dashboard not found or does not belong to the caller's organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.