# 通知設計書 30-post.unpublished

## 概要

本ドキュメントは、Ghost CMSにおける投稿非公開時のWebhook通知（`post.unpublished`イベント）の設計仕様を記載する。

### 本通知の処理概要

投稿（Post）が非公開（unpublish）になった際にトリガーされるWebhook通知である。公開済みコンテンツが下書き状態に戻されたことを外部システムに通知し、検索インデックスからの削除、キャッシュの無効化、リンク切れ対応などを実現する。

**業務上の目的・背景**：公開済みコンテンツを非公開にする操作は、読者や外部システムに直接影響を与える重要なアクションである。誤公開の取り下げ、期間限定コンテンツの終了、内容見直しのための一時非公開など、様々な理由で発生する。外部システムに非公開を通知することで、検索エンジンからの削除、CDNキャッシュのパージ、404ページの設定などを自動化できる。

**通知の送信タイミング**：投稿の`status`が`published`から別の状態（draft等）に変更され、`post.unpublished`イベントが発行された時点で、登録されているすべてのWebhookに対してHTTPリクエストが送信される。

**通知の受信者**：Ghost管理画面のIntegration設定でこのイベントに対して登録されたWebhookエンドポイント。

**通知内容の概要**：非公開後の投稿データ（current）と、非公開前データ（previous）が含まれる。statusの変更が主要な情報となる。

**期待されるアクション**：Webhook受信側システムは、コンテンツの非公開として処理し、インデックス削除、キャッシュパージ、リダイレクト設定などを実行する。

## 通知種別

Webhook（HTTP POST）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（イベントリスナー経由） |
| 優先度 | 高（公開コンテンツの状態変更） |
| リトライ | 5回（テスト環境では0回） |

### 送信先決定ロジック

1. `webhooks`テーブルから`event = 'post.unpublished'`のレコードを全件取得
2. `customIntegrations`プラン制限が有効な場合、`internal`タイプのIntegrationに紐づくWebhookのみ対象
3. 各Webhookの`target_url`に対してHTTPリクエストを送信

## 通知テンプレート

### Webhook通知の場合

| 項目 | 内容 |
|-----|------|
| HTTPメソッド | POST |
| Content-Type | `application/json` |
| Content-Version | `v{ghostVersion.safe}` |
| タイムアウト | 2000ms |

### ペイロード構造

```json
{
    "post": {
        "current": {
            "id": "5ddc9141c35e7700383b2937",
            "uuid": "a5aa9bd8-ea31-415c-b452-3040dae1e730",
            "title": "Post Title",
            "slug": "post-title",
            "html": "<p>Post content...</p>",
            "plaintext": "Post content...",
            "status": "draft",
            "visibility": "public",
            "updated_at": "2024-01-03T00:00:00.000Z",
            "published_at": null,
            "tags": [...],
            "authors": [...]
        },
        "previous": {
            "status": "published",
            "published_at": "2024-01-02T00:00:00.000Z",
            "updated_at": "2024-01-02T00:00:00.000Z"
        }
    }
}
```

**注意**: `previous.status`が`published`であり、`current.status`が`draft`等に変更されていることが重要な情報。

### 署名ヘッダー（オプション）

Webhookに`secret`が設定されている場合：

```
X-Ghost-Signature: sha256={HMAC-SHA256(payload + timestamp)}, t={timestamp}
```

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| post.current | 非公開後の投稿データ | Postモデル（シリアライズ済み） | Yes |
| post.previous | 非公開前データ（変更フィールドのみ） | Postモデル._previousAttributes | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| モデルイベント | `post.unpublished` | Webhookが登録されている | 投稿非公開時に自動送信 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Webhook未登録 | このイベントに対するWebhookが1件も登録されていない場合 |
| インポート時 | `options.importing === true`の場合は送信しない |
| プラン制限 | `customIntegrations`制限時、internalタイプ以外のIntegrationのWebhookは除外 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[status: published → draft] --> B{importingフラグ?}
    B -->|true| C[終了]
    B -->|false| D[events.emit post.unpublished]
    D --> E[WebhookTrigger.trigger]
    E --> F[getAll - Webhook取得]
    F --> G{Webhook数確認}
    G -->|0件| C
    G -->|1件以上| H[payloadシリアライズ]
    H --> I[各Webhookにループ]
    I --> J[HTTPリクエスト送信]
    J --> K{送信結果}
    K -->|成功| L[onSuccess]
    K -->|410| M[Webhook削除]
    K -->|エラー| N[onError]
    L --> O{次のWebhook}
    M --> O
    N --> O
    O -->|あり| I
    O -->|なし| C
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| webhooks | 登録Webhook取得 | `event = 'post.unpublished'`でフィルタ |
| integrations | Integration情報 | プラン制限時の判定用 |
| posts | 投稿データ | イベント引数から取得 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| webhooks | UPDATE | 送信結果の記録 |
| webhooks | DELETE | 410レスポンス時の自動削除 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 410 Gone | Webhookエンドポイントが410を返した | Webhook自動削除 |
| タイムアウト | 2000ms以内にレスポンスなし | エラー記録、リトライ |
| ネットワークエラー | 接続失敗 | エラー記録、リトライ |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 5回（本番）、0回（テスト環境） |
| リトライ間隔 | @tryghost/requestライブラリのデフォルト |
| リトライ対象エラー | タイムアウト、ネットワークエラー、5xxエラー |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし（イベント発生時に即時送信）

## セキュリティ考慮事項

- Webhook URLはIntegration管理者のみが設定可能
- `secret`設定時はHMAC-SHA256署名をヘッダーに付与
- 非公開になったコンテンツでも、URLスラッグ等の情報は含まれる

## 備考

- 投稿削除（`post.deleted`）とは異なり、コンテンツ自体は残っている
- 非公開後に再公開された場合は`post.published`イベントが発火する
- `published_at`がnullにリセットされる場合がある
- 検索エンジンへのnoindex通知やサイトマップ更新に活用可能

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: イベント定義を確認する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | listen.js | `ghost/core/core/server/services/webhooks/listen.js` | 18行目、`post.unpublished`イベント定義 |

#### Step 2: シリアライズ処理を理解する

No.27「post.edited」と同じシリアライズ処理を参照。status変更が`_changed`に含まれることがポイント。

#### Step 3: Webhook送信処理（共通）

No.25「post.added」と同じ処理フローを参照。

### プログラム呼び出し階層図

```
Post status: published → draft
    │
    └─ events.emit('post.unpublished')
           │
           └─ processWebhookTrigger(model, options)
                  │
                  └─ webhookTrigger.trigger('post.unpublished', model)
                         │
                         ├─ getAll('post.unpublished')
                         │
                         ├─ payload(event, model)
                         │      └─ serialize(event, model)
                         │             ├─ current: status=draft
                         │             └─ previous: status=published
                         │
                         └─ request(url, opts)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| listen.js | `ghost/core/core/server/services/webhooks/listen.js` | ソース | イベントリスナー登録 |
| webhook-trigger.js | `ghost/core/core/server/services/webhooks/webhook-trigger.js` | ソース | Webhook送信ロジック |
| serialize.js | `ghost/core/core/server/services/webhooks/serialize.js` | ソース | ペイロードシリアライズ |
