Webhookでデータを連携する
はじめに
Webhook 連携により、immdio Forms で特定のイベントが発生したときに、指定したURLにイベントデータをPOSTすることができます。 リードの詳細をCRMやSaasツールに連携する際にご利用ください。
Webhookは、フォーム編集ページから設定できます。
設定方法
追加
以下の手順でWebhook設定を追加することができます。
イベントタイプを選択
Webhook URLを入力
「追加」ボタンをクリック
フォームを更新する（「更新を保存」をクリック）
1つのイベントタイプに対しURLを3つまで指定することができます。
イベントタイプ
説明
初回送信
フォーム入力後、リード情報をリアルタイム連携
2ページ目/更新送信
接客メモ・担当者再編集の送信後、リード情報をリアルタイム連携
リード出力
リード画面から、選択したリードのみMarketoへリアルタイム連携
Webhook URLを指定する際、以下の点にご注意ください。
http:// や https:// のプロトコルでURLが始まっていること
ポート番号が有効な範囲内であること（0～65535）
利用可能なURL例
利用不可なURL例
http://example.com:65536
削除
削除ボタンをクリックすることで削除することができます。
リクエスト
Webhook詳細設定から、ヘッダーやボディーなどのリクエスト情報を設定できます。
リクエストヘッダ
リクエストヘッダには以下の情報が含まれます。上書きしたい値や追加したい値がある場合は [Header] に JSON 形式で追加してください
リクエストボディ
[Body] を未設定にするとデフォルトの値（例1）が body 情報として送信されます。
<面談予約>
例1
基本入力項目
id
string
true
リードのID
at
string
true
[初回送信]または[2ページ目/更新送信]の日時
name
string
true
名前 ※「姓名を分ける」にチェックがない場合のみ
lastName
string
true
姓 ※「姓名を分ける」にチェックがある場合のみ
firstName
string
false
名 ※「姓名を分ける」にチェックがある場合のみ
string
false
メールアドレス
company
string
false
会社名
zip
string
false
郵便番号
address
string
false
住所
department
string
false
部署
position
string
false
役職
tel
string
false
電話番号
mobile
string
false
携帯電話
web
string
false
WEB
イチサン・ST&E などの会社情報
[基本入力項目 > 会社名 > 会社情報の補足]でイチサンやST&Eを指定していると、それらの値がリクエストボディに含まれるようになります
is_company_name
string
[イチサン] 会社名
is_company_name_half
string
[イチサン] 会社名(半角)
is_company_name_kana
string
[イチサン] 法人名読み
is_company_id
string
[イチサン] 法人番号
is_location_zipcode
string
[イチサン] 郵便番号
is_location_full
string
[イチサン] 所在地
is_location_pref
string
[イチサン] 所在地(都道府県)
is_location_city
string
[イチサン] 所在地(市区町村)
is_location_town
string
[イチサン] 所在地(町丁目)
is_location_street
string
[イチサン] 所在地(番地以降)
is_employee_num
string
[イチサン] 従業員数
is_invoice_id
string
[イチサン] インボイス登録番号
ste_corporate_name_kana
string
[ST&E] 会社名カナ
ste_phone_number
string
[ST&E] 電話番号
ste_zip_code
string
[ST&E] 郵便番号
ste_prefecture_code
string
[ST&E] 都道府県コード
ste_prefecture
string
[ST&E] 都道府県
ste_city_code
string
[ST&E] 市町村コード
ste_city
string
[ST&E] 市町村
ste_address
string
[ST&E] 住所番地
ste_city_address
string
[ST&E] 市町村・番地
ste_corporate_number
string
[ST&E] 法人番号
ste_registrated_number
string
[ST&E] 登録番号
ste_school_code
string
[ST&E] 学校コード
ste_industry_code
string
[ST&E] 業種コード
ste_industry_kbn
string
[ST&E] 業種
ste_listed_code
string
[ST&E] 上場市場コード
ste_listed_kbn
string
[ST&E] 上場市場区分
ste_capital_code
string
[ST&E] 資本金コード
ste_capital_kbn
string
[ST&E] 資本金区分
ste_capital_val
string
[ST&E] 資本金
ste_revenue_code
string
[ST&E] 年間売上高コード
ste_revenue_kbn
string
[ST&E] 年間売上高区分
ste_revenue_val
string
[ST&E] 年間売上高
ste_employee_code
string
[ST&E] 従業員数コード
ste_employee_kbn
string
[ST&E] 従業員数区分
ste_employee_val
string
[ST&E] 従業員数
ste_headquarter_kbn
string
[ST&E] 本社/拠点/工場
ste_hp_url
string
[ST&E] WebサイトURL
ste_fax_number
string
[ST&E] FAX
ste_nta_zip_code
string
[ST&E] 企業登録郵便番号
ste_nta_prefecture_code
string
[ST&E] 企業登録都道府県コード
ste_nta_prefecture
string
[ST&E] 企業登録都道府県
ste_nta_city_code
string
[ST&E] 企業登録市町村コード
ste_nta_city
string
[ST&E] 企業登録市町村
ste_nta_address
string
[ST&E] 企業登録番地
ste_nta_city_address
string
[ST&E] 企業登録市町村・番地
拡張入力項目・固定値
拡張入力項目や固定値が設定されていると**、**識別子 と値（入力値）がリクエストボディに含まれるようになります
カスタムボディー
[Body] に任意の body 情報を JSON 形式で設定できます。
また “識別子”や項目の”名前” をタグ（{{xxxx}}）として使用することで、フォームの入力情報を埋め込むこともできます。
この body 情報だと、`”name”: “{{name}}”` が `”name”: “イメディオ太郎”` にタグが値に置き換わります。
外部連携
webhook の通常利用の場合は、カスタムに設定しておいてください。
イメディオがサポートする外部サービスを利用する際に設定します。
レスポンス
お使いのシステムがImmeidoからWebhookリクエストを受信する際は、ステータスコード200のレスポンスを返却するようにしてください。
タイムアウトなどが発生すると送信エラーとなります。
最終更新
役に立ちましたか？