CXone Agent Integrated用にHubSpotワークフローを構成する

これは、HubSpotをCXone Agent Integratedと統合する最終ステップです。

HubSpotおよびCXone Agent Integratedについて、検索、カスタム作成、標準作成ワークフローを構成できます。これらのワークフローは、HubSpotレコード(別名、エンティティまたはオブジェクト)を検索または作成します。これはダイナミックデータマッピングのバックエンド設定です。

カスタムタイムラインはHubSpotをサポートしていません。

ワークフローのタイプ

 説明

ワークフロー
検索 検索ワークフローは、エージェントが扱っているインタラクションに該当するレコードがあるかどうかHubSpotをスキャンします。 ANIを検索
カスタム検索
カスタム作成 カスタム作成ワークフローは、標準フィールドとカスタムフィールドの両方で任意のレコードタイプを作成します。 カスタム作成
標準作成

標準作成ワークフローは、標準データフィールドで標準HubSpotレコードを作成します。これらのワークフローのSNIPPETペイロードは、標準フィールドとそれらのフィールドのみを含むものでなければなりません。

 会社を作成する
コンタクト作成
チケットを作成する
関連付けを含むチケットを作成する

検索ワークフローを構成する

検索ワークフローは2つあります：ANIの検索およびカスタム検索。

ANI検索ワークフローを構成する

通話またはEメールのANIの検索ワークフローを設定できます。

  1. Studioで、ANI検索ワークフローを設定するスクリプトを開きます。

  2. SNIPPETアクションをBEGINの後、およびWorkflow Executeアクションの前に追加します(まだ追加していない場合)。

  3. スクリプトキャンバスでSNIPPETアクションをダブルクリックします。

  4. 通話のANIを検索ワークフローを設定するには、 コードの次の各行をコピーして、エディターウィンドウの[テキストビュー]タブに貼り付けます。

    
ASSIGN phoneNumber = "{ANI}"
ASSIGN email = ""
DYNAMIC searchInput
searchInput.phoneNumber = "{phoneNumber}"
DYNAMIC searchFlowPayload
searchFlowPayload.workflowInput = searchInput

  5. EメールのANIを検索ワークフローを設定するには、 コードの次の各行をコピーして、エディターウィンドウの[テキストビュー]タブに貼り付けます。

    
ASSIGN phoneNumber = ""
ASSIGN email = "{ANI}"
DYNAMIC searchInput
searchInput.email = "{email}"
DYNAMIC searchFlowPayload
searchFlowPayload.workflowInput = searchInput

  6. スクリプトを保存します。

  7. スクリプトをテストするには、Studioでインタラクションのシミュレーションを行うことができます。

カスタム検索ワークフローを構成する

カスタム検索ワークフローでは、1つまたは複数のHubSpotレコードを検索できます。指定したレコード内の複数のフィールドや変数を検索することもできます。HubSpot演算子を使えば、いろいろな検索の必要条件を結合できます。

このワークフローはこれらのHubSpotレコードをサポートします：

  • 会社
  • コンタクト
  • チケット(関連レコードの有無にかかわらず)

  1. Studioで、カスタム検索ワークフローを設定するスクリプトを開きます。

  2. SNIPPETアクションをBEGINの後、およびWorkflow Executeアクションの前に追加します(まだ追加していない場合)。

  3. スクリプトキャンバスでSNIPPETアクションをダブルクリックします。

  4. コードの以下の各行をコピーして、エディターウィンドウの[テキストビュー]タブに貼り付けます。

    
DYNAMIC filterGroups
	
DYNAMIC filters1
filters1.propertyName = "[fieldName]"
filters1.operator = "[operator]"
filters1.value = "[value]"

DYNAMIC filters2
filters2.propertyName = "[fieldName]"		
filters2.operator = "[operator]"
filters2.value = "[value]"

filterGroups.filters[1] = filters1
filterGroups.filters[2] = filters2

