n8nを使ったお問い合わせ受付フローの作成（パート2）

パート1ではお問い合わせ内容をDBに登録してチャットに通知するワークフローを作成しました。 本記事で通知を受けた後のフォローアップとして、チケットの登録および顧客管理システム（CRM）への登録を行うワークフローを作成します。

フロー概要

作成するワークフローは以下のようになります。 まず、管理者がチャットに通知されたお問い合わせ内容を確認し、チケットを登録するコマンドをチャットを使ってメッセージ送信します。次に、コマンドで送信されたお問い合わせ番号でDBを照会し、登録されているお問い合わせ情報を取得します。そして、取得したお問い合わせ情報をもとにチケット管理システムでチケットを発行します。CRMへの登録もチケットと同様にコマンドを使って行います。

システム構成

今回のシステム構成は下図のようになります。カスタマーサポートはMattermostし、命令文を使ってお問い合わせ番号をメッセージ送信します。お問い合わせ番号がMattermost経由でn8nに送信され、n8nで作成したワークフローが実行されます。

フローの作成

コマンド送信

MattermostはSlash commandsというSlackのスラッシュコマンドと同等の機能を有しています。ビルトインのコマンド以外にユーザー自身が独自のコマンドを追加することができ、特定のURLに対してPOSTまたはGETのHTTPリクエストを送信することができます。今回はチケットの作成とCRMへの登録の2種類のコマンドを作成します。

スラッシュコマンドはIntegrationsからSlash Commandsを選択しAdd Slash Commandで作成することができます。

今回は以下のように設定します。

■チケット作成

■CRM登録

コマンドを作成すると下図のようにトークンが発行されます。このトークンはリクエスト送信時のAuthorizationヘッダーおよびPOSTパラメータとして送信されます。

今回HTTPリクエストの送信先であるn8nは同一サーバー内のローカルネットワーク上にあります。Mattermostはローカルネットワーク間での通信を制限しているため許可リストにn8nを追加する必要があります。許可リストの設定はSystem ConsoleのENVIRONMENTからDeveloperを選択しAllow untrusted internal connections toに許可したいホスト名やIPアドレス、CIDRをスペース区切りで入力して行います。

以上でMattermost側の設定は完了です。

コマンドの受信

次にn8nの設定を行います。 まずコマンドからのリクエストを受信するWebフックを作成します。 今回はチケット作成コマンド用のWebフックとCRM登録用のWebフックの2種類を作成します（ノードパネルからOn webhook callを選択）。

ノードを2つ追加して設定パネルでそれぞれ以下のように設定します（設定内容はそれぞれのコマンドでCredentialとPathの値を変更してください）。

お問い合わせ番号照会

コマンドを受信したWebフックノードの出力は以下のようにヘッダー、パラメータ、クエリ、ボディで構成されたJSONデータになります。 ボディ部に実行したコマンドやコマンドのトークン、お問い合わせ番号が格納されています。

[
  {
    "headers": {},
    "params": {},
    "query": {},
    "body": {
      "channel_id": "...",
      "channel_name": "...",
      "command": "/new_ticket",
      "response_url": "...",
      "team_domain": "...",
      "team_id": "...",
      "text": "cs_1234567890",
      "token": "abcdefghijklmnopqrstuvwxyz",
      "trigger_id": "...",
      "user_id": "...",
      "user_name": "..."
    }
  }
]

まずはデータからボディ部のみを取り出すためにCodeノードを追加します（ノードパネルのData transformationから選択）。

ノードを追加して設定パネルのコード入力欄に以下のJavaScriptを入力します。 $inputは現在のノードに対する入力を表す変数で、一つ前のWebhookノードからの出力を参照しています（参考：Current node input）。

newItems = []
 
for (const item of $input.all()) {
  newItems.push(item.json.body)
}
 
return newItems

これで後続のノードは以下のように階層のないフラットな構造のJSONデータで参照できるため記述が簡潔になります。

[
  {
    "channel_id": "...",
    "channel_name": "...",
    "command": "/new_ticket",
    "response_url": "...",
    "team_domain": "...",
    "team_id": "...",
    "text": "cs_1234567890",
    "token": "abcdefghijklmnopqrstuvwxyz",
    "trigger_id": "...",
    "user_id": "...",
    "user_name": "..."
  }
]

