「入金があったら、自動で会計に反映したい」「フォームから問い合わせが来たら、すぐチャットに知らせたい」。こうした相談で出てくる言葉がWebhook(ウェブフック)です。結論から言うと、Webhookとは相手のシステムで何かが起きたとき、相手から「起きました」と自動で知らせてもらう仕組みです。APIが「こちらから取りに行く」のに対して、Webhookは「相手から知らせが来る」。この記事では、その違い、使いどころ、気をつける点、頼むときに開発会社に聞くことを書きます。
APIそのものの入門はAPI連携とは?費用の決まり方と頼む前の確認3点に、連携の方法の比べ方は基幹システムの連携|4つの方法とAPIがない場合の選び方に書いています。
Webhookとは、どういう仕組みですか?
あらかじめ「何か起きたら、この宛先に知らせてください」と、相手のシステムに宛先(URL)を登録しておきます。出来事が起きると、相手のシステムが、その宛先に「入金がありました。内容はこうです」という知らせを送ってきます。受け取った側のプログラムは、それを合図に動き出します。
たとえるなら、宅配の「到着のお知らせメール」です。荷物が届いたかを自分で何度も追跡画面で見に行く代わりに、届いたときに向こうから知らせが来ます。
APIとの違いは何ですか?
違いは、誰が動くかです。
| API(取りに行く) | Webhook(知らせてもらう) | |
|---|---|---|
| 動くのは | こちら | 相手 |
| 流れ | 「新しいデータはありますか」とこちらが聞く | 出来事が起きたら、相手が知らせてくる |
| 向く場面 | 好きなときに、必要なデータを取りたい。書き込みもしたい | 起きたらすぐ動きたい。起きていないときは何もしたくない |
| 注意点 | 確認の間隔を空けると反映が遅れる。間隔を縮めると、呼べる回数の上限に近づく | 知らせが届かない、二重に届く、偽物が届く場合に備える |
この2つは対立するものではなく、組み合わせて使います。たとえば、Webhookで「注文が入りました」と知らせてもらい、詳しい内容はAPIで取りに行く、という形です。知らせは「起きた」ことだけを伝え、中身はAPIで確かめる作りにすると、知らせの中身を信じすぎずに済みます。
業務では、どこで使いますか?
「起きたらすぐ次へ進めたい」場面が、Webhookの使いどころです。
| 場面 | 相手で起きること | 知らせを受けて動くこと(例) |
|---|---|---|
| 入金の通知 | 入金が記録される | 請求の消込を始める。担当者に通知する |
| フォームの送信 | 問い合わせ・申込が送られる | 担当者のチャットに知らせる。台帳に1行足す |
| 注文の受付 | 受発注サイトやネットショップに注文が入る | 在庫や出荷の画面に反映する |
| 状態の変化 | 契約や承認の状態が変わる | 次の担当者に連絡する |
どの相手のシステムがWebhookに対応しているか、どの出来事を知らせてくれるかは、サービスごとに違います。つなぎたい相手の公式の資料で、対応する出来事の一覧を確かめるのが確実です。
当社の実例では、入金消込は、入金明細と請求の一覧を取り込んで照合し、会計ソフトへの登録まで自動にしています(月額1万円+サーバー代・税別。実例の詳細)。この実例は、明細のCSVやExcelを取り込む作りで、Webhookは使っていません。入金の知らせを相手から受けられる条件がそろっていれば、取り込みを待たずに動かす形にもできますが、そこは相手のシステムに何ができるかで決まります。
気をつける点は何ですか?
Webhookは便利ですが、「相手から来る」仕組みなので、受け取る側の備えが要ります。大きく3つです。
知らせが届かなかったら、どうなりますか?
受け取る側のシステムが止まっていたり、通信が途切れたりすると、知らせは受け取れません。そのときに相手が自動で再送してくれるか、何回まで、いつまで再送するかは、相手のシステムの決まりです。これは公式の資料に書かれています。
再送に頼れない場合に備えて、受け取れなかった分を、あとからAPIで取りに行って埋める作りにしておくと安心です。「知らせはきっかけで、正しい内容はあとからも取り直せる」という考え方です。
偽の知らせが来たら、どうなりますか?
Webhookの宛先は、外から届く場所です。つまり、相手のふりをした偽の知らせが届く可能性があります。偽の知らせで「入金済み」と処理してしまえば、実害が出ます。
だから、受け取った知らせが本当に相手から来たものかを確かめる仕組みを入れます。たとえば、相手が知らせに付ける署名(本物だけが作れる印)を確かめる方法があります。使える確認方法は相手のシステムによって違うので、公式の資料で確かめます。確認の方法が用意されていない相手なら、知らせは「起きたかもしれない」という合図にとどめ、中身はAPIで取り直して確かめます。
同じ知らせが二重に届いたら、どうなりますか?
相手が再送すると、同じ知らせが2回届くことがあります。何も考えずに作ると、同じ入金を2回処理してしまいます。
そのため、知らせごとの番号などで「これはもう処理した」と覚えておき、二度目は何もしない作りにします。専門用語では「同じ処理を何度やっても結果が変わらない」性質と言いますが、発注する側は「二重に届いても二重に処理しない作りになっていますか」と聞けば十分です。
頼むときに、開発会社に聞くことは何ですか?
Webhookを使う案件では、次の6つを聞くと、作りの丁寧さが分かります。
- 相手のシステムは、どの出来事をWebhookで知らせてくれるのか。公式のどの資料で確かめたか
- 届かなかったときに、相手の再送に頼るのか、あとから取りに行って埋めるのか
- 偽の知らせを見分ける確認を入れるか
- 二重に届いても、二重に処理しない作りか
- 処理に失敗したとき、誰がどうやって気づけるか(通知)
- 相手の仕様が変わったとき、手直しは月額に含まれるか
6つ目に関連して、当社の実例では、通常の修正は月額の中で対応しています(たとえば注文一覧の事例は、月額5万円(税別)・初期費用0円で、稼働後の連携追加も通常の修正として月額の中で対応)。
Webhookが使えないときは、どうしますか?
相手のシステムがWebhookに対応していなければ、ほかの方法が残ります。
- APIで定期的に見に行く。数分おきなどに「新しいデータはありますか」と聞きます。反映は少し遅れますが、確実です
- CSVを毎日落として取り込む。1日1回でよい業務なら、これで足ります
- 画面操作の自動化(RPA)。APIもCSVもない相手では、毎朝ログインして前日分を取り込む形にできます
「すぐ知りたい」のか「1日1回で足りる」のかで、Webhookが必要かどうかが変わります。1日1回で足りる業務に、Webhookの備え(再送・署名・二重対策)を作るのは、手間のかけすぎになることもあります。
まとめ
- Webhookとは、相手のシステムで出来事が起きたとき、相手から自動で知らせてもらう仕組み。APIは「取りに行く」、Webhookは「知らせが来る」
- 入金の通知、フォームの送信、注文の受付など、起きたらすぐ動かしたい業務に向く。1日1回で足りるなら、CSVの取り込みで済む
- 頼むときは、届かなかったときの再送、偽の知らせの確認、二重に届いたときの扱いの3つを、開発会社に聞く
当社の実例は、入金消込の事例と注文一覧の事例に詳しく書いています。初期費用0円・月額1万円〜(税別)で、稼働するまで課金はありません。使っているシステムの名前と、「何が起きたら何をしたいか」を教えてもらえれば、Webhookが向くのか、見に行く方式で足りるのかをお答えします。お問い合わせからどうぞ。