Webhookで外部システムへ自動通知する方法
出来事を別のシステムへ確実に伝えます。500エラーや5秒のタイムアウトがあっても、各配信には署名が付き、間隔を広げながら再試行され、すべて失敗しても詳細付きで保管されます。使った分だけの支払いで、月額契約は不要です。
オンラインで実行
アカウントでログインし、当社のサーバー上で実行します。無料ツールはブラウザ内で動作しますが、これは上記の料金がKIT残高から差し引かれます。
SlackやDiscord以外の外部システムへ、システム側の出来事をそのまま伝えたい場合に使います。
配信に複数回の試行が必要な理由
外部と連携する製品は、いずれ別のアプリのアドレスを呼び出し、その呼び出しが届くと信じる必要に迫られます。呼び出すだけなら1行のコードで済みますが、相手の再起動、500エラー、5秒のタイムアウトに耐えさせるところで、チームは知らないうちに1週間を失います。1回だけ送って再試行しない単純な作りでは、最初の通信の乱れで黙って失敗します。このツールは、各チームが何度も作り直してきた配信の層です。送り先のアドレス、本文、必要な追加ヘッダーを渡せば、署名を付けて配信し、相手が正しく応答しなければ試行を続けます。
各配信を守る仕組み
各配信には共有の秘密鍵で作った署名が付くため、受け取る側は内容が本当にこちらから来て、途中で変えられていないことを確かめられます。相手がエラーを返すか時間内に応答しなければ、間隔を少しずつ広げながら再試行するので、再起動中のシステムにも立ち直る余裕があります。すべての試行を使い切っても呼び出しは捨てられず、最後の応答の詳細とともに保管され、報告されます。よくある失敗は、受け取る側が署名を確認せず、偽の呼び出しを通してしまうことです。
よくある質問
送信に失敗した場合はどうなりますか?
送信先が応答しない場合はエラーとして返します。自動的な再試行が必要な場合は、再試行機能と組み合わせてご利用ください。
日本語のサポートはありますか?
申し訳ありませんが、日本語でのサポートは行っておりません。サポートは英語またはスペイン語で、担当者が直接対応します。
受け取る側は、どうやって自分から届いたと確認できますか?
各配信には共有の秘密鍵で作った署名が付きます。受け取る側がそれを確かめれば、内容が本当にこちらから送られ、途中で書き換えられていないことを確認でき、偽の呼び出しを拒否できます。
相手が必要とする追加情報を一緒に送れますか?
はい。送り先のアドレスと本文に加えて、任意の追加ヘッダーを付けられます。署名はそれとは別に自動で付くため、受け取る側は内容の確認と必要な情報の読み取りを同時に行えます。
自分のプログラムから直接送ればよいのでは?
送るだけなら1行で済みますが、相手の再起動、500エラー、5秒のタイムアウトに耐えさせるところで、多くのチームが知らないうちに1週間を失います。再試行、署名、失敗時の保管場所をこちらで用意します。
関連ツール
開発者向け — APIアクセス
このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。
エンドポイント
Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。
お使いのスタックから呼び出す
curl -X POST https://api.kit.forhosting.com/notify/webhook \
-H "Authorization: Bearer $KIT_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/hook"}'const res = await fetch("https://api.kit.forhosting.com/notify/webhook", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.KIT_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"url": "https://example.com/hook"
})
});
const { task_id } = await res.json();import os, requests
res = requests.post(
"https://api.kit.forhosting.com/notify/webhook",
headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
json={
"url": "https://example.com/hook"
},
)
task_id = res.json()["task_id"]<?php
$res = file_get_contents("https://api.kit.forhosting.com/notify/webhook", false, stream_context_create([
"http" => [
"method" => "POST",
"header" => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
"content" => '{"url":"https://example.com/hook"}',
],
]));
$task = json_decode($res, true);body := bytes.NewBufferString(`{"url":"https://example.com/hook"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/notify/webhook", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)リクエスト例
{
"url": "https://example.com/hook"
}レスポンス例
{
"task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
"type": "notify.webhook",
"status": "queued",
"_links": {
"result": "/tasks/tsk_…/result"
}
}非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。
料金
単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。
エラー
| HTTP | コード | 意味 |
|---|---|---|
401 | unauthorized | APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。 |
402 | insufficient_balance | 残高が不足しています。チャージ後に再度お試しください。 |
404 | unknown_type | 指定されたタスクタイプは存在しません。タイプ名を確認してください。 |
429 | rate_limited | リクエストが多すぎます。しばらく待ってから再度お試しください。 |
技術的な注記
指定したWebhook URLへ、任意のデータをPOST形式で自動送信するツールです。
使い方
送信先のWebhook URLと、送るデータを指定します。この画面から直接テストでき、APIから呼び出せば自動処理の一部として組み込めます。
送信されるデータ
データの中身は自由に組み立てられます。指定したJSON形式のデータを、そのままWebhook URLへPOSTで送信します。
連携先の例
自社システムのエンドポイント、Zapier、Make(旧Integromat)など、Webhookを受け付ける仕組みであれば送信先として指定できます。
料金
件数分の送信や失敗時の再送は、一括処理や自動再試行と組み合わせて行えます。1回の配信につき$0.002です。
連携の活用例
受注システムへのデータ連携
株式会社山田商事は、注文フォームの送信内容をWebhook経由で自社の受注システムへ自動的に送っています。
外部ツールとの自動連携
合同会社みどりデザインは、案件のステータスが変わるたびに、Webhookを通じてZapier経由で複数のツールへ通知しています。
在庫切れ検知の連携
有限会社ささき印刷は、在庫監視の結果をWebhookで受け取り、社内の発注システムへ自動的に取り込んでいます。
技術的な質問
送信するデータは保存されますか?
配信処理にのみ使用し、保存や第三者への提供は行いません。
送信先のURLに条件はありますか?
HTTPSに対応したWebhook URLであれば送信先として指定できます。
SlackやDiscordへの通知との違いは何ですか?
SlackやDiscordは専用の通知先ですが、この機能は任意のWebhook URLへ送信できる汎用的な仕組みです。
料金はどのように計算されますか?
1回の配信につき$0.002です。米ドル建てで、送信前に金額が表示されます。