次にお問い合わせ番号を使ってDBに登録されているお問い合わせ情報を照会する処理を追加します。 NocoDBと連携するためのノードはn8nに標準で用意されており、データを一意に特定するIDをキーにして1件取得することができます。 ただし、NocoDBのノードではID以外のキーを指定できないため、お問い合わせ番号で照会することができません。 代わりにHTTP RequestノードからNocoDBのREST APIを実行する方法で照会を行います（ノードパネルのHelpersから選択）。

ノードを追加して設定パネルで以下のように設定します。

APIのエンドポイントはNocoDBの管理画面で対象テーブルのベースをマウスオーバーして表示される3点リードからSwagger: REST APIsを選択することで確認することができます。

これでお問い合わせ番号での照会ができるようになりましたので、IFノードを追加してデータが存在する場合はワークフローを継続し、存在しない場合はワークフローを終了してエラーレスポンスを返すようにします（ノードパネルのFlowから選択）。

ノードを追加して設定パネルで以下のように設定します。

$json.pageInfo.totalRowsは該当データの件数を表すAPIレスポンス値で、件数が1の場合はtrue、1以外の場合はfalseとなります。 falseの場合はエラーレスポンスを返すようにするためにfalseのブランチにRespond to Webhookノードを追加します（ノードパネルのFlowから選択）。

ノードを追加して設定パネルで以下のように設定します。

Mattermostでコマンドを実行してお問い合わせ番号照会に失敗した場合、ここで設定した任意のエラーメッセージがMattermostに表示されます。

次にtrueの場合のフローを作成していきます。 チケット発行とCRM登録はフローを分ける必要があるため、IFノードのtrueのブランチにSwitchノードを追加します（ノードパネルのFlowから選択）。

ノードを追加して設定パネルで以下のように設定します。

これでコマンド毎に別々のフローを作成できるようになりました。

チケット発行

チケットの発行は以下のようなフローで行います。最初にお問い合わせユーザーがチケット管理システムにユーザー登録されているかどうかを確認します。登録されている場合はチケットを発行し、登録されていない場合はユーザー登録した上でチケットを発行します。

まず、先ほど作成したSwitchノードのnew_ticketとラベリングされたブランチにユーザー照会のためのノードを追加します。 n8nには今回使用するチケット管理システム（Zammad）からユーザーを取得するノードが標準で用意されていますのでそちらを使用します（ノードパネルのAction in an appから選択）。

ノードを追加して設定パネルで以下のように設定します。

アクセストークンはユーザープロファイルから発行することができます。発行するトークンに必要なパーミッションはticket.agentになります。 どのパーミッションが必要になるかはシステムドキュメントの各APIのエンドポイントに記載されていますのでそちらをご参照ください。

次に、取得した全ユーザーからお問い合わせユーザーのメールアドレスと一致するユーザーを取り出すためにCodeノードを追加します。

ノードを追加して設定パネルのコード入力欄に以下のJavaScriptを入力します。 下記コードでZammadで取得した全ユーザーからお問い合わせ情報のメールアドレスと一致するユーザーを取り出しています。

const user = $input.all().filter(item => item.json.email === $('お問い合わせ番号照会ノードの名前').item.json.list[0].email)
 
return user.length === 0 ? 
  [
    {
      json: {
        exists: false,
        user: null
      },
      pairedItem: 0
    }
  ] : 
  [
    {
      json: {
        exists: true,
        user: user
      },
      pairedItem: 0
    }
  ]

次に、IFノードを追加して一致するユーザーがいる場合といない場合の分岐を作成します。

ノードを追加して設定パネルで以下のように設定します。

分岐を作成したらfalseブランチの方にユーザー登録のためのノードを追加します。n8nにはZammadにユーザーを登録するノードが標準で用意されていますのでそちらを使用します（ノードパネルのAction in an appから選択）。

ノードを追加して設定パネルで以下のように設定します。

次に、trueのブランチの方にチケット発行のためのノードを追加し、先ほど追加したユーザー登録のノードからもリンクします。

ノードを追加して設定パネルで以下のように設定します。

