---
title: "List Notification Rules"
method: POST
path: "/api/agent/deployments/{deploymentId}/actions/list"
tags: ["NotificationRulesService"]
---

# List Notification Rules

`POST /api/agent/deployments/{deploymentId}/actions/list`

List notification rules

## Path parameters

- `deploymentId` integer, required

## Request body

- ProtosNotificationRulesV1ListNotificationRulesRequest — List
  - `deploymentId` integer
  - `options` ProtosCommonV1PaginateOptions
    - `optionalLimit` integer
    - `cursor` ProtosCommonV1Cursor
      - `token` string
  - `filters` ProtosNotificationRulesV1ListNotificationRulesFilter
    - `channel` 'CHANNEL_EMAIL' | 'CHANNEL_SLACK_WEBHOOK' | 'CHANNEL_WEBHOOK' | 'CHANNEL_S3', enum — | value | description | |-------|---------------| | CHANNEL_EMAIL | | | CHANNEL_SLACK_WEBHOOK | | | CHANNEL_WEBHOOK | | | CHANNEL_S3 | |

## Response `200`

OK

- ProtosNotificationRulesV1ListNotificationRulesResponse
  - `notification_rules` ProtosNotificationRulesV1NotificationRule[]
    - `id` integer
    - `channel` string
    - `config` object
    - `is_enabled` boolean
    - `name` string
    - `policy_slugs` string[]
    - `use_network_broker` boolean
    - `config_error` string — Populated when stored config cannot build a notifier (e.g. invalid URL). Omitted when healthy.
    - `send_scan_completion` boolean — When true, this webhook is sent an event each time a scan completes. Defaults to true for new rules. Only meaningful for CHANNEL_WEBHOOK.

---

[API](https://skmtc.dev/semgrep/apis/semgrep-web-app.md) · [All operations](https://skmtc.dev/semgrep/apis/semgrep-web-app/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/semgrep/semgrep-web-app/revisions/6483eeecd582/schema)