Skip to content
Forgecroft Docs

User Notification Preferences

Viewing Your Preferences

Section titled “Viewing Your Preferences”
GET /me/notification-preferences

Response:

{ "channel": "email" }

Or with Slack connected:

{ "channel": "both", "slack_user_id": "U123456" }

Available Channels

Section titled “Available Channels”
ChannelDescription
emailReceive notifications via email
slack_dmReceive notifications via Slack direct message
bothReceive via both email and Slack DM
noneDo not receive personal notifications

Updating Your Preferences

Section titled “Updating Your Preferences”
PUT /me/notification-preferences
{
  "channel": "slack_dm"
}

The operation is idempotent — setting the same value is a no-op.

Slack DM Requirements

Section titled “Slack DM Requirements”

To use slack_dm or both, you must have:

  1. Connected your Slack account via the OAuth flow
  2. A matching Slack user ID stored in your preference record

Default

Section titled “Default”

If no preference record exists, the default is email.

Section titled “Related”