システム管理_Webhook設定
システム管理 ＞Webhook設定
1.概要
本画面では、管理画面やサイト表示時のWebhookを設定します。Webhookは、aishipで行われた各種処理情報を外部システムへ通知する機能です。ご利用を希望される場合はサポートセンターにお問い合わせください。
図.システム管理 ＞Webhook設定一覧画面
2.Webhook設定
Webhookの設定を行います。
図.Webhookの設定項目
2.1.項目概要
Webhook設定で取り扱う項目の定義は、以下の表の通りです。
表.Webhook設定の項目定義
項目 | 説明 |
タイミング | Webhookを実行するタイミングを選択。 |
URL | リクエスト先のURLを指定。 |
メソッド | リクエストに利用するHTTPメソッドを指定。 |
ヘッダー情報 | リクエストに付与するHTTPヘッダーをJSON形式で指定。 |
2.1.1.Webhook実行タイミング詳細
Webhook設定の各タイミングが発火する条件は、以下の表の通りです。
タイミング | 説明 |
(フロント)会員登録の入力内容確認の直前 | サイト内会員登録画面で「登録内容を確認する」ボタンを押し、標準のバリデーションでエラーがなかったとき、次の画面に遷移する直前に発火します。 |
(フロント)会員登録の直前 | サイト内会員登録確認画面、あるいは会員登録前のメールアドレス認証画面で「登録」ボタンを押し、標準のバリデーションでエラーがなかったとき、システム内での会員登録処理実行前に発火します。 |
(フロント)会員登録の直後 | サイト内会員登録確認画面、あるいは会員登録前のメールアドレス認証画面で「登録」ボタンを押し、標準のバリデーションでエラーがなかったとき、システム内での会員登録処理完了後に発火します。 |
(フロント)バスケット画面の表示時 | サイト内バスケットページを表示する直前に発火します。 |
(フロント)OPCの表示時 | ワンページカート利用時、サイト内カートページを表示する直前に発火します。 |
(フロント)注文確定の直前 | ワンページカート利用時、サイト内注文確認画面で注文確定ボタンを押し、標準のバリデーションでエラーがなかったとき、システム内での注文処理実行前に発火します。 ※ワンページカートを利用しない場合には発火しません。 |
(フロント)注文確定の直後 | サイト内注文確認画面で注文確定ボタンを押し、システム内での注文処理完了後に発火します。 |
(フロント)ソーシャルギフト受取入力の直後 | サイト内注文確認画面で注文確定ボタンを押し、システム内での注文処理完了後に発火します。 |
(フロント)マイページのTOP画面の表示時 | サイト内マイページのTOPを表示する直前に発火します。 |
(フロント)マイページの会員編集画面の表示時 | サイト内マイページの会員情報を編集する画面を表示する直前に発火します。 |
(フロント)マイページの会員情報編集画面の更新直前 | サイト内マイページの会員情報編集の確認画面で「更新する」ボタンを押し、標準のバリデーションでエラーがなかったとき、システム内での会員情報更新処理実行前に発火します。 |
(フロント)マイページの会員情報編集画面の更新直後 | サイト内マイページの会員情報編集の確認画面で「更新する」ボタンを押し、システム内での会員情報更新処理完了後に発火します。 |
(フロント)マイページのポイント状況画面の表示時 | サイト内マイページのポイント状況を確認する画面を表示する直前に発火します。 |
(フロント)退会の直前 | サイト内マイページの会員を退会する画面で「退会する」ボタンを押し、標準のバリデーションでエラーがなかったとき、システム内での会員退会処理実行前に発火します。 |
(フロント)退会の直後 | サイト内マイページの会員を退会する画面で「退会する」ボタンを押し、システム内での会員退会処理完了後に発火します。 |
(フロント)パスワード変更メールの送信直前 | サイト内パスワードを忘れた場合の会員IDとパスワードの確認画面で「確認メールを受け取る」ボタンを押し、標準のバリデーションでエラーがなかったとき、システム内でのパスワード再設定メール送信処理実行前に発火します。 |
(フロント)パスワード変更メールの送信直後 | サイト内パスワードを忘れた場合の会員IDとパスワードの確認画面で「確認メールを受け取る」ボタンを押し、システム内でのパスワード再登録メール送信処理完了後に発火します。 |
(フロント)パスワード変更の直前 | サイト内パスワードの再登録画面で「登録」ボタンを押し、標準のバリデーションでエラーがなかったとき、システム内でのパスワード再登録処理実行前に発火します。 |
(フロント)パスワード変更の直後 | サイト内パスワードの再登録画面で「登録」ボタンを押し、システム内でのパスワード再登録処理完了後に発火します。 |
(管理画面)顧客情報詳細の表示時 | 顧客管理>顧客一覧>顧客情報詳細画面を表示する直前に発火します。 |
(管理画面)顧客情報詳細の更新直前 | 顧客管理>顧客一覧>顧客情報詳細画面で「保存」ボタンを押し、標準のバリデーションでエラーがなかったとき、システム内での顧客情報更新処理実行前に発火します。 |
(管理画面)顧客情報詳細の更新直後 | 顧客管理>顧客一覧>顧客情報詳細画面で「保存」ボタンを押し、システム内での顧客情報更新処理完了後に発火します。 |
(管理画面)受注情報詳細の更新直前 | 受注管理>受注一覧>受注詳細画面で「保存」ボタンを押し、標準のバリデーションでエラーがなかったとき、システム内での受注情報更新処理実行前に発火します。 |
(管理画面)受注情報詳細の更新直後 | 受注管理>受注一覧>受注詳細画面で「保存」ボタンを押し、システム内での受注情報更新処理完了後に発火します。 |
(管理画面)受注情報の送付先情報の更新直前 | 受注管理>受注一覧>受注詳細画面>送付先情報を編集する画面で「保存」ボタンを押し、標準のバリデーションでエラーがなかったとき、システム内での送付先情報更新処理実行前に発火します。 |
(管理画面)受注情報の送付先情報の更新直後 | 受注管理>受注一覧>受注詳細画面>送付先情報を編集する画面で「保存」ボタンを押し、システム内での送付先情報更新処理完了後に発火します。 |
(管理画面)受注情報の明細情報の更新直前 | 受注管理>受注一覧>受注詳細画面>注文内容を編集する画面で「保存」ボタンを押し、標準のバリデーションでエラーがなかったとき、システム内での明細情報更新処理実行前に発火します。 |
(管理画面)受注情報の明細情報の更新直後 | 受注管理>受注一覧>受注詳細画面>注文内容を編集する画面で「保存」ボタンを押し、システム内での明細情報更新処理完了後に発火します。 |
(管理画面)WEBコンビニの入金通知(確報)の正常受理直後 | 決済方法にWebコンビニが選択された受注に関して、SBPSから「入金完了(確報)」の通知を受理し、システム内での決済情報更新処理完了後に発火します。 |
2.2.転送されるペイロード
Webhook設定の各タイミングでイベントが発生したときに転送されるペイロードは、以下の表の通りです。
※各項目に出力される情報は一例です。
表.各タイミングでイベントが発生したときに転送されるペイロード
タイミング | ペイロード |
(フロント)会員登録の入力内容確認の直前 | { “name”: “山田愛子”, // 氏名 “name_kana”: “ヤマダアイコ”, // 氏名(フリガナ) “zipcode”: “5200054″, // 郵便番号 “pref_state_id”: 27, // 都道府県番号 “address1″: “大津市”, // 郡市区 “address2”: “逢坂1丁目１番１号プエルタ大津１Ｆ”, // それ以降の住所 “tel”: “.0775251073”, // 電話番号 “mailaddress”: “aiko@rockwave.co.jp”, // メールアドレス “member_id”: “aiko@rockwave.co.jp”, // 会員ID “member_password”: “password”, // パスワード（平文） “fax”: “0775251074”, // FAX番号 “gender”: 1, // 性別 男性:1 女性:2 “birth_year”: 1990, // 生年月日(年) “birth_month”: 1, // 生年月日(月) “birth_day”: 1, // 生年月日(日) “company_name”: “株式会社ロックウェーブ”, // 会社名 “department_name”: “サポート部”, // 部署名 “accept_mailmagazine”: 1, // メルマガ購読状況 購読する:1 “freeform_item”: [ // 顧客管理>顧客登録フォーム設定で紐づけられたフリーフォーム { “item_no”: 1, // フリーフォーム項目のシステム内番号 “item_name”: “任意項目名”, // フリーフォーム項目名 “answer”: [“回答1”, “回答2”] // フリーフォーム回答内容 } ] } |
(フロント)会員登録の直前 | { “name”: “山田愛子”, // 氏名 “name_kana”: “ヤマダアイコ”, // 氏名(フリガナ) “zipcode”: “5200054″, // 郵便番号 “pref_state_id”: 27, // 都道府県番号 “address1″: “大津市”, // 郡市区 “address2”: “逢坂1丁目１番１号プエルタ大津１Ｆ”, // それ以降の住所 “tel”: “.0775251073”, // 電話番号 “mailaddress”: “aiko@rockwave.co.jp”, // メールアドレス “member_id”: “aiko@rockwave.co.jp”, // 会員ID “member_password”: “password”, // パスワード（平文） “fax”: “0775251074”, // FAX番号 “gender”: 1, // 性別 男性:1 女性:2 “birth_year”: 1990, // 生年月日(年) “birth_month”: 1, // 生年月日(月) “birth_day”: 1, // 生年月日(日) “company_name”: “株式会社ロックウェーブ”, // 会社名 “department_name”: “サポート部”, // 部署名 “accept_mailmagazine”: 1, // メルマガ購読状況 購読する:1 “freeform_item”: [ // 顧客管理>顧客登録フォーム設定で紐づけられたフリーフォーム { “item_no”: 1, // フリーフォーム項目のシステム内番号 “item_name”: “任意項目名”, // フリーフォーム項目名 “answer”: [“回答1”, “回答2”] // フリーフォーム回答内容 } ] } |
(フロント)会員登録の直後 | { “customer_no”: 123456 // 顧客No } |
(フロント)バスケット画面の表示時※1 | { “customer_no”: 123456, // 顧客No “is_login”: true, // ログインしているか “sku_summaries”: [ // カート内の商品情報 { “item_id”: “itemA”, // 商品管理番号 “variation1_id”: 2001, // バリエーション1選択肢番号 “variation2_id”: 2002, // バリエーション２選択肢番号 “quantity”: 2, // 数量 “rental_send_date”: “2024-01-10”, // レンタル発送日 “rental_reach_date”: “2024-01-11”, // レンタルお届け予定日 “rental_start_date”: “2024-01-12”, // レンタル利用開始日 “rental_end_date”: “2024-01-13”, // レンタル利用終了日 “rental_return_date”: “2024-01-14” // レンタル返却日 } ] } |
(フロント)OPCの表示時 | { “customer_no”: 123456, // 顧客No “is_login”: true // ログインしているか } |
(フロント)注文確定の直前 | { “customer_no”: 123456, // 顧客No “is_login”: true, // ログインしているか “billingAddress”: { // 送付先情報 “mailaddress”: “yamada@rockwave.co.jp”, // メールアドレス “name”: “山田愛子”, // 氏名 “nameKana”: “ヤマダアイコ”, /// 氏名（カナ） “zipcode”: “5200054″, // 郵便番号 “address1″: “大津市”, // 郡市区 “address2”: “逢坂1丁目１番１号プエルタ大津１Ｆ”, // それ以降の住所 “tel”: “.0775251073”, // 電話番号 “companyName”: “株式会社ロックウェーブ”, // 会社名 “departmentName”: “サポート部”, // 部署名 “gender”: 1, // 性別 男性:1 女性:2 “prefStateId”: 27, // 都道府県番号 “acceptMailmagazine”: 1 // メルマガ購読状況 購読する:1 }, “sku_summaries”: [ // カート内の商品情報 { “item_id”: “itemA”, // 商品管理番号 “variation1_id”: 2001, // バリエーション1選択肢番号 “variation2_id”: 2002, // バリエーション２選択肢番号 “quantity”: 2, // 数量 “rental_send_date”: “2024-01-10”, // レンタル発送日 “rental_reach_date”: “2024-01-11”, // レンタルお届け予定日 “rental_start_date”: “2024-01-12”, // レンタル利用開始日 “rental_end_date”: “2024-01-13”, // レンタル利用終了日 “rental_return_date”: “2024-01-14” // レンタル返却日 } ] } |
(フロント)注文確定の直後 | { “shop_order_no”: “202510221925448273”, // 注文番号 “customer_no”: 123456, // 顧客No “is_login”: true // ログインしているか } |
(フロント)ソーシャルギフト受取入力の直後 | { “shop_order_no”: “202510221925448273” // 注文番号 } |
(フロント)マイページのTOP画面の表示時 | { “customer_no”: 123456 // 顧客No } |
(フロント)マイページの会員編集画面の表示時 | { “customer_no”: 123456 // 顧客No } |
(フロント)マイページの会員情報編集画面の更新直前 | { “customer_no”: 123456, // 顧客No “name”: “山田愛子”, // 氏名 “name_kana”: “ヤマダアイコ”, // 氏名(フリガナ) “zipcode”: “5200054″, // 郵便番号 “pref_state_id”: 13, “address1″: “大津市”, // 郡市区 “address2”: “逢坂1丁目１番１号プエルタ大津１Ｆ”, // それ以降の住所 “tel”: “.0775251073”, // 電話番号 “mailaddress”: “aiko@rockwave.co.jp”, // メールアドレス “member_id”: “aiko@rockwave.co.jp”, // 会員ID “old_member_password”: “exsample”, // 現在のパスワード “member_password”: “password”, // 新しいパスワード（平文） “fax”: “0775251074”, // FAX番号 “gender”: 1, // 性別 男性:1 女性:2 “birth_year”: 1990, // 生年月日(年) “birth_month”: 1, // 生年月日(月) “birth_day”: 1, // 生年月日(日) “company_name”: “株式会社ロックウェーブ”, // 会社名 “department_name”: “サポート部”, // 部署名 “accept_mailmagazine”: 1, // メルマガ購読状況 購読する:1 “freeform_item”: [ // 顧客管理>顧客登録フォーム設定で紐づけられたフリーフォーム { “item_no”: 1, // フリーフォーム項目のシステム内番号 “item_name”: “任意項目名”, // フリーフォーム項目名 “answer”: [“回答1”, “回答2”] // フリーフォーム回答内容 } ] } |
(フロント)マイページの会員情報編集画面の更新直後 | { “customer_no”: 123456 // 顧客No } |
(フロント)マイページのポイント状況画面の表示時 | { “customer_no”: 123456 // 顧客No } |
(フロント)パスワード変更メールの送信直前※2 | { “customer_no”: 123456, // 顧客No “mailaddress”: “example@example.com”, “birth_year”: 1990, // 生年月日(年) “birth_month”: 1, // 生年月日(月) “birth_day”: 1 // 生年月日(日) } |
(フロント)パスワード変更メールの送信直後※2 | { “customer_no”: 123456, // 顧客No “mailaddress”: “example@example.com”, “birth_year”: 1990, // 生年月日(年) “birth_month”: 1, // 生年月日(月) “birth_day”: 1, // 生年月日(日) } |
(フロント)パスワード変更の直前 | { “customer_no”: 123456, // 顧客No “member_password”: “password” // 新しいパスワード（平文） } |
(フロント)パスワード変更の直後 | { “customer_no”: 123456, // 顧客No “member_password”: “password” // 新しいパスワード（平文） } |
(フロント)退会の直前 | { “customer_no”: 123456 // 顧客No } |
(フロント)退会の直後 | { “customer_no”: 123456 // 顧客No } |
(管理画面)顧客情報詳細の表示時 | { “customer_no”: 123456 // 顧客No } |
(管理画面)顧客情報詳細の更新直前 | { “customer_no”: 123456, // 顧客No “name”: “山田愛子”, // 氏名 “name_kana”: “ヤマダアイコ”, // 氏名(フリガナ) “zipcode”: “5200054″, // 郵便番号 “pref_state_id”: 27, // 都道府県番号 “address1″: “大津市”, // 郡市区 “address2”: “逢坂1丁目１番１号プエルタ大津１Ｆ”, // それ以降の住所 “tel”: “.0775251073”, // 電話番号 “mailaddress”: “aiko@rockwave.co.jp”, // メールアドレス “fax”: “0775251074”, // FAX番号 “gender”: 1, // 性別 男性:1 女性:2 “birth_year”: 1990, // 生年月日(年) “birth_month”: 1, // 生年月日(月) “birth_day”: 1, // 生年月日(日) “company_name”: “株式会社ロックウェーブ”, // 会社名 “department_name”: “サポート部”, // 部署名 “accept_mailmagazine”: 1, // メルマガ購読状況 購読する:1 “freeform_item”: [ // 顧客管理>顧客登録フォーム設定で紐づけられたフリーフォーム { “item_no”: 1, // フリーフォーム項目のシステム内番号 “item_name”: “任意項目名”, // フリーフォーム項目名 “answer”: [“回答1”, “回答2”] // フリーフォーム回答内容 } ] } |
(管理画面)顧客情報詳細の更新直後 | { “customer_no”: 123456 // 顧客No } |
(管理画面)受注情報詳細の更新直前 | { “shop_order_no”: “202510221925448273”, // 注文番号 “customer_no”: 123456 // 顧客No } |
(管理画面)受注情報詳細の更新直後 | { “shop_order_no”: “202510221925448273”, // 注文番号 “customer_no”: 123456 // 顧客No } |
(管理画面)受注情報の送付先情報の更新直前 | { “shop_order_no”: “202510221925448273”, // 注文番号 “package_no”: 145233 // 出荷番号 } |
(管理画面)受注情報の送付先情報の更新直後 | { “shop_order_no”: “202510221925448273”, // 注文番号 “package_no”: 145233 // 出荷番号 } |
(管理画面)受注情報の明細情報の更新直前 | { “shop_order_no”: “202510221925448273” // 注文番号 } |
(管理画面)受注情報の明細情報の更新直後 | { “shop_order_no”: “202510221925448273” // 注文番号 } |
(管理画面)WEBコンビニの入金通知(確報)の正常受理直後 | { “shop_order_no”: “202510221925448273” // 注文番号 } |
※1.sku_summariesパラメータはワンページカート利用時にのみ出力
※2.birth_year,birth_month,birth_dayは顧客管理>会員設定 「パスワード再発行時に生年月日を確認する」利用時のみ出力
その他設定箇所の各タイミングでイベントが発生したときに転送されるペイロードは、以下の表の通りです。
※各項目に出力される情報は一例です。
表.その他設定箇所の各タイミングでイベントが発生したときに転送されるペイロード
設定箇所 | ペイロード |
システム管理>外部ログイン設定 | { “mailaddress”: “aiko@rockwave.co.jp”, // メールアドレス “member_id”: “aiko@rockwave.co.jp”, // 会員ID “member_password”: “password” // パスワード（平文） } |
サイト管理>機能パーツ作成>ワークフロー機能パーツ ※1 | { “customer_no”: 123456, // 顧客No “is_login”: true, // ログインしているか “sku_summaries”: [ // カート内の商品情報 { “item_id”: “itemA”, // 商品管理番号 “variation1_id”: 2001, // バリエーション1選択肢番号 “variation2_id”: 2002, // バリエーション２選択肢番号 “quantity”: 2, // 数量 “rental_send_date”: “2024-01-10”, // レンタル発送日 “rental_reach_date”: “2024-01-11”, // レンタルお届け予定日 “rental_start_date”: “2024-01-12”, // レンタル利用開始日 “rental_end_date”: “2024-01-13”, // レンタル利用終了日 “rental_return_date”: “2024-01-14” // レンタル返却日 } ] } |
※1.sku_summariesパラメータはワンページカート利用時にのみ出力
2.2.1.都道府県番号
ペイロードで返される都道府県番号の対応表は以下の表の通りです。
表.都道府県対応表
pref_state_id | 都道府県 |
1 | 北海道 |
2 | 青森県 |
3 | 秋田県 |
4 | 岩手県 |
5 | 宮城県 |
6 | 山形県 |
7 | 福島県 |
8 | 栃木県 |
9 | 新潟県 |
10 | 群馬県 |
11 | 埼玉県 |
12 | 茨城県 |
13 | 千葉県 |
14 | 東京都 |
15 | 神奈川県 |
16 | 山梨県 |
17 | 長野県 |
18 | 岐阜県 |
19 | 富山県 |
20 | 石川県 |
21 | 静岡県 |
22 | 愛知県 |
23 | 三重県 |
24 | 奈良県 |
25 | 和歌山県 |
26 | 福井県 |
27 | 滋賀県 |
28 | 京都府 |
29 | 大阪府 |
30 | 兵庫県 |
31 | 岡山県 |
32 | 鳥取県 |
33 | 島根県 |
34 | 広島県 |
35 | 山口県 |
36 | 香川県 |
37 | 徳島県 |
38 | 愛媛県 |
39 | 高知県 |
40 | 福岡県 |
41 | 佐賀県 |
42 | 大分県 |
43 | 熊本県 |
44 | 宮崎県 |
45 | 長崎県 |
46 | 鹿児島県 |
47 | 沖縄県 |