← Pushanyに戻る

🔔 Webhook で通知を受け取る

専用の URL を作成すると、その URL に送られた内容がトレイに届き、通知されます。GitHub・監視サービス・ホームオートメーション・IFTTT や Zapier など、Webhook の送り先を設定できるサービスからそのまま使えます。

⚠️ URL を知っていれば誰でも送信できます。URL は人に教えないでください。送られた内容は暗号化されずにサーバーに届き、サーバーが受け取るとすぐに暗号化して保存します。

送り方

URL に POST で送ります。いちばん簡単なのは、本文に文字をそのまま入れる方法です。

curl -d "バックアップが完了しました" ""

JSON で送ると、タイトルと本文を分けられます。URL を入れるとリンクとして届きます。

curl -H "Content-Type: application/json" \
  -d '{"title": "サーバー", "message": "ディスクの空きが 10% を下回りました", "url": "https://example.com/status"}' \
  ""

届いた内容の読み方

タイトル	title または subject
本文	message・body・text・content・description のうち最初にあるもの
URL	url または link

• Slack 形式 (text) と Discord 形式 (content・embeds) の通知もそのまま読めます。サービスに「Slack に通知」の設定しかない場合も、この URL を入れてみてください。
• 上のどれも無い JSON は、整形した JSON がそのまま本文になります。届いた中身を見て、下のテンプレートを設定できます。
• フォームの形式で送られた内容も、同じ名前の欄から読みます。
• URL を作成したときの名前は、カードの送信元に表示します。タイトルが無いときは、通知のタイトルにも使います。

URL で表示を指定する

URL の後ろに次のように付けると、タイトル・本文・リンクを指定できます。{{欄の名前}} と書くと、届いた JSON の値に置き換わります。入れ子の欄は . でつなぎ、配列は番号 (0 から) で指定します。

title	タイトル
body	本文
url	リンクの URL
memo=1	通知しないでトレイに置きます

例: GitHub の push の通知を、push した人の名前と最新のコミットのメッセージで受け取る場合

…/api/hooks/ph_…?title={{pusher.name}}&body={{head_commit.message}}&url={{compare}}

サービスによっては、{ や } を URL エンコード (%7B・%7D) して入力する必要があります。

GitHub で使う

1. GitHub で、通知を受け取りたいプロジェクトの Settings → Webhooks → Add webhook を開きます。
2. Payload URL に、上の例のように title・body を付けた URL を貼り付けます。
3. Content type は application/json を選択します。Secret は空のままで構いません。
4. 通知を受け取るイベントを選択して、Add webhook を押します。

上限

• 一度に送れる大きさは 64KB までです。本文はトレイの文字数の上限で切り詰めます。
• 1 つの URL に送れるのは 1 分間に 30 回までです。
• URL は 10 個まで作成できます。
• 1 日に受け取れる件数は、アカウント全体で数えます。件数と保存容量の上限は プラン のページをご覧ください。上限に達すると、その日は受け取れなくなり、お知らせと通知でお伝えします。

うまくいかない場合

• 「この URL は使えません」と表示される: URL が正しくコピーされていないか、URL が削除されています。
• 「Webhook で今日受け取れる件数に達しました」と表示される: その日の上限に達しています。翌日 (端末のタイムゾーンの日付) になると、また受け取れます。
• 「送る内容がありません」と表示される: 本文が空です。本文を入れて送るか、URL に title や body を付けてください。
• JSON の中身がそのまま届く: 決まった名前の欄がありません。URL で表示を指定する を参考に、テンプレートを付けてください。