LaravelでWebhookエンドポイントを作成する方法を初心者向けにやさしく解説

1. Webhookとは何かを超かんたんに説明

1. Webhookとは何かを超かんたんに説明

Webhookとは、外部サービスから自動的に通知を受け取る仕組みです。たとえば、誰かがフォームを送信した、支払いが完了した、メッセージが届いた、などの出来事が起きた瞬間に、Laravelへ情報が送られます。

これは「毎日ポストを見に行く」のではなく、「チャイムが鳴ったら受け取る」イメージです。Webhookを使うことで、リアルタイムに近い連携ができます。

2. LaravelでWebhookを受け取る全体の流れ

2. LaravelでWebhookを受け取る全体の流れ

LaravelでWebhookエンドポイントを作る流れはとてもシンプルです。大きく分けると、URLを決める、処理を書く、外部サービスにURLを教える、という三段階です。

Webhookエンドポイントとは、「外部サービス専用の受付窓口」です。LaravelのAPI機能を使って、この窓口を用意します。

3. Webhook用のルーティングを作成する

3. Webhook用のルーティングを作成する

まずは、Laravelに「ここがWebhookの入口です」というURLを用意します。API開発では、routes/api.phpにルーティングを書くのが基本です。

POSTという方法でデータが送られてくることが多いため、POSTルートを作ります。

Route::post('/webhook/sample', function () {
    return response()->json(['status' => 'ok']);
});

これで、Laravel側にWebhookを受け取る入り口ができました。このURLを外部サービスに登録します。

4. コントローラでWebhookの処理を書く

4. コントローラでWebhookの処理を書く

実際のWebhook処理は、コントローラにまとめると分かりやすくなります。コントローラは「受け取った情報をどうするか」を書く場所です。

Webhookでは、外部から送られてきたデータをRequestとして受け取ります。Requestとは「届いた荷物」のようなものです。

public function handle(Request $request)
{
    $data = $request->all();
    return response()->json(['received' => true]);
}

5. Webhookで送られてくるデータとは

5. Webhookで送られてくるデータとは

Webhookで送られてくるデータは、多くの場合JSON形式です。JSONとは、データを整理して送るための書き方です。難しく考えず、「項目と中身がセットになった表」と思ってください。

Laravelでは、JSONデータを自動で配列として扱えるため、初心者でも安心して使えます。

6. Webhookを使うときの注意点

6. Webhookを使うときの注意点

Webhookは外部から直接アクセスされるため、誰でも叩けてしまう状態になると危険です。そのため、送信元を確認する仕組みや、決まったキーをチェックすることがよく行われます。

また、Webhookは「いつ届くかわからない」ため、画面表示ではなく、裏側の処理として考えることが大切です。

7. WebhookとAPI連携の違い

7. WebhookとAPI連携の違い

API連携は「自分から取りに行く」、Webhookは「向こうから届く」という違いがあります。LaravelのAPI開発では、この二つを使い分けることで、効率の良い外部サービス連携が可能になります。

Webhookエンドポイントを理解することで、決済サービス、通知サービス、フォームサービスなど、多くの外部サービスと連携できるようになります。