Webhook 管理
[参考]Webhook 通知のイベント一覧
Webhook機能では「顧客」「受注」「定期受注」「商品」「広告URL」「ジョブ」「住所」における、いずれかのイベントをトリガーとしてデータ通知が行えます。
各カテゴリーのイベント一覧は以下のとおりです。
各カテゴリーのイベント一覧
顧客
customer_created(非推奨)
> 顧客が作成されたタイミングで Webhook 通知を送信します。
customer_updated(非推奨)
> 顧客が更新されたタイミングで Webhook 通知を送信します。
customer_destroyed
> 顧客が削除されたタイミングで Webhook 通知を送信します。
customer_member
> 顧客のステータスが「会員」になったタイミングで Webhook 通知を送信します。
customer_cancel
> 顧客のステータスが「退会」になったタイミングで Webhook 通知を送信します。
受注
order_created(非推奨)
> 受注が作成されたタイミングで Webhook 通知を送信します。
order_updated(非推奨)
> 受注が更新されたタイミングで Webhook 通知を送信します。
order_completed (2024/05リリースより利用可能)
> 受注が完全に作成されきったタイミングで Webhook 通知を送信します。
※ サンクスオファー決済を利用している場合、こちらの利用を推奨します。
order_complete
> 受注の対応状況が「注文確定」になったタイミングで Webhook 通知を送信します。
※ サンクスオファー決済を利用している場合、1度目の決済時に「注文確定」となるためこちらの利用は非推奨となります。
order_shipped
> 受注の対応状況が「発送完了」になったタイミングで Webhook 通知を送信します。
order_delivered
> 受注の対応状況が「配送完了」になったタイミングで Webhook 通知を送信します。
order_canceled
> 受注の対応状況が「キャンセル」になったタイミングで Webhook 通知を送信します。
定期受注
subs_order_created(非推奨)
> 定期受注が作成されたタイミングで Webhook 通知を送信します。
subs_order_updated(非推奨)
> 定期受注が更新されたタイミングで Webhook 通知を送信します。
subs_order_active
> 定期受注の対応状況が「有効」になったタイミングで Webhook 通知を送信します。
subs_order_suspend
> 定期受注の対応状況が「停止」になったタイミングで Webhook 通知を送信します。
subs_order_canceled
> 定期受注の対応状況が「キャンセル」になったタイミングで Webhook 通知を送信します。
決済
payment_created(非推奨)
> 決済が作成されたタイミングで Webhook 通知を送信します。
payment_updated(非推奨)
> 決済が更新されたタイミングで Webhook 通知を送信します。
payment_destroyed
> 決済が削除されたタイミングで Webhook 通知を送信します。
payment_registration_failed
> 決済状況が「取引登録失敗」になったタイミングで Webhook 通知を送信します。
payment_credit_exam_failed
> 決済状況が「与信審査エラー」になったタイミングで Webhook 通知を送信します。
payment_credit_exam_hold
> 決済状況が「与信保留」になったタイミングで Webhook 通知を送信します。
payment_credit_exam_processing
> 決済状況が「与信審査中」になったタイミングで Webhook 通知を送信します。
payment_credit_exam_completed
> 決済状況が「与信審査完了」になったタイミングで Webhook 通知を送信します。
payment_cash_on_delivery_authed
> 決済状況が「入金待ち」になったタイミングで Webhook 通知を送信します。
payment_authed
> 決済状況が「仮売上完了」になったタイミングで Webhook 通知を送信します。
payment_auth_failed
> 決済状況が「仮売上失敗」になったタイミングで Webhook 通知を送信します。
payment_update_failed
> 決済状況が「取引修正失敗」になったタイミングで Webhook 通知を送信します。
payment_completed
> 決済状況が「売上完了」になったタイミングで Webhook 通知を送信します。
payment_sales_failed
> 決済状況が「売上失敗」になったタイミングで Webhook 通知を送信します。
payment_void
> 決済状況が「取消完了」になったタイミングで Webhook 通知を送信します。
payment_void_failed
> 決済状況が「取引キャンセル失敗」になったタイミングで Webhook 通知を送信します。
payment_shipment_report_waiting
> 決済状況が「出荷報告待ち」になったタイミングで Webhook 通知を送信します。
payment_shipment_report_failed
> 決済状況が「出荷報告失敗」になったタイミングで Webhook 通知を送信します。
商品
product_created(非推奨)
> 商品が作成されたタイミングで Webhook 通知を送信します。
product_updated(非推奨)
> 商品が更新されたタイミングで Webhook 通知を送信します。
product_destroyed
> 商品が削除されたタイミングで Webhook 通知を送信します。
広告URL
url_created(非推奨)
> 広告URLが作成されたタイミングで Webhook 通知を送信します。
url_updated(非推奨)
> 広告URLが更新されたタイミングで Webhook 通知を送信します。
url_destroyed
> 広告URLが削除されたタイミングで Webhook 通知を送信します。
ジョブ
batch_created(非推奨)
> ジョブが作成されたタイミングで Webhook 通知を送信します。
batch_updated(非推奨)
> ジョブのステータスが更新されたタイミングで Webhook 通知を送信します。
batch_destroyed(非推奨)
> ジョブが削除されたタイミングで Webhook 通知を送信します。
batch_success
> ジョブのステータスが「完了」になったタイミングで Webhook 通知を送信します。
batch_failure
> ジョブのステータスが「失敗」になったタイミングで Webhook 通知を送信します。
batch_canceled
> ジョブのステータスが「キャンセル」になったタイミングで Webhook 通知を送信します。
住所
address_customer_billing_created(非推奨)
> 顧客の請求先住所が作成されたタイミングで Webhook 通知を送信します。
address_order_billing_created(非推奨)
> 受注の請求先住所が作成されたタイミングで Webhook 通知を送信します。
address_customer_shipping_created(非推奨)
> 顧客のお届先住所が作成されたタイミングで Webhook 通知を送信します。
address_order_shipping_created(非推奨)
> 受注のお届先住所が作成されたタイミングで Webhook 通知を送信します。
address_subs_order_shipping_created(非推奨)
> 定期受注のお届先住所が作成されたタイミングで Webhook 通知を送信します。
address_customer_billing_updated(非推奨)
> 顧客の請求先住所が更新されたタイミングで Webhook 通知を送信します。
address_order_billing_updated(非推奨)
> 受注の請求先住所が更新されたタイミングで Webhook 通知を送信します。
address_customer_shipping_updated(非推奨)
> 顧客のお届先住所が更新されたタイミングで Webhook 通知を送信します。
address_order_shipping_updated(非推奨)
> 受注のお届先住所が更新されたタイミングで Webhook 通知を送信します。
address_subs_order_shipping_updated(非推奨)
> 定期受注のお届先住所が更新されたタイミングで Webhook 通知を送信します。
address_customer_shipping_destroyed
> 顧客のお届先住所が削除されたタイミングで Webhook 通知を送信します。
Caution!!
ジョブのステータスは一括処理が完了したかどうかの表示です。 実行結果にエラーがないという意味ではないので、かならず実行結果をご確認ください。
この記事の目次
このセクションの記事
Webhook 管理