> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heliyos.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Notification settings

> 2 tools: heliyos_notification_settings_get, heliyos_notification_settings_update.

| Tool | What it does | Kind |
| - | - | - |
| [`heliyos_notification_settings_get`](#heliyos-notification-settings-get) | Get notification settings | Read |
| [`heliyos_notification_settings_update`](#heliyos-notification-settings-update) | Update notification settings | Write |

Write and destructive tools change your workspace. Clients that support it ask before they run.

## Get notification settings

`heliyos_notification_settings_get` · **Read** · Idempotent

Returns the workspace's notification email settings: whether they are on, who receives them, and which events notify (each immediate or in a daily digest). Returns structuredContent \{settings:\{configured, is\_active, notify\_emails, event\_types:\[\{type, frequency}]}}.

This tool takes no inputs.

### Returns

A readable text summary, plus `structuredContent` with `settings`.

### API endpoints

* [Get notification settings](https://docs.heliyos.ai/api-reference/notification-settings/get-notification-settings.md) · `GET /v1/platform/notification-settings`

## Update notification settings

`heliyos_notification_settings_update` · **Write** · Idempotent

Changes the workspace's notification email settings. Each key you pass REPLACES that setting: notify\_emails is the full recipient list and event\_types the full list of notifying events (read the current ones with heliyos\_notification\_settings\_get and send the complete list). Keys you leave out are kept. scout.signal\_detected is always immediate. Returns structuredContent \{settings}.

### Inputs

**is\_active** `boolean`

Turns all notification emails on or off.

**notify\_emails** `string[]`

Every recipient address (replaces the list). Up to 50 items.

**event\_types** `object[]`

Every event that should notify, each immediate or daily (replaces the list). Up to 10 items.

**item properties**

**type** `string` *required*

The event, for example task.created or deal.approval. One of `task.created`, `task.updated`, `deal.created`, `deal.updated`, `deal.approval`, `leadset.created`, `leadset.records.available`, `organization.daily_summary`, `scout.signal_detected`, `integration.not_synced`.

**frequency** `string` *required*

"immediate" (one email per event) or "daily" (in the daily digest). One of `immediate`, `daily`.

### Returns

A readable text summary, plus `structuredContent` with `settings`.

### API endpoints

* [Update notification settings](https://docs.heliyos.ai/api-reference/notification-settings/update-notification-settings.md) · `PATCH /v1/platform/notification-settings`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.