対象プランOFFLINEBUSINESSPRO
実装にかかる想定時間：約30分
イベント毎に設定する必要がある：Yes
本ページでは、APIを活用してHubSpotの登録フォームから収集した登録者を、EventHubへ自動登録する方法をご紹介します。
<tips>HubSpotのワークフロー機能を利用するため、Marketing Hub / Sales Hub / Service Hub / Operations Hub プランの Professional/Enterpriseプランに加入している必要があります。予めご了承ください。プランの詳細はHubSpot公式ページをご覧ください。</tips>
1. 【事前準備】HubSpotでプロパティ項目を作成する
[コンタクト]＞[アクション]＞[プロパティを編集]＞[プロパティを作成]の手順で、以下項目のプロパティを新たに作成してください。本プロパティはこのあとの 5. HubSpotでワークフローを作成するの手順で使用します。
|
オブジェクト タイプ |
ラベル | 内部名 |
フィールド タイプ |
説明 |
| コンタクト | eventKey | eventkey | 単行テキスト | EventHubでイベントを作成する際に生成されるeventKeyです。 詳しくは、eventKeyをご覧ください。 |
| ticketId | ticketid | 単行テキスト | EventHubでイベントを作成し、そのイベントで作成したチケットごとに生成されるticketIDです。 詳しくは、ticketIDをご覧ください。 |
[ウェビナーモード]で、開催日程が複数設定されているイベントへ連携する場合
ユーザーが選択した日程も登録連携する必要があるため、eventKeyやticketIdに加えて、以下項目をプロパティで作成します。開催日程が１つの場合は指定は不要ですので、本設定はしなくても構いません。
① 以下プロパティを新規で作成してください。
| オブジェクト タイプ |
ラベル | 内部名 | フィールド タイプ |
説明 |
| コンタクト | 開催日程 | eventscheduleId | ドロップダウン選択 | [ウェビナーモード]イベントで、開催日程が複数設定されている場合のみ必要です。 詳しくは、eventScheduleIdをご覧ください。 |
② [フィールドタイプ]から、[ドロップダウンオプション]を設定します。
| 設定する値 | |
| ラベル | フォームに表示する開催日程を設定します。 2. HubSpotで登録フォーム を作成するにて、フォーム上に表示する項目として使用します。開催が終了した日程は、誤登録防止のため適宜フォーム内から非表示にする運用をお願いします。 |
| 内部名 | eventscheduleIdを設定します。 詳しくは、eventscheduleIdをご覧ください。 |
2. HubSpotで登録フォーム を作成する
<tips>イベント・チケットフォームごとに設定が必要です</tips>
① HubSpotで登録フォームを作成します。
<tips>[ウェビナーモード]で、開催日程が複数設定されているイベントへ連携する場合
- 開催日程もフォーム上に表示してください。
- 誤登録防止のために開催終了した日程は非表示にしてください。ユーザーが過去日の開催日程を指定して登録をしても、EventHubへの登録は可能です。 [コンタクト] ＞ [アクション] ＞ [プロパティを編集] ＞ [フィールドタイプ] から、トグルをOFFにすると、非表示になります。
</tips>
② 1. HubSpotでプロパティ項目を作成するで作成したeventKey、ticketIdをフォームに挿入し、[このフィールドを非表示にする]をONにします。eventKeyの[既定値]には、このフォームに対応するイベントのeventKey、ticketIdの[既定値]には、このイベントに対応するイベントのticketIdを入力します。
これでHubSpotのフォーム作成は完了です。イベント開催毎に登録フォームを作成し、eventKeyとticketIdを既定値に入力しましょう。
<attention>HubSpotでフォームを作成した場合、EventHubの利用規約及びプライバシーポリシーに同意した上で登録が行われるようにしてください。詳細は参加者からEventHub利用規約・プライバシーポリシーの同意を取得するをご覧ください。</attention>
3. EventHubでチケット・フォームを作成する
次に、EventHubでチケット・フォームを作成します。
HubSpotで作成したフォームから登録したユーザーは、チケット・フォームを通してEventHubへユーザー登録がされます。
以下のページを参考にチケット・フォームを作成しましょう。
登録期限や上限数、ユーザータイプ[来場者/出展者]、コンテンツグループの設定なども反映されます。
また、HubSpotのプロパティデータをEventHubに連携したい場合は、EventHubでもプロパティと同様のカスタム項目を作成する必要があります。以下のページを参考にカスタム項目を作成してください。
<attention>
- EventHubのカスタム項目を必須入力にした場合、HubSpotのフォームからデータを収集しないと登録ができません。
- イベントの閉鎖日時を過ぎると登録ができません。
- チケット・フォームの登録期限や上限数を超えると登録ができません。
- ステータスが販売中・非公開の場合は登録が可能ですが、準備中の場合は登録ができません。
- HubSpot登録連携では有料チケットの作成ができません。
上記のいずれかが該当した場合、「Ticket cost must be free and status on sale or private to register a user」というエラーが出現し、ユーザー登録ができません。EventHubのチケット設定を変更してください。</attention>
この時、HubSpotで作成したチェックボックス・ドロップダウンの選択肢の[内部値]は、EventHubで作成するカスタム項目の選択肢名と一致させてください。
日英イベントの場合は、HubSpotアプリで選択されている lang の言語が採用されます。当該言語で[内部値]を設定してください。
4. HubSpotにEventHubのアプリをインストールする
① 管理画面の上部にある[設定]から外部連携[HubSpot]を選択し、[インストール]をクリックします。
② [アカウントを選択]をクリックし、EventHubをHubSpotに接続します。
接続が完了すると、[インストール済み]になります。これでHubSpotにEventHubのアプリのインストールは完了です。
5. HubSpotでワークフローを作成する
① [ワークフローを作成]＞[ゼロから作成]から、[コンタクトベース]＞[空白のワークフロー]＞[次へ]の手順でワークフローを作成します。
② [トリガーを設定]＞[イベントの発生時]をクリックします。
③ [フォーム送信]＞[保存]の手順で、トリガーを設定します。
④ 新規アクションを選択し、4. HubSpotにEventHubのアプリをインストールするでインストールしたEventHubのアプリを選択します。
⑤ EventHubへ登録する値に対するプロパティを以下の表を参考に入力し、[保存]をクリックします。
| 項目 | 必須/任意 | 説明 |
| lang | 必須 | イベントの言語が日本語の場合は[ja]、英語の場合は[en]を選択してください。 |
| apiKey | 必須 | APIキーの取得はAPIキーの発行方法をご覧ください。 |
| eventKey | 必須 | 1. HubSpotでプロパティ項目を作成するで作成したeventKeyをトークンとして選択してください。 |
| ticketId | 必須 | 1. HubSpotでプロパティ項目を作成するで作成したticketIdをトークンとして選択してください。 |
| eventscheduleId | 任意 |
1. HubSpotでプロパティ項目を作成するで作成したeventscheduleIdをトークンとして選択してください。 [ウェビナーモード]で、開催日程が複数設定されているイベントへ連携する場合は必須です。１日程しか設定されていない場合は、任意（＝不要）です。 |
| 項目 | 必須/任意 | EventHubのプロフィール項目 |
| 必須 | EventHubの[基本設定]＞[プロフィール項目]に対応するプロパティを入力してください。 | |
| lastName | 必須 | |
| firstName | 必須 | |
| affiliation | 必須/任意 | |
| department | 必須/任意 | |
| position | 必須/任意 | |
| shortComment | 必須/任意 |
| 値 | EventHubのプロフィール項目 |
| customField1~10Key | EventHubの[プロフィール項目]＞[項目ID]で設定している、項目IDを以下の形で入力してください。 customFieldxxxx 例）項目IDが20364だった場合、customField20364と入力します。 |
| customField1~10Value | [プロパティを選択]＞[このワークフローのコンタクト]からEventHubの項目IDに対応するプロパティを入力してください。 |
<tips>HubSpotからEventHubへ連携できるプロパティデータは最大10件です。</tips>
⑥[確認と公開]をクリックし、ワークフローを公開します。
⑦ 設定を確認し、[ワークフローをオンにする]をクリックしてワークフローを有効化します。
⑧ これで設定は完了です🎉 作成したフォームから参加登録をして、EventHubに登録されるか検証を行いましょう。
<tips>
- 本フローは、HubSpotで作成されている全てのフォームに対してトリガーが動きます。
ただし、EventHubに登録されるコンタクトは、eventKeyとticketIdが入力されているコンタクトのみです。
- EventHubは1つのイベントに登録できるメールアドレスは1つのみです。テストで登録したユーザーは、
2度目の登録ができませんので、再度テストを行う場合は別のメールアドレスで実行してください。
- HupSpotの実行結果の詳細ログはAPI：参加登録連携のエラー詳細の確認方法からご確認いただけます。
技術者向けAPIドキュメントに記載のエラーレスポンスを参照しながらエラーを解消してください。
- お問い合わせの際は、以下3点を添えて、画面右下の吹き出しよりカスタマーサポートまでご連絡いただきますようお願いいたします🙇♀️
● 画面に表示されるメッセージもしくはメッセージの内容がわかるスクリーンショット
● 該当のイベント名
● 該当ユーザーのメールアドレス
</tips>
6. 登録からログインまでの導線
APIでHubSpotとEventHubを連携した場合、以下の導線で参加者はイベントページにログインすることになります。
① HubSpotで作成した登録フォームから参加登録をする
② EventHubからパスワード設定案内のメールを受信する
③ パスワードを設定する
④ パスワード設定完了メールを受信する
⑤ イベントページへログイン
<tips>パスワード設定[なし]でイベントを作成した場合は、パスワードの設定手順③④がありません。</tips>
②で配信されるパスワード設定メールは[メール]＞[システムメール]の[埋め込みフォーム・MAフォーム（API連携）のパスワード設定]から編集してください。「申し込みありがとうございました」という文言を記載するとパスワード設定をせずに離脱するケースがあるため、"良い例"を参考にパスワード設定を促すシンプルな文章にしましょう。
④で配信される、登録完了メールは[メール]＞[システムメール]の[EXCELアップロード・埋め込みフォーム・MAフォーム（API連携）・同僚招待の登録完了]から編集してください。
7. サポート対応について
こちらでご紹介する方法は、提供する情報の継続や正確性を完全に保証するものではありません。実装方法に関するご不明な点はHubSpotカスタマーサポート、もしくは社内エンジニアへお問い合わせください。
UIやボタンの名称等が変更になっている場合がございます。ご了承ください。
機能や取得したいAPI情報が足りない場合は、ご要望としてお伺いしますので、EventHubカスタマーサポートへお問い合わせください。