Webhook機能の仕様について

<注意点>
以下機能のご利用をご希望の場合、別途オプションのご契約が
必要でございますので、ご希望の場合は以下のメールアドレスにお問い合わせをお願い致します。

<ご連絡先メールアドレス>
support@billing-robo.jp

 

■機能概要
Webhookとは、Webアプリケーションでイベントが実行された際、外部サービスにHTTP で通知する仕組みです。

 

■設定方法
Webhook の設定は管理画面右上の歯車マークの「Webhook」より行えます。
設定の際には、以下の項目を設定、ご登録いただきます。

<A>
①Webhook取得時に必要となるWebhook署名キーの再発行(必須)
<B>
②Webhookを管理するWebhook名(必須)
③Webhookから POST されるデータを受け取る URL(必須)
④登録した Webhook 設定の説明(任意)
⑤Webhook発動のトリガーとなるイベント種別(必須)
 ・請求書発行
 ・郵送
 ・クレジットカード登録
<C>
[登録]ボタンをクリックするとWebhookが登録されます。
Webhook01.png
Webhook02.png



■データの受信
Webhook では指定された URL に POST でデータが送信されます。
請求管理ロボ サーバからアクセスできない URL やプライベートネットワークアドレスではご利用いただけません。

なお、データ受信後はステータスコード 200 番台で応答するようお願いいたします。
200 番台以外のレスポンスを検知した場合は、送信失敗とみなしてリトライを行います。

■リトライ
リトライ送信はWebhookログ画面より再通知が可能です。
①[Webhookログ]画面より、再通知を行いたいレコードにチェック
②「選択項目をリトライ」を押下
__________2019-12-04_9.25.40.png

■イベント
Webhook が発動されるイベントには以下のものがあります。

<イベント名>      / <発動タイミング>
請求書発行        / 請求書が作成されたタイミングで発動
郵送           / 請求書が郵送されたタイミングで発動
クレジットカード登録状況 / クレジットカード情報が登録、更新されたタイミングで発動

■Webhook詳細仕様書
Webhook請求書発行
Webhook郵送通知
Webhookクレジットカード登録状況通知