# チュートリアル: Lambda 関数 URL を使用したウェブフックエンドポイントの作成
このチュートリアルでは、ウェブフックエンドポイントを実装するための Lambda 関数 URL を作成します。ウェブフックは、HTTP を使用してアプリケーション間でデータを自動的に送信する、軽量のイベント駆動型通信です。ウェブフックを使用すると、新しい顧客がウェブサイトにサインアップしたとき、支払いが処理されたとき、ファイルのアップロードされたときなど、別のシステムで発生したイベントに関する最新情報をすぐに受け取ることができます。
Lambda では、Lambda 関数 URL または API Gateway を使用してウェブフックを実装できます。関数 URL は、高度な認可やリクエストの検証などの機能を必要としないシンプルなウェブフックに適しています。
**ヒント**
ユースケースに最適なソリューションがわからない場合、「[HTTP リクエストを使用して Lambda 関数を呼び出す方法を選択する](furls-http-invoke-decision.md)」を参照してください。
## 前提条件
このチュートリアルを完了するには、ローカルマシンに Python (バージョン 3.8 以降) または Node.js (バージョン 18 以降) がインストールされている必要があります。
HTTP リクエストを使用してエンドポイントをテストするために、チュートリアルでは [curl](https://curl.se/) を使用します。curl は、さまざまなネットワークプロトコルを使用してデータを転送するために使用できるコマンドラインツールです。ツールをまだお持ちでない場合は、[curl ドキュメント](https://curl.se/docs/install.html)を参照してください。
## Lambda 関数を作成する
まず、HTTP リクエストがウェブフックエンドポイントに送信されたときに実行される Lambda 関数を作成します。この例では、送信側アプリケーションは、支払いが送信されるたびに更新を送信し、支払いが成功したかどうかを HTTP リクエストの本文に表示します。Lambda 関数はリクエストを解析し、支払いのステータスに従ってアクションを実行します。この例では、コードは支払いの注文 ID を出力しますが、実際のアプリケーションでは、注文をデータベースに追加するか、通知を送信できます。
この関数は、ウェブフックに使用される最も一般的な認証方法である、ハッシュベースのメッセージ認証 (HMAC) も実装します。この方法では、送信側アプリケーションと受信側アプリケーションの両方がシークレットキーを共有します。送信アプリケーションは、ハッシュアルゴリズムを使用して、このキーとメッセージコンテンツを使用して一意の署名を生成し、HTTP ヘッダーとしてウェブフックリクエストに署名を含めます。次に、受信側アプリケーションはこのステップを繰り返し、シークレットキーを使用して署名を生成し、結果の値をリクエストヘッダーで送信された署名と比較します。結果が一致すると、リクエストは正当であると見なされます。
Python または Node.js ランタイムで Lambda コンソールを使用して関数を作成します。
------
#### [ Python ]
**Lambda 関数を作成する**
1. Lambda コンソールの「[関数](https://console.aws.amazon.com/lambda/home#/functions)」ページを開きます。
1. 次の操作を行って、基本的な「Hello world」関数を作成します。
1. [**関数の作成**] を選択してください。
1. **[一から作成]** を選択します。
1. **[関数名]** に「**myLambdaWebhook**」と入力します。
1. **[ランタイム]** で **[python3.14]** を選択します。
1. [**関数の作成**] を選択してください。
1. **[コードソース]** ペインで、以下をコピーして貼り付けて既存のコードを置き換えます。
```
import json
import hmac
import hashlib
import os
def lambda_handler(event, context):
# Get the webhook secret from environment variables
webhook_secret = os.environ['WEBHOOK_SECRET']
# Verify the webhook signature
if not verify_signature(event, webhook_secret):
return {
'statusCode': 401,
'body': json.dumps({'error': 'Invalid signature'})
}
try:
# Parse the webhook payload
payload = json.loads(event['body'])
# Handle different event types
event_type = payload.get('type')
if event_type == 'payment.success':
# Handle successful payment
order_id = payload.get('orderId')
print(f"Processing successful payment for order {order_id}")
# Add your business logic here
# For example, update database, send notifications, etc.
elif event_type == 'payment.failed':
# Handle failed payment
order_id = payload.get('orderId')
print(f"Processing failed payment for order {order_id}")
# Add your business logic here
else:
print(f"Received unhandled event type: {event_type}")
# Return success response
return {
'statusCode': 200,
'body': json.dumps({'received': True})
}
except json.JSONDecodeError:
return {
'statusCode': 400,
'body': json.dumps({'error': 'Invalid JSON payload'})
}
except Exception as e:
print(f"Error processing webhook: {e}")
return {
'statusCode': 500,
'body': json.dumps({'error': 'Internal server error'})
}
def verify_signature(event, webhook_secret):
"""
Verify the webhook signature using HMAC
"""
try:
# Get the signature from headers
signature = event['headers'].get('x-webhook-signature')
if not signature:
print("Error: Missing webhook signature in headers")
return False
# Get the raw body (return an empty string if the body key doesn't exist)
body = event.get('body', '')
# Create HMAC using the secret key
expected_signature = hmac.new(
webhook_secret.encode('utf-8'),
body.encode('utf-8'),
hashlib.sha256
).hexdigest()
# Compare the expected signature with the received signature to authenticate the message
is_valid = hmac.compare_digest(signature, expected_signature)
if not is_valid:
print(f"Error: Invalid signature. Received: {signature}, Expected: {expected_signature}")
return False
return True
except Exception as e:
print(f"Error verifying signature: {e}")
return False
```
1. **[DEPLOY]** セクションで **[デプロイ]** を選択して関数のコードを更新します。
------
#### [ Node.js ]
**Lambda 関数を作成する**
1. Lambda コンソールの [[関数]](https://console.aws.amazon.com/lambda/home#/functions) ページを開きます。
1. 次の操作を行って、基本的な「Hello world」関数を作成します。
1. [**関数の作成**] を選択してください。
1. **[一から作成]** を選択します。
1. **[関数名]** に「**myLambdaWebhook**」と入力します。
1. **[ランタイム]** で、**[nodejs24.x]** を選択します。
1. [**関数の作成**] を選択してください。
1. **[コードソース]** ペインで、以下をコピーして貼り付けて既存のコードを置き換えます。
```
import crypto from 'crypto';
export const handler = async (event, context) => {
// Get the webhook secret from environment variables
const webhookSecret = process.env.WEBHOOK_SECRET;
// Verify the webhook signature
if (!verifySignature(event, webhookSecret)) {
return {
statusCode: 401,
body: JSON.stringify({ error: 'Invalid signature' })
};
}
try {
// Parse the webhook payload
const payload = JSON.parse(event.body);
// Handle different event types
const eventType = payload.type;
switch (eventType) {
case 'payment.success': {
// Handle successful payment
const orderId = payload.orderId;
console.log(`Processing successful payment for order ${orderId}`);
// Add your business logic here
// For example, update database, send notifications, etc.
break;
}
case 'payment.failed': {
// Handle failed payment
const orderId = payload.orderId;
console.log(`Processing failed payment for order ${orderId}`);
// Add your business logic here
break;
}
default:
console.log(`Received unhandled event type: ${eventType}`);
}
// Return success response
return {
statusCode: 200,
body: JSON.stringify({ received: true })
};
} catch (error) {
if (error instanceof SyntaxError) {
// Handle JSON parsing errors
return {
statusCode: 400,
body: JSON.stringify({ error: 'Invalid JSON payload' })
};
}
// Handle all other errors
console.error('Error processing webhook:', error);
return {
statusCode: 500,
body: JSON.stringify({ error: 'Internal server error' })
};
}
};
// Verify the webhook signature using HMAC
const verifySignature = (event, webhookSecret) => {
try {
// Get the signature from headers
const signature = event.headers['x-webhook-signature'];
if (!signature) {
console.log('No signature found in headers:', event.headers);
return false;
}
// Get the raw body (return an empty string if the body key doesn't exist)
const body = event.body || '';
// Create HMAC using the secret key
const hmac = crypto.createHmac('sha256', webhookSecret);
const expectedSignature = hmac.update(body).digest('hex');
// Compare expected and received signatures
const isValid = signature === expectedSignature;
if (!isValid) {
console.log(`Invalid signature. Received: ${signature}, Expected: ${expectedSignature}`);
return false;
}
return true;
} catch (error) {
console.error('Error during signature verification:', error);
return false;
}
};
```
1. **[DEPLOY]** セクションで **[デプロイ]** を選択して関数のコードを更新します。
------
## シークレットキーを作成する
Lambda 関数がウェブフックリクエストを認証するには、呼び出し元のアプリケーションと共有されるシークレットキーを使用します。この例では、キーは環境変数に保存されています。本番環境のアプリケーションでは、関数コードにパスワードなどの機密情報を含めないでください。代わりに、[AWS Secrets Manager シークレットを作成](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html)し、[AWS パラメータとシークレット Lambda 拡張機能を使用](with-secrets-manager.md)して Lambda 関数の認証情報を取得します。
**ウェブフックシークレットキーを作成および保存する**
1. 暗号的に安全な乱数ジェネレーターを使用して、長いランダムな文字列を生成します。Python または Node.js で次のコードスニペットを使用して 32 文字のシークレットを生成して出力することも、独自の方法を使用することもできます。
------
#### [ Python ]
**Example シークレットを生成するコード**
```
import secrets
webhook_secret = secrets.token_urlsafe(32)
print(webhook_secret)
```
------
#### [ Node.js ]
**Example シークレットを生成するコード (ES モジュール形式)**
```
import crypto from 'crypto';
let webhookSecret = crypto.randomBytes(32).toString('base64');
console.log(webhookSecret)
```
------
1. 次の手順を実行して、生成された文字列を関数の環境変数として保存します。
1. 関数の **[設定]** タブで、**[環境変数]** を選択します。
1. **[編集]** を選択します。
1. **[環境変数の追加]** を選択します。
1. **[キー]** に **WEBHOOK\$1SECRET** を入力し、**[値]** に前のステップで生成したシークレットを入力します。
1. **[保存]** を選択します。
このシークレットは、チュートリアルの後半で関数をテストするためにもう一度使用する必要があるため、ここで書き留めておきます。
## 関数 URL エンドポイントを作成する
Lambda 関数 URL を使用して、ウェブフックのエンドポイントを作成します。`NONE` の認証タイプを使用してパブリックアクセスを持つエンドポイントを作成するため、URL を持つすべてのユーザーが関数を呼び出すことができます。関数 URL へのアクセス制御の詳細については、「[Lambda 関数 URL へのアクセスの制御](urls-auth.md)」を参照してください。ウェブフックに高度な認証オプションが必要な場合は、API Gateway の使用を検討してください。
**関数 URL エンドポイントを作成する**
1. 関数の **[設定]** タブで、**[関数 URL]** を選択します。
1. **[関数 URL を作成]** をクリックします。
1. **[認証タイプ]** で、**[なし]** を選択します。
1. **[保存]** を選択します。
先ほど作成した関数 URL のエンドポイントが **[関数 URL]** ペインに表示されます。チュートリアルの後半で使用するエンドポイントをコピーします。
## コンソールで関数をテストする
HTTP リクエストを使用して URL エンドポイントによって関数を呼び出す前に、コンソールでテストしてコードが期待どおりに動作していることを確認します。
コンソールで関数を検証するには、まずチュートリアルの前半で生成したシークレットを使用してウェブフック署名を計算し、次のテスト JSON ペイロードを使用します。
```
{
"type": "payment.success",
"orderId": "1234",
"amount": "99.99"
}
```
次の Python コードまたは Node.js コードの例のいずれかを使用して、独自のシークレットを使用してウェブフック署名を計算します。
------
#### [ Python ]
**ウェブフック署名を計算する**
1. 次のコードを `calculate_signature.py` という名前のファイルとして保存します。コード内のウェブフックシークレットを独自の値に置き換えます。
```
import secrets
import hmac
import json
import hashlib
webhook_secret = "arlbSDCP86n_1H90s0fL_Qb2NAHBIBQOyGI0X4Zay4M"
body = json.dumps({"type": "payment.success", "orderId": "1234", "amount": "99.99"})
signature = hmac.new(
webhook_secret.encode('utf-8'),
body.encode('utf-8'),
hashlib.sha256
).hexdigest()
print(signature)
```
1. コードを保存したのと同じディレクトリから次のコマンドを実行して、署名を計算します。コード出力の署名をコピーします。
```
python calculate_signature.py
```
------
#### [ Node.js ]
**ウェブフック署名を計算する**
1. 次のコードを `calculate_signature.mjs` という名前のファイルとして保存します。コード内のウェブフックシークレットを独自の値に置き換えます。
```
import crypto from 'crypto';
const webhookSecret = "arlbSDCP86n_1H90s0fL_Qb2NAHBIBQOyGI0X4Zay4M"
const body = "{\"type\": \"payment.success\", \"orderId\": \"1234\", \"amount\": \"99.99\"}";
let hmac = crypto.createHmac('sha256', webhookSecret);
let signature = hmac.update(body).digest('hex');
console.log(signature);
```
1. コードを保存したのと同じディレクトリから次のコマンドを実行して、署名を計算します。コード出力の署名をコピーします。
```
node calculate_signature.mjs
```
------
コンソールでテスト HTTP リクエストを使用して関数コードをテストできるようになりました。
**コンソールで関数をテストする**
1. 関数の **[コード]** タブを選択します。
1. **[TEST EVENTS]** セクションで、**[新しいテストイベントの作成]** を選択します。
1. **[イベント名]** で、「**myEvent**」と入力します。
1. 以下をコピーして **[イベント JSON]** ペインに貼り付け、既存の JSON を置き換えます。ウェブフック署名を、前のステップで計算した値に置き換えます。
```
{
"headers": {
"Content-Type": "application/json",
"x-webhook-signature": "2d672e7a0423fab740fbc040e801d1241f2df32d2ffd8989617a599486553e2a"
},
"body": "{\"type\": \"payment.success\", \"orderId\": \"1234\", \"amount\": \"99.99\"}"
}
```
1. **[保存]** を選択します。
1. **[呼び出し]** を選択します。
次のような出力が表示されます:
------
#### [ Python ]
```
Status: Succeeded
Test Event Name: myEvent
Response:
{
"statusCode": 200,
"body": "{\"received\": true}"
}
Function Logs:
START RequestId: 50cc0788-d70e-453a-9a22-ceaa210e8ac6 Version: $LATEST
Processing successful payment for order 1234
END RequestId: 50cc0788-d70e-453a-9a22-ceaa210e8ac6
REPORT RequestId: 50cc0788-d70e-453a-9a22-ceaa210e8ac6 Duration: 1.55 ms Billed Duration: 2 ms Memory Size: 128 MB Max Memory Used: 36 MB Init Duration: 136.32 ms
```
------
#### [ Node.js ]
```
Status: Succeeded
Test Event Name: myEvent
Response:
{
"statusCode": 200,
"body": "{\"received\":true}"
}
Function Logs:
START RequestId: e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4 Version: $LATEST
2025-01-10T18:05:42.062Z e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4 INFO Processing successful payment for order 1234
END RequestId: e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4
REPORT RequestId: e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4 Duration: 60.10 ms Billed Duration: 61 ms Memory Size: 128 MB Max Memory Used: 72 MB Init Duration: 174.46 ms
Request ID: e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4
```
------
## HTTP リクエストを使用して関数をテストする
curl コマンドラインツールを使用して、ウェブフックエンドポイントをテストします。
**HTTP リクエストを使用して関数をテストする**
1. ターミナルまたはシェルプログラムで、次の curl コマンドを実行します。URL を独自の関数 URL エンドポイントの値に置き換え、ウェブフック署名を独自のシークレットキーを使用して計算した署名に置き換えます。
```
curl -X POST https://ryqgmbx5xjzxahif6frvzikpre0bpvpf.lambda-url.us-west-2.on.aws/ \
-H "Content-Type: application/json" \
-H "x-webhook-signature: d5f52b76ffba65ff60ea73da67bdf1fc5825d4db56b5d3ffa0b64b7cb85ef48b" \
-d '{"type": "payment.success", "orderId": "1234", "amount": "99.99"}'
```
以下の出力が表示されます。
```
{"received": true}
```
1. 次の手順を実行して、関数の CloudWatch ログを検査し、ペイロードが正しく解析されたことを確認します。
1. Amazon CloudWatch コンソールで、[[ロググループ]](https://console.aws.amazon.com/cloudwatch/home#logsV2:log-groups) ページを開きます。
1. 関数のロググループ (`/aws/lambda/myLambdaWebhook`) を選択します。
1. 最新のログストリームを選択します。
関数のログには、次のような出力が表示されます。
------
#### [ Python ]
```
Processing successful payment for order 1234
```
------
#### [ Node.js ]
```
2025-01-10T18:05:42.062Z e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4 INFO Processing successful payment for order 1234
```
------
1. 次の curl コマンドを実行して、コードが無効な署名を検出したことを確認します。URL を独自の関数 URL エンドポイントに置き換えます。
```
curl -X POST https://ryqgmbx5xjzxahif6frvzikpre0bpvpf.lambda-url.us-west-2.on.aws/ \
-H "Content-Type: application/json" \
-H "x-webhook-signature: abcdefg" \
-d '{"type": "payment.success", "orderId": "1234", "amount": "99.99"}'
```
以下の出力が表示されます。
```
{"error": "Invalid signature"}
```
## リソースのクリーンアップ
このチュートリアル用に作成したリソースは、保持しない場合は削除できます。使用しなくなった AWS リソースを削除することで、AWS アカウント アカウントに請求される料金の発生を防ぎます。
**Lambda 関数を削除するには**
1. Lambda コンソールの [[関数]](https://console.aws.amazon.com/lambda/home#/functions) ページを開きます。
1. 作成した関数を選択します。
1. **[アクション]** で、**[削除]** を選択します。
1. テキスト入力フィールドに **confirm** と入力し、**[削除]** を選択します。
コンソールで Lambda 関数を作成すると、Lambda は関数の[実行ロール](lambda-intro-execution-role.md)も作成します。
**実行ロールを削除する**
1. IAM コンソールの [[ロール]](https://console.aws.amazon.com/iam/home#/roles) ページを開きます。
1. Lambda が作成した実行ロールを選択します。ロールの名前の形式は `myLambdaWebhook-role-` になります。
1. **[削除]** を選択します。
1. テキスト入力フィールドにロールの名前を入力し、**[削除]** を選択します。