DYNAMIC sorts
DYNAMIC sort1
sort1.propertyName = "[fieldName]"
sort1.direction = "[ASCENDING or DESCENDING]"
sorts[1] = sort1

DYNAMIC searchArray
searchArray[1].entity = "[API name]"
searchArray[1].filter.filterGroups[1] = filterGroups

DYNAMIC searchFlowPayload
searchFlowPayload.workflowInput.entities = searchArray

  5. filters1とfilters2属性の値を変更します。

    1. filters1.propertyName属性とfilters2.propertyName属性の値を検索で使用するフィールドの名前に変更します。例えば、filters1.propertyName = "subject"です。

      プロパティと呼ばれるフィールド名、およびエンドポイントの完全なリストは、レコード用のHubSpotドキュメントに記載されています：

    2. filters1.operator属性とfilters2.operator属性の値を使用するHubSpot演算子に変更します。HubSpot演算子の完全なリストは、HubSpotドキュメンテーション外部サイトへのナビゲーションを示す矢印付きのボックス。にあります。これは大文字と小文字を区別します。

    3. filters1.value属性とfilters2.value属性の値をフィールドに割り当てる値に変更します。例えば、filters1.value = "Account invalid Login"です。

  6. sort1属性の値を変更します。

    1. sort1.propertyName属性の値を結果のソートに使用するフィールドに変更します。例えば、sort1.propertyName = "createdate"です。

    2. sort1.direction属性の値をASCENDINGまたはDESCENDINGに変更します。

  7. searchArray[1].entity属性の値を、検索したいレコード用のAPI名に変更します。例えば、searchArray[1].entity = "companies"です。これは大文字と小文字を区別します。

    レコード

    API

    		 リンク可能
    会社 companies はい
    コンタクト contacts はい
    チケット tickets はい

  8. スクリプトを保存します。

  9. スクリプトをテストするには、Studioでインタラクションのシミュレーションを行うことができます。

カスタム作成ワークフローを構成する

カスタム作成ワークフローでは、SNIPPETペイロードを設定して、標準またはカスタムの任意のタイプのHubSpotレコードを作成できます。標準またはカスタムの任意のフィールドタイプにも入力できます。たとえば、レコードタイプからの標準フィールドの一部および独自のカスタムフィールドで会社レコードを作成することもできます。

これは、HubSpotレコードを作成するための推奨される方法です。

カスタム作成ワークフローを設定する

カスタム作成ワークフローは、標準またはカスタムの任意のタイプのHubSpotレコードを作成します。このレコードは、標準およびカスタムのデータフィールドを表示できます。フィールドにはテキスト、数値、または変数を入れなければなりません。

  1. HubSpotで営業ハブのエンタープライズツールが有効になっていることを確認してください。カスタムHubSpotレコードを作成するには、このツールが必要です。

  2. このHubSpotドキュメント 外部サイトへのナビゲーションを示す矢印付きのボックス。を使用して、HubSpotにカスタムレコードまたはオブジェクトを作成します。

  3. Studioで、カスタム作成ワークフローを設定するスクリプトを開きます。

  4. SNIPPETアクションをBEGINの後、およびWorkflow Executeアクションの前に追加します(まだ追加していない場合)。

  5. スクリプトキャンバスでSNIPPETアクションをダブルクリックします。

  6. コードの以下の各行をコピーして、エディターウィンドウの[テキストビュー]タブに貼り付けます。

    
DYNAMIC createPayload
createPayload.entities.name = "[custom record API]"
createPayload.entities.properties.[fieldName]= "[field value]"
createPayload.entities.properties.[fieldName]= "[field value]"
createPayload.entities.properties.[fieldName]= "[field value]"
createPayload.entities.properties.[fieldName]= "[field value]"
						
createPayload.pinnedRecord = "[true or false]"

