ドキュメント
管理画面の使い方
管理画面の
最初の配信までの流れ
- https://app.webhookadmin.com/signup で
登録し、 組織を 作成します （組織・プロジェクト・環境） 。 - Webhook を
送信する サービスごとに プロジェクトを 作成します。 本番環境と テスト環境は 自動で 作成されます。 - 顧客アカウントを
登録し、 その 顧客のエンドポイント （Webhook を 受信する URL） を 追加します。 - API キーを
作成し、 送信側の サーバーから API で メッセージを 送信します。 - 配信ログで
結果を 確認します。
各プロジェクトの
画面の構成
左の
| 選んでいる | メニューの |
|---|---|
| すべての | 概要・配信ログ・アラート・設定 |
| プロジェクトと | 概要・配信ログ・エンドポイント・顧客アカウント・ソース・イベントタイプ・アラート・API キー・API ログ・設定 |
メニューの
ページの一覧
基本
- 概要画面: 組織全体と
プロジェクトごとの 「概要」 に 表示される 数値と、 対応が 必要な エンドポイントの 確認方法です。 - 組織・プロジェクト・環境: 組織と
プロジェクトの 作成・切り 替え・名前の 変更・削除と、 本番環境と テスト環境の 違いです。
Webhook の送信
- 顧客アカウント: Webhook を
受信する 企業や ユーザー （顧客アカウント） を、 環境ごとに 登録・削除する 手順です。 - エンドポイント: 顧客アカウントの
エンドポイント （Webhook の 配信先） を 追加し、 署名シークレット・対象イベント・配信の 設定を 変更する 手順です。 - イベントタイプ: invoice.paid のように、
配信する イベントの 名前 （イベントタイプ） を 環境ごとに 登録し、 説明の 編集や 廃止を 行う 手順です。 - 配信ログ: 配信ログで
送信した メッセージの 状態・配信試行・ペイロードを 確認する 方法と、 テスト送信の 手順です。 - 再送信・
一括再送信 :自動の 再送信の 仕組みと、 失敗した メッセージを 1 通ずつ、 または エンドポイント単位で まとめて 送り直す手順です。 - 顧客ポータル: 顧客が
自分の エンドポイント・署名シークレット・配信ログを 管理できる 「顧客ポータル」 の リンクを 発行する 手順です。 - 固定送信元 IP: 受信側で
IP アドレスを 許可している 顧客の ために、 固定の 送信元 IP （209.71.107.233） から 配信する 設定です。 - トランスフォーメーション: 配信の
直前に JavaScript の handler を 実行し、 ペイロード・ヘッダー・URL・HTTP メソッドを 変更する、 または 配信を キャンセルする 設定です。
Webhook の受信
- ソース
（受信） : Stripe やGitHub などから Webhook を 受信し、 署名を 検証してから 顧客アカウントの エンドポイントへ 配信する 「ソース」 の 設定手順です。
運用
- アラート: 配信の
失敗や エンドポイントの 自動無効化などを、 Slack・Teams・Chatwork・ メール・Webhook で 通知する 設定です。 - API キー: Webhook を
送信する サーバーから API を 呼び出すための API キーを、 環境ごとに 作成・無効化する 手順です。 - API ログ: 失敗した
API リクエスト （401・422 など） の 原因と 解決策を、 API ログで 確認する 方法です。