Webhook は、会社で何かが発生したときに当社がアプリのアドレスに POST するメッセージです。これにより、他のアプリが繰り返し問い合わせる必要がなくなります。
-
ステップ 1: エンドポイントを追加
管理 → 設定 → API と Webhook の Webhook で、エンドポイントを追加 をクリックします。
-
ステップ 2: アドレスを入力
エンドポイント URL(公開されている https:// アドレスである必要があります)と、任意で 説明 を入力します。
-
ステップ 3: イベントを選択
イベント で必要なものにチェックを入れるか、今後追加されるものを含むすべてのイベント を選択します。
-
ステップ 4: 署名シークレットをコピー
保存後、署名シークレット が 1 回だけ表示されます。受信側のアプリにコピーすると、各メッセージが本当に当社から送信されたものかを確認できます。
-
ステップ 5: テストする
テストイベントを送信 をクリックし、配信ログ を確認します。
利用可能なイベント
- 取引先:取引先が作成または更新されました。
- 請求書:発行、全額支払済み、無効化。見積書:承諾。
- 支払:支払いまたは入金が計上されました。
- 仕入請求書:受領(計上)、全額支払済み。経費:経費が記録されました。
- 在庫:品目が発注点以下になりました。
- 休暇:休暇申請が作成されました。
配信と再試行
- アプリは 10 秒以内に 2xx ステータスで応答する必要があります。それ以外は失敗とみなされます。
- 失敗した配信は自動的に再試行されます。数時間にわたって最大 6 回、毎回待ち時間を長くして行われます。
- エンドポイントを 管理 で開くと 配信ログ が表示されます:各イベントの ペイロード、サーバーの レスポンス、ステータス(納品済み、失敗、保留中)。再送信 をクリックすると再度送信します。
- 一時停止するには このエンドポイントにイベントを送信 のチェックを外し、削除するには 削除 をクリックします。長期間失敗し続けるエンドポイントは自動的に無効になります。
署名を検証
各配信には X-Webhook-Signature: t=<timestamp>,v1=<signature> ヘッダーがあります。署名シークレットを使って「<timestamp>.<raw body>」の HMAC-SHA256 を計算し、v1 と比較します。5 分より古いタイムスタンプは拒否してください。X-Webhook-Id は再試行間で同じままなので、重複の除外に使用します。
関連ガイド
製品について質問
ソフトウェアでできること、作業の進め方、対応している国や言語について質問してください。回答はこれらのガイドに基づいています。
AI は間違えることがあります。リンク先のガイドを確認してください。