Webhook
Webhookとは
※ビジネスプラン以上でご利用いただける機能です。
※スタンダードプランは、拡張機能のお申し込みにより利用が可能です。
アフィリコード・システムで特定の操作が行われた際、外部サービスに情報を通知することができます。 ACS側から能動的に通知できるので、成果情報などがリアルタイムに連携可能になります。
Webhookの通知条件
Webhookの通知条件は以下のとおりです。対象情報に対し、それぞれ登録・編集の操作が行われた際に情報が通知先URLに送信されます。
- 通知対象情報
- アフィリエイター 、メディア、広告主、広告、提携申請、成果報酬
- リクエストメソッド
- 登録：POST 編集：PUT
各権限の操作状況による通知条件
各権限、対象情報に対して以下の操作をした場合に通知されます。
| 対象情報 | 権限（操作者） | 発生イベント |
|---|---|---|
| アフィリエイター | 管理者・スタッフ | 登録、編集 ※CSVインポートによる操作を含む |
| 代理店 | 登録 | |
| アフィリエイター | 編集 | |
| 一般（未ログインユーザー） | 登録 | |
| メディア | 管理者・スタッフ | 登録、編集 ※CSVインポートによる操作を含む |
| アフィリエイター | 登録、編集 | |
| 一般（未ログインユーザー） | 登録 | |
| 広告主 | 管理者・スタッフ | 登録、編集 ※CSVインポートによる操作を含む |
| 代理店 | 登録 | |
| 広告主 | 編集 | |
| 一般（未ログインユーザー） | 登録 | |
| 広告 | 管理者・スタッフ | 登録、編集 |
| 広告主 | 登録、編集 | |
| 提携申請 | 管理者・スタッフ | 登録、編集 |
| アフィリエイター | 登録 | |
| 広告主 | 編集 | |
| 成果報酬 | 管理者・スタッフ | 登録、編集 ※CSVインポートによる操作を含む |
| 広告主 | 編集 ※CSVインポートによる操作を含む | |
| 一般（未ログインユーザー） | 登録 |
以下情報の変更時は、Webhookの通知を行いません。
・アフィリエイター、広告主のパスワード変更時、ログイン時（最終ログイン日時の更新のみの場合）
・アフィリエイターが繰越方式の支払方法を選択している場合の「支払申請」のステータス変更時
Webhookの詳細な仕様については、仕様書を別途用意しております。
製品サイトお問い合わせフォーム よりお気軽にお問い合わせください。
通知条件の登録と通知ログ
1. 通知設定は、 歯車マーク > Webhook管理 - Webhook通知条件 から行います。
2. Webhook通知条件 ページの「Wehook通知条件登録」から設定します。
3. 通知条件を選択し、通知先URL、通知フォーマット（json、x-www-form-urlencoded ※いずれかを選択）を設定してください。
4. 設定後、所定の条件で通知されているかは、Webhook通知ログ一覧 で確認します。「通知先URL」のリンクより、通知内容の詳細が参照できます。
