Discourse Zendesk

:discourse2: 概要 DiscourseのトピックからZendeskチケットを作成します。
:open_book: インストールガイド このプラグインはDiscourseコアにバンドルされています。プラグインを個別にインストールする必要はありません。

:warning: Zendeskは2027年4月30日にAPIトークン認証を恒久的に無効化します。既存のインストール環境はOAuthによる認証に移行する必要があります

機能

Zendeskチケットの作成

このプラグインを使用すると、DiscourseのトピックからZendeskチケットを作成できます。これは、カテゴリ内のすべてのトピックが自動的にZendeskチケットを生成するようにプラグインを設定すること、または、各トピックの下に表示されるサイトスタッフ用の「Zendeskチケットを作成」ボタンをクリックして個々のトピックをZendeskにプッシュすることによって行われます:

チケットが作成されると、トピックの最初の投稿の著者がZendeskのRequester(依頼者)として設定されます。また、そのユーザーはZendeskのカスタマーリストにも追加されます。

チケットが作成された後、「Zendeskチケットを作成」ボタンは「Zendeskで表示」に更新されます。そのボタンをクリックすると、関連するZendeskチケットに移動します:

Discourseで作成された返信をZendeskにプッシュ

このプラグインでは、Discourseトピックへのすべての返信をZendeskチケットにプッシュするか、トピックの著者が作成した返信のみをプッシュするかのオプションを選択できます。これらの両方の機能は、プラグインの設定で構成可能です。

ZendeskコメントとDiscourseの同期

Zendeskコメントは、チケットが作成されたDiscourseトピックと同期できます。

設定

Discourse Zendeskの設定は、Discourseサイトの管理画面のプラグインページからアクセスできます。そのページの「discourse-zendesk-plugin」エントリの「設定」ボタンをクリックしてください。

OAuthの設定

まず、ZendeskでOAuthクライアントを作成します:

  1. Zendesk管理センターで、アプリと統合 > API > OAuthクライアント に移動します。
  2. OAuthクライアントを追加 をクリックします。
  3. 名前説明 を入力し、クライアントの種類として Confidential(秘密) を選択します。リダイレクトURLは必要ありません。
  4. スコープtickets:readtickets:writeusers:read、および users:write に設定し、OAuthクライアントをプラグインに必要なスコープのみに制限します。
  5. クライアントを保存します。
  6. クライアントの 識別子(Identifier)シークレット(Secret) をコピーします。Zendeskは完全なシークレットを一度のみ表示します。

これらのDiscourse設定を構成します:

  • zendesk oauth client id: OAuthクライアントの 識別子(Identifier) を入力します。
  • zendesk oauth client secret: OAuthクライアントの シークレット(Secret) を入力します。

その他の設定

  • zendesk url: ZendeskアカウントのURLに /api/v2 を続けて入力します。例えば、https://example.zendesk.com/api/v2

  • zendesk enabled: プラグインを有効または無効にします。

  • zendesk jobs api token: 非推奨。既存のインストール環境はOAuthに移行する必要があります。

  • zendesk jobs email: 非推奨。既存のインストール環境はOAuthに移行する必要があります。

  • zendesk autogenerate all categories (zendesk enable all categories): すべてのカテゴリのトピックに対してZendeskチケットを自動的に作成します。この設定はデフォルトでは無効です。

  • zendesk autogenerate categories (zendesk enabled categories): 新しいトピックが自動的にZendeskチケットを作成するDiscourseのカテゴリを選択します。

  • zendesk job push all posts: 返信をチケットコメントとしてZendeskにプッシュします。この設定はデフォルトでは有効です。

  • zendesk job push only author posts: 元のトピックの著者が書いた返信のみをプッシュします。この設定は zendesk job push all posts が有効の場合に適用され、デフォルトでは無効です。

  • sync comments from zendesk および zendesk incoming webhook token: ZendeskからDiscourseへのコメントを同期します。Zendeskの双方向同期を有効にする方法 を参照してください。

  • zendesk tags: Discourseから作成されたZendeskチケットに追加する任意のタグのリストです。

「いいね!」 37