Skip to main content
PUT
Turn failed-run alerts on or off, choose whether each workflow’s owner is emailed, and set extra recipients. When a workflow fails, each recipient gets one email naming the workflow, how many times it failed, the error, and a link to its runs. An owner hears about their own workflows; an extra recipient hears about all of them.
On by default, to the workflow’s owner. The owner is whoever last turned the workflow on, else whoever created it. When neither is recorded, or that person is no longer a member of the workspace, the email goes to the workspace admins. Addresses are de-duplicated across the owner, the admins and the extra recipients.
At most one email a day per unique failure. A workflow failing the same way every hour is mentioned once; a new way of failing is mentioned on the next check, within fifteen minutes. Import jobs and the built-in scans are not covered yet; they stay on the Runs feed and the Needs attention lens the email links to.

Authorizations

Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Body

application/json
enabled
boolean
recipients
string<email>[]
notify_defaults
boolean

Also email each failing workflow's owner (or the workspace admins when it has none). Optional; absent keeps the saved value, on by default.

Response

Typed result envelope.

success
boolean
required
data
object
required