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

# 通知

> ワークフローの失敗などの通知先をまとめる通知セット、テスト送信、テスト用 Webhook 受け口、通知配信ログの使い方を説明します。

> この記事は Spumote のソースコードから生成した試験出力です。内容は確認中のため、正式な仕様は担当者に確認してください。

## この機能でできること

自動処理（ワークフロー）が失敗したときなどに、誰に・どこへ知らせるかをまとめて設定する機能です。送り先のまとまりを「通知セット」として登録し、ワークフローごとに選んで使います。

* **通知セット**: メールの送信先と Webhook（指定した URL へ自動でデータを送る仕組み。Slack などのチャットツールへの通知にも使われます）をまとめて登録します。
* **テスト送信**: 通知セットの設定が正しいか、試しに送って確かめます。
* **テスト用 Webhook 受け口**: Spumote の中に用意された「受け取り専用の URL」です。Webhook が本当に届いているかを、外部のツールを用意せずに確認できます。
* **通知配信ログ**: 通知がどの宛先に送られ、成功したか失敗したかを一覧で確認できます。

## 画面の場所

設定 › 通知

画面は上から「通知セット」「テスト用 Webhook 受け口」「通知配信ログ」の 3 つの欄で構成されています。

## 基本的な使い方

### 通知セットを作る

1. 設定 › 通知 を開き、「通知セットを作成」を押します。
2. 「名前」と、必要に応じて「説明」を入力します。
3. 「メール送信先」に、通知を受け取るメールアドレスを 1 行に 1 つずつ入力します。
4. Webhook でも通知したい場合は「Webhookを追加」を押し、「URL」と「ラベル」（見分けるための名前）を入力します。
5. 組織の既定にしたい場合は「デフォルトに設定」をオンにします。
6. 保存します。

一覧では、通知セットごとにメール送信先と Webhook の件数が表示されます。既定の通知セットには「デフォルト」のバッジが付きます。行を押すと編集できます。

### テスト送信する

1. 通知セットの行の右端にあるメニュー（「…」）から「テスト送信」を選びます。
2. 送り先（すべて／特定のメールアドレス／特定の Webhook）を選びます。
3. 件名と本文（あらかじめテスト用の文面が入っています）を確認して送信します。
4. 宛先ごとに成功・失敗の結果が表示されます。

テスト送信の結果も「通知配信ログ」に記録されます。

### ワークフローで通知セットを使う

ワークフローの編集画面の「設定」で「通知セット」を選ぶと、そのワークフローの実行の失敗や警告がその通知セットに送られます。「通知しない」を選ぶこともできます。詳しくは自動処理（ワークフロー）の記事を参照してください。

### テスト用 Webhook 受け口で届いたか確かめる

1. 設定 › 通知 の「テスト用 Webhook 受け口」欄に表示されている URL をコピーします（URL の後半は伏せ字で表示されます。目のアイコンで表示を切り替えられます）。
2. 通知セットの Webhook の「URL」にこの URL を貼り付けて保存します。
3. 「テスト送信」を行い、「テスト用 Webhook 受け口」欄の「更新」を押します。
4. 受信した日時・形式・サイズの一覧が表示され、行を開くと受け取った内容の先頭部分を確認できます。

URL が第三者に知られた心配がある場合は「トークン再発行」を押します。古い URL はすぐに使えなくなるので、通知セットに設定している場合は新しい URL に貼り替えてください。

### 通知配信ログを見る

「通知配信ログ」欄に、通知セット経由で送ったメールと Webhook の結果が新しい順に並びます。1 宛先 1 行です。

* チャネル（「全チャネル」／email／webhook）と、ステータス（「全ステータス」／「成功」／「失敗」）で絞り込めます。
* 「更新」で最新の状態にし、「もっと見る」で過去分を読み込みます。

## 設定項目

### 通知セット

| 項目 | 内容 |
| - | - |
| 名前 | 通知セットの名前（必須） |
| 説明 | 用途などのメモ（任意） |
| メール送信先 | 通知を受け取るメールアドレス。1 行に 1 アドレス。 |
| Webhook | 通知を送る URL。複数登録できます。 |
| └ URL | 送り先の URL |
| └ ラベル | 一覧やテスト送信で見分けるための名前 |
| └ ヘッダー (JSON) | 送り先が求める追加情報（データ担当者向け） |
| デフォルトに設定 | 組織の既定の通知セットにします。 |

### 詳しい設定（データ担当者向け）

* Webhook には、JSON 形式のデータが POST で送られます。テスト送信では、イベント名・送信日時・通知セットの ID と名前・テストの件名と本文が含まれます。
* 「ヘッダー (JSON)」には、送り先の認証などに必要な HTTP ヘッダーを JSON で指定します。
* 社内ネットワーク向けのアドレスなど、安全でない宛先への Webhook 送信は拒否されます。

## 活用例

* **データ連携の失敗にすぐ気づく**: データ担当チームのメーリングリストと、チームの Slack チャンネルの Webhook を 1 つの通知セットにまとめ、本番のワークフローに設定します。夜間の取り込み失敗にも翌朝すぐ気づけます。
* **本番前の疎通確認**: 新しく Webhook を登録する前に、まず「テスト用 Webhook 受け口」の URL で通知の形式を確認し、問題なければ本来の URL に差し替えます。
* **「通知が来ない」の切り分け**: 通知配信ログで「成功」になっていれば Spumote からは送れています。受け手側（メールの迷惑メールフォルダや Slack の設定）を確認します。

## 注意点・制限

* 本番のワークフローに通知セットが設定されていないと、一覧に「通知未設定」の印が付き、警告が表示されます。失敗に気づけない可能性があるため、本番では必ず設定してください。
* 試作のワークフローには、通知セットを明示的に設定した場合だけ通知されます（組織の既定の失敗通知は送られません）。
* テスト用 Webhook 受け口の受信ログは 14 日で自動削除されます。一覧には直近 50 件が表示され、保存される内容は先頭 4KB までです。
* テスト用 Webhook 受け口が受け取れるデータは 1 回あたり 256KB まで、組織ごとに 1 分間 60 回までです。
* 通知配信ログは 90 日で自動削除されます。1 回に 50 件ずつ表示されます。
* Webhook の送信は 10 秒で打ち切られ、応答がなければ失敗として記録されます（テスト送信の場合）。
* テスト送信の件名は 500 文字まで、本文は 10,000 文字までです。

## 関連ページ

* 自動処理（ワークフロー）の各記事
* [01-4 監査ログ](/common/audit-logs)


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