DYNAMIC create[ObjectName]Payload
create[ObjectName]Payload.workflowInput = createPayload

ASSIGN create[ObjectName]Json = "{create[RecordName]Payload.asjson()}"

  7. createPayload.entities.name属性の値を、作成したカスタムレコード用のAPIに変更します。例えば、createPayload.entities.name = "companies"です。これは大文字と小文字を区別します。

    レコード

    API

    		 リンク可能
    会社 companies はい
    コンタクト contacts はい
    チケット tickets はい

  8. createPayload.entities.properties属性で、[fieldname]をカスタムレコードに追加するフィールドの名前に変更します。例えば、createPayload.entities.properties.accountNumberです。

  9. createPayload.entities.properties属性の値をフィールドに割り当てる値に変更します。例えば、createPayload.entities.properties.accountNumber = "12345"です。

  10. createPayload.pinnedRecord属性の値を、trueまたはfalseに変更します。trueに設定すると、作成されたレコードは、顧客カードの現在のインタラクションセクションのエージェントに対し表示されます。falseに設定すると、顧客カードの最近のインタラクションセクションに表示されます。この属性をペイロードに含めない場合、これはfalseと見なされます。

  11. コードの最後の3行の[ObjectName]のインスタンスをすべて、作成したレコードの名前に変更します。属性のキャメルケースに一致するように名前を大文字にします。たとえば、作成したレコードの名前がaccountの場合、コードは次のようになります：

    
DYNAMIC createAccountPayload
createAccountPayload.workflowInput = createPayload
						
ASSIGN createAccountJson = "{createAccountPayload.asjson()}"

  12. スクリプトを保存します。

  13. スクリプトをテストするには、Studioでインタラクションのシミュレーションを行うことができます。

標準作成ワークフローを構成する

標準作成ワークフローでは、ユーザーはHubSpot内の標準HubSpotレコードを検索できます。

標準作成ワークフローのSNIPPETペイロードのフィールドを追加または削除することはできません。フィールドを追加または削除した場合、レコードは作成されません。希望のフィールドで標準レコードまたはカスタムレコードを作成するには、カスタム作成ワークフローを使用します。

会社の作成ワークフローを設定する

  1. Studioで、会社の作成ワークフローを設定するスクリプトを開きます。

  2. SNIPPETアクションをBEGINの後、およびWorkflow Executeアクションの前に追加します(まだ追加していない場合)。

  3. スクリプトキャンバスでSNIPPETアクションをダブルクリックします。

  4. コードの以下の各行をコピーして、エディターウィンドウの[テキストビュー]タブに貼り付けます。

    
DYNAMIC createPayload
createPayload.entities.name = "company"
createPayload.entities.properties.name = "[company name]"
createPayload.entities.properties.domain = "[company website]"
createPayload.entities.properties.city = "[company city]"
createPayload.entities.properties.phone = "[company phone number]"
						
DYNAMIC createCompanyPayload
createCompanyPayload.workflowInput = createPayload

ASSIGN createCompanyJson = "{createCompanyPayload.asjson()}"

    それぞれの行を含めなければなりません。フィールドを空白のままにしたい場合は、null値("")を使用できます。例えば、createPayload.entities.properties.city = ""です。

  5. 属性の値を変更します。これらのいずれかは、ハードコードされているか、変数か、または両者の組み合わせです。インタラクションごとに値を更新したい場合は、変数を使用します。

    1. createPayload.entities.properties.name属性の値を会社の名前に変更します。例えば、createPayload.entities.properties.name = "Classics, Inc."です。

    2. createPayload.entities.properties.domain属性の値を会社のWebサイトに変更します。例えば、createPayload.entities.properties.domain = "classics.com"です。

    3. createPayload.entities.properties.city属性の値を会社の市区町村に変更します。例えば、 createPayload.entities.properties.city = "London"です。

    4. createPayload.entities.properties.phone属性の値を会社の電話番号に変更します。例えば、createPayload.entities.properties.phone = "1234567890"です。

  6. スクリプトを保存します。

  7. スクリプトをテストするには、Studioでインタラクションのシミュレーションを行うことができます。

