ウェブフックの配信を確認し、不具合を修正する

Notiondesk ウェブフックエンドポイントの配信ログを読み取り、再試行と一時停止を理解し、一時停止されたエンドポイントを再開し、配信失敗を修正します。

1 分で読めます

各エンドポイントは、送信されたリクエストのログを保持します。これを使用して、サーバーが受信した内容、リクエストが失敗した理由、および再試行されるタイミングを確認できます。

簡単な方法: [設定] > [開発者] > [Webhook]に移動し、エンドポイントを開いて[最近の配信]までスクロールします。行をクリックすると、レスポンスとリクエストボディが表示されます。

最近の配達状況を読む

  1. 設定 > 開発者 > Webhooksに移動します。
  1. 終点をクリックしてください。
  1. 最近の配達までスクロールしてください。

このリストには、過去14日間の最新の100件の配送状況が表示されます。各行には、イベント、発生元のヘルプセンター(またはワークスペース)、結果、および時刻が表示されます。

アイコン状態それはどういう意味か
グリーンチェック配達済みサーバーは2xxステータスコードで応答しました
オレンジ色の時計保留中まだ送信されていないか、次の試行を待っています。試行が失敗した場合は、結果が表示され、その後に再試行中であることが示されます(例: 503、再試行中)。
赤十字失敗したすべての試行が失敗しました。この行には最後の結果が表示されます。
グレーマイナスキャンセルエンドポイントが一時停止またはオフになっていたか、ヘルプセンターがイベントを受信できなくなったため、送信されませんでした。次回の試行までお待ちください。

配達を開く

行をクリックして開きます。

  • 配信ID :X-ND-Deliveryヘッダーと同じ値なので、サーバーのログでリクエストを見つけることができます。
  • 応答:ステータスコードまたは失敗理由、サーバーの応答時間、および試行回数。
  • リクエスト本文:送信されたJSONデータです。コピーするには「コピー」をクリックしてください。

レスポンスボディは保存されません。連絡先メッセージ、フィードバック、チームメイト、参加リクエストなど、個人データを含むイベントの場合、リクエストボディは配信が完了すると削除されます。

再試行

サーバーが2xx以外のステータスコードで応答した場合、リダイレクトした場合、5秒以内に応答を開始しない場合、または合計で10秒以上かかった場合、配信は失敗します。その後、Notiondeskは再試行します。

試すいつ
1すぐに
2最初の試みから1分後
3 2回目の試みから10分後
4 3回目の試みから1時間後
5 4回目の試みから6時間後

5回の試行に失敗すると、配信は「失敗」とマークされます。テストイベントおよび「署名失敗」とマークされた配信は再試行されません。

大規模な同期処理など、複数のイベントが同時に発生する場合、配信は送信される前に待機することがあります。通常は数分ですが、サーバーの応答が遅い場合は最大1時間かかることもあります。配信は保留状態のままで、破棄されることはありません。

エンドポイントが一時停止された場合

Notiondesk は、10 回連続で配信が試行しても失敗し、かつ最初の失敗から少なくとも 24 時間経過している場合にエンドポイントを一時停止します。テスト イベントはカウントされません。

エンドポイントが一時停止された場合:

  • 「一時停止」と表示され、イベントの受信が停止します。既に計画されていた試行はキャンセルされます。
  • ワークスペースの所有者と管理者には、「Webhookエンドポイントが一時停止されました」という件名のメールが1通送信されます。このメールには、エンドポイント名、ホスト、およびWebhook設定へのリンクが含まれています。
  • 一時停止期間中のイベントは、後日送信されません。

要約すると:

  1. サーバーを修正してください。 「最近の配信」の下にあるエラー理由に、何が問題だったのかが表示されます。
  1. 「テストイベントを送信」をクリックし、 「配信済み」と表示されていることを確認してください。
  1. 「再開」をクリックしてください。

エンドポイントは再び新しいイベントを受信し始め、障害カウントがリセットされます。

エンドポイントがアクティブな状態であるにもかかわらず、配信が繰り返し失敗する場合は、一時停止される前に、エンドポイントのページに最初の失敗日とともに「以降失敗しています」という警告が表示されます。

配送失敗を修正する

サーバーが応答した場合は、その行にステータスコードが表示されます。応答がない場合は、その理由が表示されます。

理由あなたが見るものどうしたの修正方法
エラー状態ステータスコード( 500や401など)サーバーからエラーが返されましたその時間帯のサーバーログを確認してください。エンドポイントがPOSTリクエストを受け入れていること、および署名チェックで正しいシークレットが使用されていることを確認してください。
リダイレクトが拒否されましたリダイレクトコード(例: 301または302)サーバーがリクエストをリダイレクトしましたエンドポイント設定に最終URLを入力してください
アドレスがブロックされましたアドレスがブロックされましたドメインはプライベートアドレスまたは内部アドレスを指していますドメインを公開サーバーに向ける
接続に失敗しました接続に失敗しましたNotiondesk はサーバーに接続できませんでしたドメインが解決されること、TLS証明書が有効であること、ポート443または8443が開いていることを確認してください。
タイムアウトタイムアウトサーバーが5秒以内に応答を開始しなかったか、10秒以上かかりました。まず200で回答し、その後バックグラウンドで処理を実行します。
署名に失敗しました署名に失敗しましたNotiondesk はリクエストに署名できませんでしたこれは弊社側の問題であり、再試行は行われません。テストイベントを送信していただき、再度発生する場合はご連絡ください。

テストイベントを送信する

エンドポイントページで「テストイベントを送信」をクリックすると、そのエンドポイントにpingイベントが送信されます。これは「最近の配信」の上部に表示されます。

  • テストイベントは一度だけ送信され、再試行は行われません。
  • エンドポイントが一時停止している間に送信することで、再開する前に修正内容を確認できます。
  • 各ワークスペースは、1時間あたり最大20件のテストイベントを送信できます。それを超えると、「テストイベントが多すぎます。後でもう一度お試しください。」というメッセージが表示されます。

よくある質問

配達に失敗した商品を再送することはできますか?

いいえ。ご自身で処理する必要がある場合は、配信を開いて「コピー」をクリックし、リクエスト本文を取得してください。

配送依頼の本文が欠落しているのはなぜですか?

そのイベントには個人データが含まれていたため、配達完了後にその遺体は撤去された。

配達された商品はどのくらいの期間保管されますか?

14日間。最近の配達には、最新の100件が表示されます。

テストイベントが成功した場合、一時停止されたエンドポイントは再開されますか?

いいえ。これはサーバーの状態を確認するだけです。イベントの受信を再開するには、 「再開」をクリックしてください。

エンドポイントを削除すると、キューに登録されているイベントはどうなりますか?

それらは送信されず、エンドポイントの配信ログもそれと共に削除されます。

関連する記事

このページは役に立ちましたか?

Still need help? Ask us