サマリー
このドキュメントでは、以下の内容について説明します。
- Discourse で Zendesk の同期設定を有効にする
- Zendesk ウェブフックを設定する
- Zendesk トリガーを設定する
Zendesk 同期設定の有効化
最初に、Zendesk プラグインを有効にし、同期設定を有効にし、安全なトークンを提供する必要があります。
- プラグイン設定に移動: Discourse サイトにアクセスし、Zendesk プラグイン設定ページ（
/admin/plugins/discourse-zendesk-plugin）に移動します。または、/admin/site_settingsで検索して設定を見つけることもできます。 - プラグインを有効にする:
zendesk enabled設定を探し、まだ有効になっていない場合は有効にします。 - 同期設定を有効にする:
sync comments from zendesk設定を探し、有効にします。 - ウェブフックトークンを提供する:
zendesk incoming webhook tokenで、ランダムで安全な文字列を生成して追加します。このトークンは、後で Zendesk のウェブフックを設定するために使用されます。 - 自動生成カテゴリを設定する: 双方向同期は、Zendesk チケットの自動生成が設定されているカテゴリのトピックでのみ機能します。
zendesk autogenerate all categoriesを有効にするか、zendesk autogenerate categories設定に特定のカテゴリを追加します。これを行わないと、ウェブフックは受信したコメントをサイレントに無視します。
Zendesk ウェブフックの設定
Zendesk でウェブフックを設定するには、次の手順に従います。
- ウェブフックページへのアクセス: Zendesk で アプリと統合 → ウェブフック の下にあるウェブフックセクションに移動します。
- サンプル URL:
https://<instance_name>.zendesk.com/admin/apps-integrations/webhooks/webhooks
- サンプル URL:
- ウェブフックの作成:
- 右上隅にある アクション ボタンをクリックします。
- ウェブフックを作成 を選択します。
- ウェブフックの詳細を入力します。
- リクエストメソッド:
PUT - エンドポイント URL:
https://<discourse.example.com>/zendesk-plugin/sync - リクエスト形式: JSON
- リクエストメソッド:
- ウェブフックのテスト:
- ウェブフックをテスト ボタンをクリックします。
- ドロップダウンから「カスタムテスト」を選択します。
- JSON を以下に置き換え、トークンを挿入します。
{
"ticket_id": "{{ticket.id}}",
"topic_id": "{{ticket.external_id}}",
"email": "{{current_user.email}}",
"token": "INSERT TOKEN HERE"
}
- テストを送信 をクリックします。成功を示す HTML ページが表示された
400 Bad Requestを肯定的なシグナルとして期待します。
Zendesk トリガーの設定
Zendesk でトリガーを設定してアクションを自動化します。
- トリガーページへのアクセス: Zendesk で 管理者 → オブジェクトとルール → ビジネスルール → トリガー の下にあるトリガーセクションに移動します。
- サンプル URL:
https://<instance_name>.zendesk.com/admin/objects-rules/rules/triggers
- サンプル URL:
- トリガーの作成:
- トリガーを追加 をクリックします。
- 名前を「Discourse Sync」とし、カテゴリを「通知」に設定します。
- 以下の図に示すように、条件とアクションを設定します。
- トークンを再度「INSERT TOKEN HERE」に置き換えて、テストウェブステップと同じ JSON ボディを使用します。
- トリガーの保存: 設定が完了したら、トリガーを保存するようにします。
しかし、Zendesk のコメントに添付ファイルが含まれている場合に問題が発生しています。メッセージは届いていますが、添付ファイルがありません。添付ファイルを処理するために、Webhook で追加のパラメータを渡す必要があるかどうかはわかりません。これに必要な特定のパラメータがあるかどうか、どなたか明確にしていただけますでしょうか？