コンタクト作成ワークフローを構成する

  1. Studioで、コンタクト作成ワークフローを設定するスクリプトを開きます。

  2. SNIPPETアクションをBEGINの後、およびWorkflow Executeアクションの前に追加します(まだ追加していない場合)。

  3. スクリプトキャンバスでSNIPPETアクションをダブルクリックします。

  4. コードの以下の各行をコピーして、エディターウィンドウの[テキストビュー]タブに貼り付けます。

    
DYNAMIC createPayload
createPayload.entities.name = "contact"
createPayload.entities.properties.firstName = "[first name]"
createPayload.entities.properties.email = "[email address]"
createPayload.entities.properties.lastName = "[last name]"
createPayload.entities.properties.phone = "[phone number]"

DYNAMIC createContactPayload
createContactPayload.workflowInput = createPayload

ASSIGN createContactJson = "{createContactPayload.asjson()}"

    それぞれの行を含めなければなりません。フィールドを空白のままにしたい場合は、null値("")を使用できます。例えば、createPayload.entities.properties.email = ""です。

  5. 属性の値を変更します。これらのいずれかは、ハードコードされているか、変数か、または両者の組み合わせです。インタラクションごとに値を更新したい場合は、変数を使用します。

    1. createPayload.entities.properties.firstName属性の値をコンタクトの名に変更します。例えば、 createPayload.entities.properties.firstName = "Elinor"です。

    2. createPayload.entities.properties.email属性の値をコンタクトのEメールアドレスに変更します。例えば、createPayload.entities.properties.email = "elinor.dashwood@classics.com"です。

    3. createPayload.entities.properties.lastName属性の値をコンタクトの姓に変更します。例えば、createPayload.entities.properties.lastName = "Dashwood"です。

    4. createPayload.entities.properties.phone属性の値をコンタクトの電話番号に変更します。例えば、 createPayload.entities.properties.phone = "1234567890"です。

  6. スクリプトを保存します。

  7. スクリプトをテストするには、Studioでインタラクションのシミュレーションを行うことができます。

チケットを作成するワークフローを構成する

  1. Studioで、チケットの作成ワークフローを設定するスクリプトを開きます。

  2. SNIPPETアクションをBEGINの後、およびWorkflow Executeアクションの前に追加します(まだ追加していない場合)。

  3. スクリプトキャンバスでSNIPPETアクションをダブルクリックします。

  4. コードの以下の各行をコピーして、エディターウィンドウの[テキストビュー]タブに貼り付けます。

    
DYNAMIC createPayload
createPayload.entities.name = "ticket"
createPayload.entities.properties.subject = "[ticket subject]"
createPayload.entities.properties.hs_pipeline = "[#]"
createPayload.entities.properties.hs_pipeline_stage = "[#]"
createPayload.entities.properties.hs_ticket_priority = "[LOW, MEDIUM, or HIGH]"

DYNAMIC createTicketPayload
createTicketPayload.workflowInput = createPayload

ASSIGN createTicketJson = "{createTicketPayload.asjson()}"

    それぞれの行を含めなければなりません。フィールドを空白のままにしたい場合は、null値("")を使用できます。例えば、createPayload.entities.properties.hs_ticket_priority = ""です。

  5. 属性の値を変更します。

    1. createPayload.entities.properties.subject属性の値をチケットの件名(チケットの作成理由)に変更します。例えば、 createPayload.entities.properties.subject = "Query about large book orders"です。これは、ハードコードされているか、変数か、または両者の組み合わせです。インタラクションごとに値を更新したい場合は、変数を使用します。

    2. createPayload.entities.properties.hs_pipeline属性の値をチケットのパイプライン番号に変更します。例えば、createPayload.entities.properties.hs_pipeline = "0"です。

    3. createPayload.entities.properties.hs_pipeline_stage属性の値をパイプラインでのチケットのステータスを示す番号に変更します。例えば、 createPayload.entities.properties.hs_pipeline_stage = "3"です。

    4. createPayload.entities.properties.hs_ticket_priority属性の値を、LOW、MEDIUM、またはHIGHに変更します。

  6. スクリプトを保存します。

  7. スクリプトをテストするには、Studioでインタラクションのシミュレーションを行うことができます。

