対象プランOFFLINEBUSINESSPRO
Webhookとは、「ユーザー登録」や「QRチェックイン」など、特定のイベントが発生した際に、その更新情報をリアルタイムに指定されたURL（サーバー）へHTTP POSTし、通知する機能です。外部システムとの連携などに利用できます。
1. 実装されているWebhook一覧
❶ アンケート回答
発火タイミング：管理画面内のいずれかのイベントでアンケート回答があったとき
| プロパティ名 | 説明 |
| questionnaireId | [アンケート]で作成したアンケート毎に生成されるID |
| questionnaireTitleJa | [アンケート]で作成したアンケートタイトル日本語 |
| questionnaireTitleEn | [アンケート]で作成したアンケートタイトル英語 |
| eventId | イベントを一意に特定するID |
| eventKey | イベントを一意に特定するkey |
| eventNameJa | イベントの日本語名 |
| eventNameEn | イベントの英語名 |
| isExhibition | 出展イベントかどうか -trueの場合は出展イベント、falseの場合は通常のイベント |
| eventType | イベントのタイプ |
| userId | ユーザを一意に特定するID |
| メールアドレス | |
| userType | ユーザータイプ |
| language | ユーザーの言語 |
| portraitUrl | ユーザーのプロフィール画像のURL |
| utmSource | 参照元 |
| utmMedium | キャンペーンのメディア |
| utmCampaign | キャンペーンの名前 |
| utmTerm | キーワード |
| utmContent | 広告コンテンツ |
| userName | ユーザーの名前 ※どちらも同じ値(ユーザーの名前）を返します。[name]は互換性維持のため存在しております。新規で利用される場合は[useName]を参照ください。 |
| name | |
| familyName | ユーザーの姓 |
| givenName | ユーザーの名 |
| affiliation | ユーザーの所属先・会社 |
| department | ユーザーの部署 |
| position | ユーザーの役職 |
| questionXXXJa, questionXXXEn |
アンケートの設問 「XXX」には001,002...という番号が振られます |
| answerXXXJa, answerXXXEn |
アンケートの設問に対する回答 「XXX」には001,002...という番号が振られます |
<attention> 上記以外にアンケート回答(Slack通知）のWebhookもありますが、上記に記載している項目一覧とは異なります。ご注意ください。</attention>
❷ ユーザー登録
発火タイミング：管理画面内のいずれかのイベントで以下フォームを通じてユーザー登録があったとき
- EventHubのチケット・フォーム
- EventHubの埋め込みフォーム
- EventHubの出展フォーム
| プロパティ名 | 説明 |
| userId | ユーザーを一意に特定するID |
| eventKey | イベントを一意に特定するkey |
| eventId | イベントを一意に特定するID |
| eventNameJa | イベントの日本語名 |
| eventNameEn | イベントの英語名 |
| isExhibition | 出展イベントかどうか -trueの場合は出展イベント、falseの場合は通常のイベント |
| eventType | イベントのタイプ |
| ticketId |
イベントに紐づくticketを一意に特定するID |
| メールアドレス | |
| userType | ユーザータイプ |
| language | ユーザーの言語 |
| portraitUrl | ユーザーのプロフィール画像のURL |
| utmSource | 参照元 |
| utmMedium | キャンペーンのメディア |
| utmCampaign | キャンペーンの名前 |
| utmTerm | キーワード |
| utmContent | 広告コンテンツ |
| userName | ユーザーの名前 ※どちらも同じ値(ユーザーの名前）を返します。[name]は互換性維持のため存在しております。新規で利用される場合は[useName]を参照ください。 |
| name | |
| familyName | ユーザーの姓 |
| givenName | ユーザーの名 |
| affiliation | ユーザーの所属先・会社 |
| department | ユーザーの部署 |
| position | ユーザーの役職 |
| companyId | ブースに紐づいている場合は、ブースのID |
| customFieldXXXX | ユーザーのカスタムフィールド EventHubの[プロフィール項目]＞[項目ID]で設定しているID XXXXにはcustomFieldの項目IDが入ります |
❸ オンライン参加
発火タイミング：管理画面内のいずれかのイベントでユーザーがオンラインイベントに参加し、[オンライン参加]のフラグが参加に変更されたとき
| プロパティ名 | 説明 |
| eventId | イベントを一意に特定するID |
| eventKey | イベントを一意に特定するkey |
| eventNameJa | イベントの日本語名 |
| eventNameEn | イベントの英語名 |
| isExhibition | 出展イベントかどうか -trueの場合は出展イベント、falseの場合は通常のイベント |
| eventType | イベントのタイプ |
| userId | ユーザーを一意に特定するID |
| メールアドレス | |
| userType | ユーザータイプ |
| language | ユーザーの言語 |
| portraitUrl | ユーザーのプロフィール画像のURL |
| utmSource | 参照元 |
| utmMedium | キャンペーンのメディア |
| utmCampaign | キャンペーンの名前 |
| utmTerm | キーワード |
| utmContent | 広告コンテンツ |
| userName | ユーザーの名前 ※どちらも同じ値(ユーザーの名前）を返します。[name]は互換性維持のため存在しております。新規で利用される場合は[useName]を参照ください。 |
| name | |
| familyName | ユーザーの姓 |
| givenName | ユーザーの名 |
| affiliation | ユーザーの所属先・会社 |
| department | ユーザーの部署 |
| position | ユーザーの役職 |
| attendedAt | イベントに参加した時間 |
<tips>[オンライン参加]とは？
[基本設定]＞[イベント情報]で設定したイベント開始日時から終了日時の期間にアクセスしたユーザーに[参加]フラグが立ちます。[オンライン参加]フラグは、ユーザーリストやリードレポートでご確認いただけます。
詳細は、ユーザーリストについてをご覧ください。
</tips>
❹ QRチェックイン
発火タイミング：管理画面内のいずれか（入場・退場・セッション・ブース）のチェックインポイントでQRコードの読み取りが完了(=チェックイン）したとき
| プロパティ名 | 説明 |
| eventId | イベントを一意に特定するID |
| eventKey | イベントを一意に特定するKey |
| eventNameJa | イベントの日本語名 |
| eventNameEn | イベントの英語名 |
| isExhibition | 出展イベントかどうか -trueの場合は出展イベント、falseの場合は通常のイベント |
| eventType | イベントのタイプ |
| ticketId | イベントに紐づくticketを一意に特定するID |
| userId | ユーザーを一意に特定するID |
| メールアドレス | |
| userType | ユーザータイプ |
| language | ユーザーの言語 |
| userName | ユーザーの名前 |
| familyName | ユーザーの姓 |
| givenName | ユーザーの名 |
| affiliation | ユーザーの所属先・会社 |
| department | ユーザーの部署 |
| position | ユーザーの役職 |
| portraitUrl | ユーザーのプロフィール画像のURL |
| utmSource | 参照元 |
| utmMedium | キャンペーンのメディア |
| utmCampaign | キャンペーンの名前 |
| utmTerm | キーワード |
| utmContent | 広告コンテンツ |
| isStaff | スタッフかどうかを示すフラグ [来場者][出展者]の[ユーザーリスト]＞スタッフ設定ON/OFF |
| checkinPointId | チェックインポイントのID |
| category | チェックインポイントのカテゴリ（入場・退場・セッション・ブース） |
| checkinPointCompanyId | ブースに紐づく場合は、ブースのID |
| checkinPointSessionId | セッションに紐づく場合は、セッションのID |
| memo | チェックインポイントのポイント詳細 |
❺ ブース資料ダウンロード
発火タイミング：ブースに掲載する資料をユーザーがダウンロードしたとき
| プロパティ名 | 説明 |
| eventId | イベントを一意に特定するID |
| eventKey | イベントを一意に特定するkey |
| eventNameJa | イベントの日本語名 |
| eventNameEn | イベントの英語名 |
| isExhibition | 出展イベントかどうか -trueの場合は出展イベント、falseの場合は通常のイベント |
| eventType | イベントのタイプ |
| userId | ユーザを一意に特定するID |
| メールアドレス | |
| userType | ユーザータイプ |
| language | ユーザーの言語 |
| userName | ユーザーの名前 ※どちらも同じ値(ユーザーの名前）を返します。[name]は互換性維持のため存在しております。新規で利用される場合は[useName]を参照ください。 |
| name | |
| familyName | ユーザーの姓 |
| givenName | ユーザーの名 |
| affiliation | ユーザーの所属先・会社 |
| department | ユーザーの部署 |
| position | ユーザーの役職 |
| portraitUrl | ユーザーのプロフィール画像のURL |
| utmSource | 参照元 |
| utmMedium | キャンペーンのメディア |
| utmCampaign | キャンペーンの名前 |
| utmTerm | キーワード |
| utmContent | 広告コンテンツ |
| companyMaterialId | ブース資料のID |
| companyId | ブースのID |
| title | ブース資料のタイトル |
| thumbnailUrl | ブース資料サムネイルURL |
| fileName | ブース資料ファイルネーム |
❻セッション資料ダウンロード
発火タイミング：セッションに掲載する資料をユーザーがダウンロードしたとき
| プロパティ名 | 説明 |
| eventId | イベントを一意に特定するID |
| eventKey | イベントを一意に特定するkey |
| eventNameJa | イベントの日本語名 |
| eventNameEn | イベントの英語名 |
| isExhibition | 出展イベントかどうか -trueの場合は出展イベント、falseの場合は通常のイベント |
| eventType | イベントのタイプ |
| userId | ユーザを一意に特定するID |
| userType | ユーザータイプ |
| language | ユーザーの言語 |
| メールアドレス | |
| User Name | ユーザーの名前 |
| family name | ユーザーの姓 |
| given name | ユーザーの名 |
| affiliation | ユーザーの所属先・会社 |
| department | ユーザーの部署 |
| position | ユーザーの役職 |
| portraitUrl | ユーザーのプロフィール画像のURL |
| utmSource | 参照元 |
| utmMedium | キャンペーンのメディア |
| utmCampaign | キャンペーンの名前 |
| utmTerm | キーワード |
| utmContent | 広告コンテンツ |
| sessionId | セッションのID |
| sessionNameJa | セッションの日本語名 |
| sessionNameEn | セッションの英語名 |
| sessionMaterialId | セッション資料のID |
| title | 資料のタイトル |
| thumbnailUrl | 資料のサムネイルURL |
| fileName | 資料のファイルネーム |
❼ イベント作成
発火タイミング：イベントを作成・複製時、出展イベント作成・複製時
| プロパティ名 | 説明 |
| eventId | イベントを一意に特定するID |
| eventKey | イベントを一意に特定するkey |
| eventNameJa | イベントの日本語名 |
| eventNameEn | イベントの英語名 |
| isExhibition | 出展イベントかどうか -trueの場合は出展イベント、falseの場合は通常のイベント |
| eventType | イベントのタイプ |
| from | イベントの開始日時 |
| to | イベントの終了日時 |
| timezone | イベントのタイムゾーン |
| expire | イベントページの閉鎖日時 |
| senderName | イベントの主催者名 |
| replyEmail | イベントの主催者メールアドレス |
| createdAt | イベントの作成日時 |
| contractId | イベントに紐づくcontractを一意に特定するID |
| ticketId | チケットが作成されている場合のみ ※チケットを削除して複製したイベントの場合は空です 複数チケットがある場合は管理画面上で表示される一番上のチケットのID |
❽ アーカイブ動画視聴
発火タイミング：アーカイブ動画を一定時間視聴した時。 時間は契約アカウント毎に設定
| プロパティ名 | 説明 |
| eventId | イベントを一意に特定するID情報 |
| eventKey | イベントを一意に特定するkey |
| eventNameJa | イベントの日本語名 |
| eventNameEn | イベントの英語名 |
| isExhibition | 出展イベントかどうか -trueの場合は出展イベント、falseの場合は通常のイベント |
| eventType | イベントのタイプ |
| userId | ユーザを一意に特定するID |
| eventKey | イベントを一意に特定するkey |
| userType | ユーザタイプ |
| language | ユーザの言語 |
| メールアドレス | |
| userName | ユーザの名前 |
| familyName | ユーザの姓 |
| givenName | ユーザの名 |
| affiliation | ユーザの所属先 |
| department | ユーザの部署 |
| position | ユーザの役職 |
| portraitUrl | ユーザのプロフィール画像のURL |
| utmSource | 参照元 |
| utmMedium | キャンペーンのメディア |
| utmCampaign | キャンペーンの名前 |
| utmTerm | キーワード |
| utmContent | 広告コンテンツ |
| archiveVideoId | アーカイブビデオのID イベントページにてアーカイブ動画視聴時に、リンクバーに表示される数字がarchiveVideoIdです。 |
| captionJa | アーカイブビデオの日本語キャプション |
| captionEn | アーイブビデオの英語キャプション |
| totalMinutes | 累計視聴分数 |
❾ 掲示板投稿
発火タイミング：管理画面内のいずれかのイベントでEventHub掲示板（実名/匿名両方）に投稿があったとき
| プロパティ名 | 説明 |
| eventId | イベントを一意に特定するID |
| eventKey | イベントを一意に特定するkey |
| eventNameJa | イベントの日本語名 |
| eventNameEn | イベントの英語名 |
| isExhibition | 出展イベントかどうか -trueの場合は出展イベント、falseの場合は通常のイベント |
| eventType | イベントのタイプ |
| userId | ユーザを一意に特定するID |
| メールアドレス | |
| userType | ユーザータイプ |
| language | ユーザーの言語 |
| portraitUrl | ユーザーのプロフィール画像のURL |
| utmSource | 参照元 |
| utmMedium | キャンペーンのメディア |
| utmCampaign | キャンペーンの名前 |
| utmTerm | キーワード |
| utmContent | 広告コンテンツ |
| userName | ユーザーの名前 |
| familyName | ユーザーの姓 |
| givenName | ユーザーの名 |
| affiliation | ユーザーの所属先・会社 |
| department | ユーザーの部署 |
| position | ユーザーの役職 |
| videoId | 掲示板が紐づいている動画のID |
| videoNameJa | 掲示板が紐づいている動画の日本語名 |
| videoNameEn | 掲示板が紐づいている動画の英語名 |
| text | 掲示板投稿内容 |
| isAnonymous | 匿名の場合：true 実名の場合：false |
❿ セッション登録
発火タイミング：管理画面内のいずれかのイベントにおいて
- 登録時の事前セッションありの場合：セッション[参加登録]をクリックし、登録が[完了]したとき(※)
- イベントページ内：セッション[参加登録]をクリックもしくは、参加登録済みのセッションをキャンセルしたとき
| プロパティ名 | 説明 |
| eventId | イベントを一意に特定するID |
| eventKey | イベントを一意に特定するkey |
| eventNameJa | イベントの日本語名 |
| eventNameEn | イベントの英語名 |
| isExhibition | 出展イベントかどうか -trueの場合は出展イベント、falseの場合は通常のイベント |
| eventType | イベントのタイプ |
| userId | ユーザを一意に特定するID |
| メールアドレス | |
| userType | ユーザータイプ |
| language | ユーザーの言語 |
| portraitUrl | ユーザーのプロフィール画像のURL |
| utmSource | 参照元 |
| utmMedium | キャンペーンのメディア |
| utmCampaign | キャンペーンの名前 |
|
utmTerm |
キーワード |
| utmContent | 広告コンテンツ |
| userName | ユーザーの名前 |
| familyName | ユーザーの姓 |
| givenName | ユーザーの名 |
| affiliation | ユーザーの所属先・会社 |
| department | ユーザーの部署 |
| position | ユーザーの役職 |
| sessionId | セッションのID |
| sessionNameJa | セッションの日本語名 |
| sessionNameEn | セッションの英語名 |
| status | 登録した場合：register 登録をキャンセルした場合：cancel |
※ 登録時の事前セッションありの場合：
例: セッション[参加登録]を5つ実施し、イベント登録を完了させた場合、5つ分のWebhookが飛びます。
2. Webhookを設定する
① 管理画面上部にある[設定]をクリックします。
② 設定の[外部連携]を選択し、[Webhook]をクリックします。
③ 該当のWebhookを選択し、[編集]をクリックします。
④ 更新情報をリアルタイムに通知させる指定の[URL]を入力し、[保存]を選択します。
アーカイブ動画視聴のWebhookの場合は、[URL]の他に[通知間隔]も設定してください。
| 設定項目 | 必須/任意 | 説明 |
| 通知間隔 | 必須 |
通知する間隔を入力します。通知間隔は契約アカウント単位に設定可能です。 |
<attention>[通知間隔]に設定した分数、ユーザーの連続視聴が必要となります。
例：通知間隔が10分の場合
10分連続視聴したユーザーの情報が通知されます。
</attention>
⑤ これで設定は完了です🎉
各Webhookの発火タイミングに応じて、Webhookが作動し、指定したURLに情報が送信されます。
<tips> Webhookの送信を停止するには、該当Webhookの[有効化]トグルをOFFに変更してください。 </tips>
3. 注意・補足
- 上記Webhookは、管理画面内にあるすべてのイベントを対象に、該当Webhookが発火します。特定のイベントを対象にしたい場合は、通知設定時に、該当のeventIdの項目を指定いただきますようお願いいたします。