{
   "title": "任意のチケットタイトル",
   "group": "Zammadで作成したグループ",
   "customer": "{{ $('お問い合わせ番号照会ノードの名前').item.json.list[0].email }}",
   "article": {
      "subject": "空白もしくは任意のサブジェクト",
      "body": "{{ $('お問い合わせ番号照会ノードの名前').item.json.list[0].message.replace(/\r?\n/g, '\\n') }}",
      "type": "web",
      "internal": true,
      "sender": "Customer"
   }
}

最後にRespond to Webhookノードを追加して完了メッセージを返します。

これでチケット発行のフローは完成です。次にCRM登録のフローを作成します。

CRM登録

CRMへの発行は以下のようなフローで行います。最初にお問い合わせユーザーがCRMにリード登録されているかどうかを確認します。登録されている場合はワークフローを終了し、登録されていない場合はリード登録を行います。

n8nには今回使用するCRM（Twenty）と連携するためのノードは用意されていません。代わりにGraphQLノードからTwentyのGraphQL APIを実行する方法でユーザー照会やリード登録を行います。

TwentyのGraphQL APIを実行するためにはJWTによるトークンベース認証が必要となります。JWTに設定するペイロードは以下の通りです。

subとworkspaceIdにセットする値はTwentyの画面上で確認することができないため、TwentyのDBを直接確認して値をセットします。 iatとexpはワークフローの中で動的に算出してセットします。 そこで、最初にSwitchノードのnew_leadとラベリングされたブランチに値を算出するためのCodeノードを追加します。

ノードを追加して設定パネルのコード入力欄に以下のJavaScriptを入力します。

const iat = $now.toSeconds()
const exp = iat + 3600
 
return [
  {
    json: {
      iat: iat,
      exp: exp
    },
    pairedItem: 0
  }
]

ペイロードの値が揃いましたのでJWTの署名を行います。ただし、n8nにはJWTの署名を行うためのノードがありませんので、今回はn8n-nodes-jwtというコミュニティノードを使用します。 公式ドキュメントの手順に従ってコミュニティノードをインストールしてくだい。インストールするとノードパネルのAction in an appにJWTノードが追加されますのでフローに追加します。

ノードを追加して設定パネルで以下のように設定します。

{
  "sub": "userテーブルに登録されている値を入力",
  "workspaceId": "workspaceテーブルに登録されている値を入力",
  "iat": {{ $json.iat }},
  "exp": {{ $json.exp }}
}

JWTの用意ができましたのでGraphQLノードを追加してユーザー照会を行います（ノードパネルのAction in an appから選択）。

ノードを追加して設定パネルで以下のように設定します。

query FindManyPeople {
  people(
    first:1,
    filter:{
      and:[
        {
          email:{
            eq:"{{ $('お問い合わせ番号照会ノードの名前').item.json.list[0].email }}"
          }
        }
      ]
  	}
  ) {
    edges {
      node {
        id
      }
    }
  }
}

ユーザーが存在する場合は何もせずにワークフローを終了しますのでIFノードを追加してtrueブランチにRespond to Webhookノードを追加します。

IFノードを追加して設定パネルで以下のように設定します。

ユーザーが存在しない場合はリード登録を行いますのでGraphQLノードを追加します。

mutation CreatePerson {
  createPerson(
    data:{
      name: {
        firstName: "{{ $('お問い合わせ番号照会ノードの名前').item.json.list[0].first_name }}",
        lastName: "{{ $('お問い合わせ番号照会ノードの名前').item.json.list[0].last_name }}"
      },
      email: "{{ $('お問い合わせ番号照会ノードの名前').item.json.list[0].email }}"
    }
  )
  {id}
}

動作確認

ワークフローの全体像は以下のようになります。

ワークフローをアクティブにしてMattermostでスラッシュコマンドを実行してみます。

最初にチケットを発行してみます。

チケット発行に成功するとRespond to Webhookノードで設定したメッセージが返ってきます。 Zammadにアクセスするとチケットが発行されていることが確認できます。

n8nにアクセスするとワークフローが実行されていることが確認できます。

次ににリードを登録してみます。

チケット発行に成功するとRespond to Webhookノードで設定したメッセージが返ってきます。 Twentyにアクセスするとリードが登録されていることが確認できます。

n8nにアクセスするとワークフローが実行されていることが確認できます。