関連付けを含むチケットの作成ワークフローを設定する

  1. Studioで、関連付けを含むチケットの作成ワークフローを設定するスクリプトを開きます。

  2. SNIPPETアクションをBEGINの後、およびWorkflow Executeアクションの前に追加します(まだ追加していない場合)。

  3. スクリプトキャンバスでSNIPPETアクションをダブルクリックします。

  4. コードの以下の各行をコピーして、エディターウィンドウの[テキストビュー]タブに貼り付けます。

    
DYNAMIC createPayload
createPayload.entities.name = "ticket"
createPayload.entities.properties.subject = "[ticket subject]"
createPayload.entities.properties.hs_pipeline = "[#]"
createPayload.entities.properties.hs_pipeline_stage = "[#]"
createPayload.entities.properties.hs_ticket_priority = "[LOW, MEDIUM, or HIGH]"

DYNAMIC Association
DYNAMIC item1
item1.relatedObjectType = "[record API]"
item1.relatedObjectId = "[#]"
createPayload.entities.association[1] = item1

DYNAMIC createTicketPayload
createTicketPayload.workflowInput = createPayload

ASSIGN createTicketJson = "{createTicketPayload.asjson()}"

    それぞれの行を含めなければなりません。フィールドを空白のままにしたい場合は、null値("")を使用できます。例えば、createPayload.entities.properties.hs_ticket_priority = ""です。

  5. createPayload属性の値を変更します。

    1. createPayload.entities.properties.subject属性の値をチケットの件名(チケットの作成理由)に変更します。例えば、 createPayload.entities.properties.subject = "Query about mass book orders"です。これは、ハードコードされているか、変数か、または両者の組み合わせです。インタラクションごとに値を更新したい場合は、変数を使用します。

    2. createPayload.entities.properties.hs_pipeline属性の値をチケットのパイプライン番号に変更します。例えば、createPayload.entities.properties.hs_pipeline = "0"です。

    3. createPayload.entities.properties.hs_pipeline_stage属性の値をパイプラインでのチケットのステータスを示す番号に変更します。例えば、 createPayload.entities.properties.hs_pipeline_stage = "3"です。

    4. createPayload.entities.properties.hs_ticket_priority属性の値を、LOW、MEDIUM、またはHIGHに変更します。

  6. item1属性の値を変更します。

    1. item1.relatedObjectType属性の値を、このワークフローにつなげたいレコード用のAPIに変更します。例えば、item1.relatedObjectType = "companies"です。これは大文字と小文字を区別します。

      レコード

      API

      		 リンク可能
      会社 companies はい
      コンタクト contacts はい
      チケット tickets はい

    2. item1.relatedObjectId属性の値を、このワークフローにつなげたいレコードのID番号に変更します。例えば、item1.relatedObjectId = "19019671367"です。

  7. スクリプトを保存します。

  8. スクリプトをテストするには、Studioでインタラクションのシミュレーションを行うことができます。

レコードをピン留めします

顧客カードの現在のインタラクションセクションにレコードをピン留めすることができます。

  1. ピン留めしたいレコードのワークフローでSNIPPETを開きます。

  2. コードのこの行をコピーし、DYNAMIC create[RecordType]Payloadの前に貼り付けます：

    						
createPayload.pinnedRecord = "true"

  3. スクリプトを保存します。