API ReferenceBoardsNotifications

Get notification rule

View as Markdown

The Slack webhook URL is never returned; slack_configured reports whether one is set.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID
board_idstringRequiredformat: "uuid"
rule_idstringRequiredformat: "uuid"

Headers

X-API-KeystringRequired
Your workspace API key.

Response

Successful Response
rule_idstringformat: "uuid"

Rule identifier, used as {rule_id} in nested routes

widget_idstringformat: "uuid"
Widget whose result this rule delivers
cronstring

Five-field cron expression, evaluated in Asia/Kolkata

enabledboolean
False while the schedule is paused
created_atdatetime
Creation time, UTC, RFC 3339
updated_atdatetime
Last change time, UTC, RFC 3339
namestring or nullOptional
Label for the rule, or null when unnamed
next_run_atdatetime or nullOptional
Next scheduled delivery, UTC. Null when the rule is disabled.
email_recipientslist of strings or nullOptional
Configured email recipients
slack_channel_namestring or nullOptional
Slack destination label, when one is configured
slack_configuredbooleanOptionalDefaults to false
True when a Slack webhook is set. The URL itself is never returned.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error