失敗した Webhook が教えてくれないことをすべて
通知が届かないとき、確認すべきことはいつも同じです。送信元は本当に呼び出したのか。呼び出していたなら、当社側で何が問題だったのか。
すべてのリクエストのログ
すべての呼び出しを新しいものから順に記録し、その場で展開できます。メソッド、送信元 IP、サイズ、コンテンツタイプをひと目で確認できます。
ヘッダーとペイロードを完全に確認
届いたままの完全なヘッダーと未加工のボディを確認できます。サービスが送信すると主張している内容と、実際に送信された内容を比較できます。
テンプレートが生成したメッセージ
ペイロードから生成されたテンプレートのメッセージを、ペイロード本体と並べて確認できます。テンプレートの不具合を推測で探す必要はありません。
失敗理由を明示
失敗には具体的な理由が付きます。不正な JSON、%path% の欠落による空のメッセージ、無効な Webhook などが表示されます。
伏せ字化と暗号化
Authorization、cookie、API キーのヘッダーは保存前に伏せられ、ペイロードはお客様のキーで保存時に暗号化されます。
絞り込み、ページ送り、取得
ダッシュボードで結果による絞り込みやページ送りができます。API から取得して、ご自身で分析することもできます。
実際に何が届いたのかを確認する
サービスの接続先に設定する
Webhook を作成し、いつも通りサービスの設定にその URL を入力します。
履歴を開く
ダッシュボードで Webhook を開き、その履歴に進みます。
呼び出しを展開する
任意の呼び出しを展開すると、ヘッダー、ボディ、生成されたメッセージ、失敗の原因を確認できます。
Webhook 履歴の仕組み
Webhook URL に届いたリクエストは、処理される前にすべて記録されます。処理が終わると結果が付与されます。そのため、成功した呼び出しと同じくらい、失敗した呼び出しもはっきり確認できます。無効にしたまま忘れていた Webhook への呼び出しも含まれます。
ダッシュボードで Webhook を開くと履歴が表示されます。新しいものから順に並び、各行を展開するとクエリ文字列、ヘッダーの全体、JSON 整形されたボディを確認できます。同じデータは REST API からも取得でき、success と error で絞り込めます。
テンプレートのデバッグ
最もよくある失敗はネットワークの問題ではありません。%path% のプレースホルダーが、送信元が実際には送っていないフィールドを指していることです。履歴では未加工のペイロードとテンプレートが生成したメッセージを並べて表示するため、通常は数秒で不一致に気づけます。
プライバシー
ペイロードには秘密情報が含まれることが多いため、お客様専用のキーで保存時に暗号化します。Authorization、cookie、API キーのヘッダーは、保存前に [redacted] に置き換えられます。保存期間は無料プランの 7 日間から、Large の 1 年間までです。
よくある質問
タイムスタンプ、HTTP メソッド、送信元 IP、コンテンツタイプ、クエリ文字列、ヘッダーの全体、未加工のボディ、ペイロードのサイズ、テンプレートから生成されたメッセージ、通知が作成されたかどうか、作成されなかった場合の失敗理由、処理にかかった時間が記録されます。
無料プランでは 7 日間、Starter では 30 日間、Medium では 90 日間、Large では 365 日間保存されます。保存期間を過ぎた呼び出しは自動的に削除されます。1 つの Webhook の記録が 1,000 件を超えた場合も、古いものから自動的に削除されます。
はい。ペイロードは、メッセージの内容と同じくお客様専用のキーで保存時に暗号化されます。Authorization、cookie、API キーのヘッダーは、保存される前に [redacted] に置き換えられます。
履歴を見ると原因が分かります。何も記録されていない場合は、送信元が当社に到達していません。エラー付きで記録されている場合は、理由が表示されます。不正な JSON、ペイロード内に存在しない %path% からの空のメッセージ、無効化された Webhook などです。
ダッシュボードで Webhook を開くと、履歴が新しいものから順に表示されます。各呼び出しは展開して詳細を確認できます。プログラムから取得したい場合は、成功とエラーで絞り込める REST エンドポイントもご利用いただけます。
はい、7 日間の保存期間で利用できます。より長く保存したい場合は、有料プランで延長できます。
通知が届かない原因を推測するのはやめましょう
サービスを Pocket Alert の Webhook に向けると、そのサービスが行ったすべての呼び出しが、通知が成功したかどうかに関わらず記録されます。