Webhook¶

受注や決済などの出来事が起きたときに、Post0 から自社のシステムへ自動で通知を送る設定をする画面です。この通知の仕組みを Webhook と呼びます。送信先の登録と、通知が届いたかどうかの確認ができます。

画面の開き方¶

メニューの「外部連携 → Webhook」を開きます。Webhook を利用する設定になっているテナントで、設定を変更する権限を持つユーザにだけ表示されます。表示されない場合は、Post0 の運用担当者へ確認してください。

画面は2つのタブに分かれています。

タブ	できること
エンドポイント	通知の送信先（エンドポイント）を登録・変更する
配信履歴	送った通知の結果を確認し、必要なら送り直す

連携の担当者と受け渡しする情報¶

送信先を登録する前に、連携の担当者から次の情報を受け取ります。

通知を受け取る URL（https:// で始まる、インターネットに公開された URL）
受け取りたい出来事（イベント）の種類
受け取る側で認証が必要な場合は、その方式と値

登録が終わったら、次の情報を連携の担当者へ渡します。

渡すもの	入手できる場所
署名secret	送信先の作成直後、または更新の直後に一度だけ表示される
購読しているイベント	送信先の編集画面
通知の結果と送信内容	「配信履歴」タブ

署名secret は、届いた通知が本当に Post0 から送られたものかを、受け取る側で確かめるための値です。通知の形式と確認の方法は、公開されている API 仕様書に記載されています。仕様書の場所は Post0 の運用担当者へお問い合わせください。

送信先を登録する¶

「エンドポイント」タブで「エンドポイントを作成」をクリックします。
次の項目を入力します。
「作成」をクリックします。
表示された署名secret をコピーし、安全な場所へ保存します。
「安全な場所に保存しました」にチェックを入れ、「閉じる」をクリックします。

項目	必須	内容
名前	必須	連携先が分かる名前
説明	任意	補足のメモ（500文字まで）
送信先URL	必須	通知を受け取る URL。公開された HTTPS の URL に限る
認証方式	－	「認証なし」「Bearer token」「X-API-Key」から選ぶ
認証値	認証ありの場合は必須	受け取る側が指定したトークンやキー
イベント	必須	通知する出来事。1つ以上選ぶ。「全選択」でまとめて選べる

署名secret は作成直後にしか表示されない

表示された画面を閉じると、署名secret は二度と表示できません。保存し忘れた場合は、「署名secretを更新」で新しい値を発行し直します。

通知できるイベント¶

分類	イベント
受注（発注全体）	受注作成、受注更新、受注ステータス変更、受注完了、受注承認ステータス変更
媒体別の受注	注文明細作成、注文明細ステータス変更
決済	決済完了、決済キャンセル
入稿データ	入稿ファイル作成、入稿ファイル更新、入稿ファイル承認、入稿ファイル承認解除、入稿ファイル名変更
ワークフロー	ワークフロー開始、ワークフロータスク承認、ワークフロータスク却下、ワークフロータスク差し戻し、ワークフロー再申請、ワークフロー完了
クリーニングタグ	クリーニングタグ配布会社確認変更

登録した送信先へテスト送信する¶

本番の通知を待たずに、送信先が正しく受け取れるかを確認できます。

対象の送信先の行で「⋮」（操作）をクリックし、「テスト送信」を選びます。
送信する「イベント」を選びます。
「テスト送信」をクリックします。

受け付けられると、その配信の詳細画面へ移動します。受け付けられた時点では、まだ送信先に届いたとは限りません。詳細画面の「配送試行」で結果を確認してください。無効にしている送信先へはテスト送信できません。

送信先の状態を確認する¶

「エンドポイント」タブの一覧で、送信先ごとの状態を確認できます。

状態	意味
正常	通知が届いている
失敗あり	通知の送信に失敗している。次の通常の通知が成功すると「正常」に戻る
無効	送信先を無効にしている

送信先が初めて「失敗あり」になったときは、失敗を知らせるメールが送られます。宛先は通知メールを参照してください。「最終成功」「最終失敗」の日時も、あわせて確認できます。

通知の結果を確認する¶

「配信履歴」タブを開きます。受付日時の期間（30日以内）、ステータス、イベント、エンドポイントで絞り込めます。送信先の行をクリックするか、「⋮」から「配信履歴」を選ぶと、その送信先の履歴だけが表示されます。

ステータス	意味
待機中	これから送信する
配送中	送信している
再試行中	送信に失敗し、時間をおいて自動で送り直している
成功	送信先が受け取った
配送失敗	自動の送り直しをすべて行っても届かなかった
抑止	送信しなかった（Webhook の利用が止められた場合など）

通知は、失敗すると間隔をあけながら自動で送り直され、最大5回まで試行されます。行をクリックすると詳細画面が開き、送った内容（リクエストpayload）と、試行ごとの結果・エラーメッセージ・送信先からの応答を確認できます。連携の担当者から「通知が届かない」と相談されたときは、この画面の内容を伝えると原因を調べやすくなります。

配信履歴が残るのは30日間です。

届かなかった通知を送り直す¶

1件だけ送り直すときは、配信の詳細画面で「再送」をクリックします。再送できるのは、ステータスが「再試行中」「配送失敗」「抑止」の配信です。

まとめて送り直すときは、「配信履歴」タブで期間などの条件を指定し、「一括再送」を選びます。対象件数を確認する画面が表示されるので、内容を確かめて「一括再送」をクリックします。一括再送の対象になるのは、「配送失敗」と「抑止」の配信です。対象が上限件数を超える場合は、条件を絞り込んでからやり直します。

再送すると、元の配信はそのまま残り、同じ内容の新しい配信が作られます。受け取る側に同じ通知が2回届くことがあるため、重複して処理されない作りになっているかを、事前に連携の担当者へ確認してください。

送信先を変更・停止・削除する¶

対象の送信先の行で「⋮」（操作）をクリックし、操作を選びます。

操作	内容
編集	名前、送信先URL、認証、イベントを変更する。認証値を空欄のまま保存すると、現在の値がそのまま使われる
無効にする	通知を止める。無効の間に起きた出来事の通知は作られず、あとから有効に戻しても送られない
有効にする	通知を再開する
署名secretを更新	新しい署名secret を発行する。新しい値は一度だけ表示される
旧secretを失効	更新前の署名secret を使えなくする。取り消せない
削除	送信先を削除する。過去の配信履歴は残る

署名secret を更新すると、しばらくの間は新旧どちらの値でも確認できる形で通知が送られます。連携先のシステムが新しい値へ切り替わったことを確認してから、「旧secretを失効」を実行してください。旧secret が有効な間は、署名secret を再び更新できません。

知っておくこと¶

通知が届く順番は保証されません。送り直しがあると、起きた順と違う順で届くことがあります。
画面に「Webhook管理を利用できません」と表示された場合は、テナントの Webhook 利用設定か、自分の権限が変更されています。Post0 の運用担当者へ確認してください。