【Python】webhookを受信する方法【→プログラム初心者でもできる！】

プログラム女子

チャットBOTってどうやって作るの？

チャットシステムにはwebhookというしくみがあって、それをうまく使いこなせると、プログラムでBOTをコントロールすることができるよ。今回はそのwebhookの使い方を説明するね。

Tommy

Pythonでwebhookを受信する概要

社内LANなどインターネットから切り離されたネットワークを使っている場合に、外部（インターネット）からイベントを受信したい場合があります。例えば、チャットシステムのBOTなどのWebhookシステムなどは、チャット送信が一旦インターネット上のサービスで受信され、そこから所望のURLへと転送されるようになっていることが多いです。

ところが、メッセージを受信して処理するシステムが社内ネットワークのみで動作している場合は、このメッセージイベントを受信することができません。なぜなら、社内ネットワーク（イントラネット）と公共のネットワーク（インターネット）の間には、外部からのアクセスを遮断するファイヤーウォールがあるからです。

そのような場合には、ngrokのトンネリングサービスを利用することができます。トンネリングサービスとは、社内ネットワークと公共のネットワークをつなぐセッションを社内ネットワーク側から作り、その公共ネットワーク側に受信したデータを、社内ネットワークに取り込むというしくみのことです。

この記事では、トンネリングサービスの代表であるngrokの使い方を説明することによって、webhookを受信する方法を説明します。

Pythonでwebhookを受信する前提環境

webhookを受信する前提環境は、下の記事で説明している私の環境と同じ環境で確認しています。

また、レンタルサーバなどのLinuxサーバを使っている場合は、下の記事でプログラミングする環境の作り方を説明しています。

もし、まだプログラムする環境ができていない方は、先にこちらの記事を読んで、プログラミングできる環境をつくることをおすすめします。

Pythonでwebhookを受信するサンプルプログラム

ngrokのインストール

まず、下記にアクセスしてシステムに応じた「ngrok」の実行ファイルをインストールします。

ngrok - secure introspectable tunnels to localhost

ngrokのインストール手順は、

1. ダウンロード
2. zip解凍＆インストール
3. アカウントを作って、"Connect your account"を押下

になります。

Pythonでwebhookを受信するサンプルプログラム

さきほどインストールした「ngrok」をPythonプログラムから実行して、webhookを受信するサンプルプログラムを説明します。サンプルプログラムは、次のような順番で説明します。

1. ライブラリのインポート
2. Linuxコマンドの実行
3. ngrokの開始するプログラム
4. ngrokの開始実行処理

1.ライブラリのインポート

ここでは、webhookを受信する処理の為のライブラリのインポート処理を行います。webhookを受信する為には、次のライブラリをインポートします。

• 非同期処理を行う「subprocess」
• Linuxのコマンドを扱う「shlex」

import subprocess
import shlex

2.Linuxコマンドの実行

ここでは、LinuxコマンドをPythonプログラムから呼び出す関数を定義します。その関数名を「exe_linux_command」とし、引数に、任意のLinuxコマンドのテキスト「commad」を取ります。

PythonプログラムからLinuxコマンドを呼び出す具体的な方法は、下の記事で解説していますので、こちらも合わせて読んでください。

def exe_linux_command(command):
    tokens = shlex.split(command)
    p = subprocess.Popen(tokens)
    for line in iter(p.stdout.readline,b''):
        print(line.rstrip().decode("utf8"))

    return

3.ngrokの開始するプログラム

ここでは、カレントディレクトリの配下の「tools」というディレクトリに「ngrok」をインストールしたとして、「ngrok」を開始する方法を説明します。

また、このURLは公共ネットワーク側にあります。このURLからトンネリングした社内ネットワーク側にhttpリクエストを受け取るためのHTTPサーバを立てる必要があります。この「HTTPサーバを立てる方法」に関しては、下記の記事を読んでください。

下のプログラムでは、例としてhtttpサーバーのポート4000番を指定しています。ngrokを開始すると、URLが発行されます。このURLをWebhookで指定するメッセージの転送先に設定することで、webhookからのメッセージを受け取ることができます。webhookからのメッセージはngrokから発行されたURL宛に送信されますが、送信されるメッセージはHTTPリクエストの形をしています。

def start_ngrok():
    ret = exe_linux_command('/tools/ngrok http 4000')
    print(ret)

4.ngrokの開始実行処理

サンプルプログラムの開始として、上で定義した関数「start_ngrok」を呼び出します。

if __name__ == '__main__':
	start_ngrok()