Impact Report Notifications
Impact Report notifications control whether the current user’s weekly Impact Report is delivered as a Slack DM. Reports are always generated for eligible engineers and visible in the Firetiger UI; this preference only controls Slack delivery.
Service: firetiger.impact_reports.v1.ImpactReportNotificationsService
Resource name pattern: impact-report-notification-preferences/{preference}
Access: Read-write, scoped to the authenticated user
Methods
| Method | Description |
|---|---|
| GetMyImpactReportNotificationPreference | Read the current user’s Impact Report delivery preference |
| UpdateMyImpactReportNotificationPreference | Update the current user’s Impact Report Slack DM toggle |
ImpactReportNotificationPreference
Stores the user’s explicit Slack override. An absent slack_enabled follows the server default: Slack delivery is on when the user’s Change Monitor Slack DMs are verified, off otherwise.
| Field | Type | Behavior | Description |
|---|---|---|---|
name |
string | OUTPUT_ONLY | Resource name (impact-report-notification-preferences/{preference}) |
slack_enabled |
boolean | Explicit Slack DM override. Unset means “follow the default” | |
create_time |
timestamp | OUTPUT_ONLY | When the preference was created |
update_time |
timestamp | OUTPUT_ONLY | When the preference was last modified |
delete_time |
timestamp | OUTPUT_ONLY | When the preference was soft-deleted |
GetMyImpactReportNotificationPreference
Read the current user’s Impact Report delivery preference along with the resolved effective value (preference override applied on top of the Slack-readiness default).
GET /v1/users/me/impact-report-notification-preference
Example
curl "https://api.cloud.firetiger.com/v1/users/me/impact-report-notification-preference" \
-u "$USERNAME:$PASSWORD"
Response
{
"preference": {
"name": "impact-report-notification-preferences/user-123",
"slackEnabled": true
},
"effectiveSlackEnabled": true
}
UpdateMyImpactReportNotificationPreference
Update the current user’s Impact Report Slack DM toggle. The write materializes the choice, so it stays stable if the user’s Change Monitor Slack setting changes later.
PATCH /v1/users/me/impact-report-notification-preference
Request body
| Field | Type | Required | Description |
|---|---|---|---|
slack_enabled |
boolean | Yes | Whether the weekly Impact Report is delivered as a Slack DM |
update_mask |
string | No | Comma-separated field mask naming the fields to write. The only supported path is slack_enabled. Defaults to slack_enabled when the field is present in the body |
Example (turn Impact Report Slack DMs off)
curl -X PATCH "https://api.cloud.firetiger.com/v1/users/me/impact-report-notification-preference" \
-u "$USERNAME:$PASSWORD" \
-H "Content-Type: application/json" \
-d '{
"slack_enabled": false,
"update_mask": "slack_enabled"
}'
Response
{
"preference": {
"name": "impact-report-notification-preferences/user-123",
"slackEnabled": false
},
"effectiveSlackEnabled": false
}
Related
- Impact Reports guide — what reports contain and who gets one
- Monitoring Plans — Change Monitor notification setup, including Slack DM verification (the default this preference overrides)