Webhook — 連携ガイド
Vivoldi Webhook連携の要は、HTTPヘッダー署名検証です。
すべてのWebhookリクエストには X-Vivoldi-Request-Id、X-Vivoldi-Event-Id、X-Vivoldi-Signature などが含まれ、
これらを検証することで、リンク・クーポン・スタンプのイベントを安全に処理できます。
本ガイドでは、各ヘッダーフィールドの役割と署名検証手順を段階的に解説し、サンプルコードを用いてWebhookリクエストを迅速かつ安全に統合できるようにします。
HTTP Header
Webhookは指定されたコールバックURLにPOSTリクエストを送信し、X-Vivoldi-SignatureやX-Vivoldi-Timestampなどのヘッダー値を使用して、リクエストの完全性と信頼性を検証できます。
HTTP Header
X-Vivoldi-Request-Id: e2ea0405b7ba4f0b9b75797179731ae0
X-Vivoldi-Event-Id: 89365c75dae740ac8500dfc48c5014b5
X-Vivoldi-Webhook-Type: GLOBAL
X-Vivoldi-Resource-Type: URL
X-Vivoldi-Action-Type: NONE
X-Vivoldi-Comp-Idx: 50742
X-Vivoldi-Timestamp: 1758184391752
X-Content-SHA256: e040abf9ac2826bc108fce0117e49290086743733ad9db2fa379602b4db9792c
X-Vivoldi-Signature: t=1758184391752,v1=b610f699d4e7964cdb7612111f5765576920b680e7c33c649e20608406807aaf,alg=hmac-sha256
Request Parameters
- X-Vivoldi-Request-Idstring
- リクエストごとに発行される一意のIDです。各リクエストを識別するために使用されます。
- X-Vivoldi-Event-Idstring
- イベント固有のIDです。
初回のリクエストが失敗して再試行される場合、同じEvent-Idが保持され、同一イベントの重複処理を防止します。 - X-Vivoldi-Webhook-Typestring
- Default:GLOBAL
- Enum:GLOBALGROUP
- GROUP Webhookが有効な場合、この値はGROUPに設定されます。
スタンプイベントはカード単位で動作するため、常にGROUPが使用されます。
リンクおよびクーポンイベントはGROUP Webhookが設定されていない場合、デフォルトでGLOBALとして送信されます。 - X-Vivoldi-Resource-Typestring
- Enum:URLCOUPONSTAMP
- URL: 短縮URL、COUPON: クーポン、STAMP: スタンプ
- X-Vivoldi-Action-Typestring
- Enum:NONEADDREMOVEUSE
NONE: リンククリックやクーポン利用イベントに使用されます。追加の動作はありません。
ADD: スタンプ追加
REMOVE: スタンプ削除
USE: スタンプ特典利用今後、リンクまたはクーポンイベントに新しいアクションが追加される場合、このヘッダー値(
X-Vivoldi-Action-Type)が拡張される可能性があります。- X-Vivoldi-Comp-Idxinteger
- 組織固有のIDXです。
[設定 → 組織設定]ページで確認できます。 - X-Vivoldi-Timestampinteger
- リクエスト時刻(UNIXエポック秒)。許容誤差は±5分以内を推奨します。
- X-Content-SHA256string
- リクエストペイロードのSHA-256ハッシュ値です。
- X-Vivoldi-Signaturestring
- リクエスト署名情報。形式: t=タイムスタンプ、v1=署名値、alg=アルゴリズム。
送信・応答・再試行ポリシー
成功基準
- 受信サーバーが HTTP 2xx(例: 200)を返した場合、成功と見なされます。
- 署名検証後は即座に 200 OK を返してください。タイムアウトは 5秒 のため、長時間処理は応答後に非同期で実行してください。
再試行と無効化
- ネットワークエラーまたは非 2xx 応答時は最大5回まで再試行します。
- 5回連続で失敗した場合、Webhook は自動的に無効化され、管理者に通知メールが送信されます。
- 重複受信防止:
X-Vivoldi-Event-Idの値で重複を確認してください。
ポリシーは運用環境に応じて調整される場合があります。
ヘッダー検証なしで Webhook を処理してもよいですか?
技術的にはPOSTボディ(ペイロード)だけを処理しても動作しますが、本番環境では必ずヘッダー検証を実施してください。
ヘッダー検証を省略すると、偽装リクエスト、ペイロード改ざん、重複処理、追跡不能など深刻なセキュリティリスクが発生します。
主なリスク:
- 偽装リクエスト(スプーフィング): 攻撃者がVivoldiを装って偽のリクエストを送信する可能性があります。
ヘッダー検証がなければ、システムはこれを正当なリクエストとして処理してしまう恐れがあります。 - データ改ざん: 転送途中でペイロードが改ざんされても、署名検証がなければ検出できません。
- 重複処理: リプレイ攻撃により同一イベントが複数回受信され、重複処理や二重付与が発生する可能性があります。
- 追跡不能: Request-Id や Event-Id ヘッダーがなければ、リクエストの追跡、障害解析、再現が困難になります。
Payload
{
"linkId": "202509-event",
"domain": "https://event.com",
"compIdx": 50142,
"redirectType": 200,
"url": "https://my-event.com/books/event/202509",
"ttl": "September 2025 Event",
"description": "The 2025 National Book Festival will be held in the nation's capital at the Walter E.",
"metaImg": "https://my-event.com/storage-services/media/webcasts/2025/2509_thumbnail_00145901.jpg",
"memo": "",
"grpIdx": 0,
"grpNm": "",
"strtYmdt": "2025-09-01 00:00:00",
"endYmdt": "2025-09-30 23:59:59",
"expireYn": "Y",
"expireUrl": "https://my-event.com/books/event/closed",
"acesCnt": 17502,
"pernCnt": 16491,
"acesMaxCnt": 20000,
"referer": "https://www.google.com",
"queryString": "",
"country": "US",
"language": "en",
"regYmdt": "2025-08-31 18:10:22",
"modYmdt": "2025-08-31 18:10:22",
"payloadVersion": "v1"
}Payload Parameters
- linkIdstring
- リンクID。
- domainstring
- リンクドメイン。
- urlstring
- 元の URL。
- ttlstring
- リンクタイトル。
- descriptionstring
redirectTypeが200の場合、meta タグの description 値を設定します。- metaImgstring
redirectTypeが200の場合、meta タグの image 値を設定します。- memostring
- リンク管理用メモ。
- grpIdxinteger
- グループIDX。 指定されたグループがある場合、グローバルではなくグループWebhookが呼び出されます。
- grpNmstring
- グループ名。
- strtYmdtdatetime
- リンク有効期間の開始日時。
- ednYmdtdatetime
- リンク有効期間の終了日時。
- expireYnstring
- Default:N
- Enum:YN
- 有効期間が終了した場合は
Yが返されます。 - expireUrlstring
- 有効期限切れ後にリダイレクトされるURL。
- acesCntinteger
- 総クリック数。
- pernCntinteger
- ユニーククリック数(ユニークユーザー数)。
- acesMaxCntinteger
- 最大クリック許容数。 超過するとリンクアクセスがブロックされます。
- refererstring
- リクエストが発生したページのURL。
- queryStringstring
- 短縮URLアクセス時に含まれるクエリ文字列。
- countrystring
- ユーザーの国コード(ISO-3166)。
- languagestring
- ユーザーの言語コード(ISO-639)。
- regYmdtdatetime
- リンク作成日時。
- modYmdtdatetime
- リンク更新日時。
- payloadVersionstring
- Payload バージョン。 後に変更があった場合はバージョンが増加します。
{
"cpnNo": "ZJLF0399WQBEQZJM",
"domain": "https://vvd.bz",
"nm": "$10 off cake coupon",
"grpIdx": 574,
"grpNm": "Event coupons",
"discTypeIdx": 457,
"discCurrency": "USD",
"formatDiscCurrency": "$10"
"disc": 10.0,
"strtYmd": "2025-01-01",
"endYmd": "2025-12-31",
"useLimit": 1,
"imgUrl": "https://file.vivoldi.com/coupon/2024/11/08/lmTFkqLQdCzeBuPdONKG.webp",
"onsiteYn": "Y",
"onsitePwd": "123456",
"memo": "$10 off cake with coupon at the venue",
"url": "",
"userId": "user08",
"userNm": "Emily",
"userPhnno": "202-555-0173",
"userEml": "test@gmail.com",
"userEtc1": "",
"userEtc2": "",
"useCnt": 0,
"regYmdt": "2025-08-31 18:10:22",
"payloadVersion": "v1"
}Payload Parameters
- cpnNostring
- クーポン番号。
- domainstring
- クーポンドメイン。
- nmstring
- クーポン名。
- grpIdxinteger
- グループIDX。指定されたグループがある場合、グローバル(Global)の代わりにグループWebhookが呼び出されます。
- grpNmstring
- グループ名。
- discTypeIdxinteger
- Default:457
- Enum:457458
- 割引タイプ。(457: 割合割引 %, 458: 金額割引)
- discCurrencystring
- Default:KRW
- Enum:KRWCADCNYEURGBPIDRJPYMURRUBSGDUSD
- 通貨単位。金額割引(discTypeIdx:458)を使用する場合は必須。
- formatDiscCurrencystring
- 通貨記号。
- discdouble
- Default:0
- 割合割引(457)は1~100%の範囲、金額割引(458)は金額を入力。
- strtYmddate
- クーポン有効開始日。
- endYmddate
- クーポン有効期限。
- useLimitinteger
- Default:1
- Enum:012345
- クーポン使用可能回数。(0: 無制限, 1~5: 制限回数)
- imgUrlstring
- クーポン画像URL。
- onsiteYnstring
- Default:N
- Enum:YN
- 店舗クーポンかどうか。クーポンページに
「クーポン使用」ボタンの表示有無。
オフライン店舗でスタッフがクーポンを使用する際に必要。 - onsitePwdstring
- 店舗クーポンのパスワード。
クーポン使用時に必要なパスワード。 - memostring
- 内部参照用メモ。
- urlstring
- URLを入力すると、クーポンページに
「クーポンを使いに行く」ボタンが表示されます。
ボタンまたはクーポン画像をクリックすると、そのURLにリダイレクトされます。 - userIdstring
- クーポン発行対象者を管理するために使用。
クーポン使用可能回数が2~5に設定されている場合、必ず入力が必要。
通常はウェブサイト会員のログインIDまたは英字氏名を入力。 - userNmstring
- クーポン利用者の名前。内部管理用。
- userPhnnostring
- クーポン利用者の連絡先。内部管理用。
- userEmlstring
- クーポン利用者のメールアドレス。内部管理用。
- userEtc1string
- 追加の内部管理用フィールド。
- userEtc2string
- 追加の内部管理用フィールド。
- useCntinteger
- クーポン使用回数。
- regYmdtdatetime
- クーポン作成日時。例: 2025-07-21 11:50:20
{
"stampIdx": 16,
"domain": "https://vvd.bz",
"cardIdx": 1,
"cardNm": "Accumulate 10 Americanos",
"cardTtl": "Collect 10 stamps to get one free Americano.",
"stamps": 10,
"maxStamps": 12,
"stampUrl": "https://vvd.bz/stamp/274",
"url": "https://myshopping.com",
"strtYmd": "2025-01-01",
"endYmd": "2026-12-31",
"onsiteYn": "Y",
"onsitePwd": "123456",
"memo": null,
"activeYn": "Y",
"userId": "NKkDu9X4p4mQ",
"userNm": null,
"userPhnno": null,
"userEml": null,
"userEtc1": null,
"userEtc2": null,
"stampImgUrl": "https://cdn.vivoldi.com/www/image/icon/stamp/icon.stamp.1.webp",
"regYmdt": "2025-10-30 05:11:35",
"payloadVersion": "v1"
}Payload Parameters
- stampIdxinteger
- スタンプIDX。
- domainstring
- スタンプドメイン。
- cardIdxinteger
- カードIDX。
- cardNmstring
- カード名。
- cardTtlstring
- カードタイトル。
- stampsinteger
- 現在までに集めたスタンプの数。
- maxStampsinteger
- カードで設定された最大スタンプ数。
- stampUrlstring
- スタンプページのURL。
- urlstring
- スタンプページのボタンをクリックした際に移動するURL。
- strtYmddate
- スタンプの有効開始日。
- endYmddate
- スタンプの有効期限。
- onsiteYnstring
- Enum:YN
- 店舗でのスタンプ付与を有効にするかどうかを示します。 値が
Yの場合、店舗スタッフが現場でスタンプを押すことができます。 - onsitePwdstring
- 店舗スタンプ用パスワード。 現場スタンプが有効(
Y)の場合、スタンプ特典利用API呼び出し時に必須です。 - memostring
- 内部参照用メモ。
- activeYnstring
- Enum:YN
- スタンプの有効状態を示します。 無効化されている場合、顧客はスタンプを利用できません。
- userIdstring
- ユーザーID。スタンプ発行対象者の管理に使用します。
一般的に、ウェブサイト会員のログインIDを入力します。
設定されていない場合は、システムによって自動的にユーザーIDが生成されます。 - userNmstring
- ユーザー名。内部管理用。
- userPhnnostring
- ユーザーの電話番号。内部管理用。
- userEmlstring
- ユーザーのメールアドレス。内部管理用。
- userEtc1string
- 追加の内部管理フィールド。
- userEtc2string
- 追加の内部管理フィールド。
- stampImgUrlstring
- スタンプ画像のURL。
- regYmdtdatetime
- スタンプ作成日時。例: 2025-07-21 11:50:20
署名検証 — コードサンプル
Webhookリクエストは、X-Vivoldi-Signatureヘッダーと発行されたWebhookシークレットキーを使用して検証する必要があります。
署名は、タイムスタンプ(t)、イベントID(X-Vivoldi-Event-Id)、およびリクエストボディのSHA-256ハッシュ値を結合し、次の形式で生成されます。
timestamp.eventId.payloadSha256
この文字列をシークレットキーでHMAC-SHA256ハッシュ化した結果がv1の値となり、ヘッダーのX-Vivoldi-Signature値と一致すればリクエストは有効とみなされます。
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.stereotype.Controller;
import org.apache.commons.codec.binary.Hex;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.security.MessageDigest;
import java.util.Map;
@RestController
@RequestMapping("/webhooks")
public class WebhookController {
private final Logger log = LoggerFactory.getLogger(getClass());
@Value("${vivoldi.webhook.secret}")
private String globalSecretKey; // global secret key
@PostMapping("/vivoldi")
public ResponseEntity<String> handleWebhook(@RequestBody String payload, @RequestHeader Map<String, String> headers) {
// Extracting the Vivoldi header
String requestId = headers.get("x-vivoldi-request-id");
String eventId = headers.get("x-vivoldi-event-id");
String webhookType = headers.get("x-vivoldi-webhook-type");
String resourceType = headers.get("x-vivoldi-resource-type");
String actionType = headers.get("x-vivoldi-action-type");
String signature = headers.get("x-vivoldi-signature");
// Signature Verification
if (!verifySignature(payload, signature, webhookType, resourceType, eventId)) {
return ResponseEntity.status(401).body("Invalid signature");
}
// Processing by Resource Type
switch (resourceType) {
case "URL":
handleLink(payload);
break;
case "COUPON":
handleCoupon(payload);
break;
case "STAMP":
handleStamp(payload, actionType);
break;
default:
log.warn("Unknown resourceType type: {}", resourceType);
}
return ResponseEntity.ok("success");
}
private String sha256(String data) throws Exception {
MessageDigest digest = MessageDigest.getInstance("SHA-256");
byte[] hash = digest.digest(data.getBytes(StandardCharsets.UTF_8));
StringBuilder sb = new StringBuilder();
for (byte b : hash) sb.append(String.format("%02x", b));
return sb.toString();
}
private boolean verifySignature(String payload, String signature, String webhookType, String resourceType, String eventId) {
try {
String timestamp = null;
String sig = null;
for (String part : signature.split(",")) {
part = part.trim();
if (part.startsWith("t=")) timestamp = part.substring(2);
if (part.startsWith("v1=")) sig = part.substring(3);
}
if (timestamp == null || sig == null || eventId == null) return false;
String payloadSha256 = null;
try {
payloadSha256 = sha256(payload);
} catch (Exception e) {
log.error(e.getMessage(), e);
return false;
}
String signedPayload = timestamp + "." + eventId + "." + payloadSha256;
String secretKey = webhookType.equals("GLOBAL") ? globalSecretKey : "";
if (secretKey.isEmpty()) {
JSONObject jsonObj = new JSONObject(payload);
if (resourceType.equals("STAMP")) {
long cardIdx = jsonObj.optLong("cardIdx", -1);
secretKey = loadStampCardSecretKey(cardIdx);
} else {
int grpIdx = jsonObj.optInt("grpIdx", -1);
secretKey = loadGroupSecretKey(grpIdx); // In actual production environments, database integration
}
}
if (secretKey == null || secretKey.isEmpty()) return false;
Mac mac = Mac.getInstance("HmacSHA256");
mac.init(new SecretKeySpec(secretKey.getBytes(StandardCharsets.UTF_8), "HmacSHA256"));
byte[] hash = mac.doFinal(signedPayload.getBytes(StandardCharsets.UTF_8));
String computedSig = Hex.encodeHexString(hash);
return MessageDigest.isEqual(
sig.toLowerCase().getBytes(StandardCharsets.UTF_8),
computedSig.toLowerCase().getBytes(StandardCharsets.UTF_8)
);
} catch (Exception e) {
log.error("Signature verification failed", e);
return false;
}
}
private String loadStampCardSecretKey(long cardIdx) {
switch (cardIdx) {
case 147: return "your-stamp-card-secret-key-147";
case 523: return "your-stamp-card-secret-key-523";
default: return "";
}
}
private String loadGroupSecretKey(int grpIdx) {
switch (grpIdx) {
case 3570: return "your-group-secret-key-3570";
case 4178: return "your-group-secret-key-4178";
default: return "";
}
}
private void handleLink(String payload) {
// Link Click Event Handling Logic
log.info("Link clicked: {}", payload);
}
private void handleCoupon(String payload) {
// Coupon Usage Event Handling Logic
log.info("Coupon redeemed: {}", payload);
}
private void handleStamp(String payload, String actionType) {
// Stamp Usage Event Handling Logic
if (actionType.equals("ADD")) {
log.info("Stamp added: {}", payload);
} else if (actionType.equals("RMEOVE")) {
log.info("Stamp removed: {}", payload);
} else if (actionType.equals("USE")) {
log.info("Stamp redeemed: {}", payload);
}
}
}
<?php
// Environment Settings
$globalSecretKey = $_ENV['VIVOLDI_WEBHOOK_SECRET'] ?? 'your-global-secret-key';
/**
* Main Webhook Handler Function
*/
function handleWebhook($payload) {
// Header Information Extraction
$headers = array_change_key_case(getallheaders(), CASE_LOWER);
$requestId = $headers['x-vivoldi-request-id'] ?? '';
$eventId = $headers['x-vivoldi-event-id'] ?? '';
$webhookType = $headers['x-vivoldi-webhook-type'] ?? '';
$resourceType = $headers['x-vivoldi-resource-type'] ?? '';
$actionType = $headers['x-vivoldi-action-type'] ?? '';
$signature = $headers['x-vivoldi-signature'] ?? '';
// Signature Verification
if (!verifySignature($payload, $signature, $webhookType, $resourceType, $eventId)) {
http_response_code(401);
echo json_encode(['error' => 'Invalid signature']);
return;
}
// Processing by Resource Type
switch ($resourceType) {
case 'URL':
handleLink($payload);
break;
case 'COUPON':
handleCoupon($payload);
break;
case 'STAMP':
handleStamp($payload, $actionType);
break;
default:
error_log('Unknown resourceType: ' . $resourceType);
}
http_response_code(200);
echo json_encode(['status' => 'success']);
}
function sha256($data) {
return hash('sha256', $data);
}
/**
* HMAC-SHA256 Signature Verification Function
*/
function verifySignature($payload, $signature, $webhookType, $resourceType, $eventId) {
try {
$timestamp = null;
$sig = null;
foreach (explode(',', $signature) as $part) {
$part = trim($part);
if (strpos($part, 't=') === 0) $timestamp = substr($part, 2);
if (strpos($part, 'v1=') === 0) $sig = substr($part, 3);
}
if (!$timestamp || !$sig || !$eventId) return false;
// Timestamp Tolerance Verification (±60 seconds)
if (abs(time() - (int)$timestamp) > 60) {
return false;
}
// Payload SHA256
$payloadSha256 = sha256($payload);
$signedPayload = $timestamp . '.' . $eventId . '.' . $payloadSha256;
$secretKey = getSecretKey($webhookType, $resourceType, $payload);
if (empty($secretKey)) return false;
$computedSig = hash_hmac('sha256', $signedPayload, $secretKey);
// Safety Comparison (lowercase throughout)
return hash_equals(strtolower($sig), strtolower($computedSig));
} catch (Exception $e) {
error_log('Signature verification failed: ' . $e->getMessage());
return false;
}
}
/**
* Secret Key Return Based on Webhook Type and Group
*/
function getSecretKey($webhookType, $resourceType, $payload) {
global $globalSecretKey;
if ($webhookType === 'GLOBAL') {
return $globalSecretKey;
}
// Group-Specific Secret Key Configuration
$jsonData = json_decode($payload, true);
if ($resourceType === 'STAMP') {
if (!isset($jsonData['cardIdx'])) {
return '';
}
// Stamp cardIdx
$cardIdx = $jsonData['cardIdx'];
switch ($cardIdx) {
case 617:
return 'your stamp card secret key for 617';
case 3304:
return 'your stamp card secret key for 3304';
default:
return '';
}
} else {
if (!isset($jsonData['grpIdx'])) {
return '';
}
$grpIdx = $jsonData['grpIdx'];
if ($resourceType === 'LINK') {
// Link grpIdx
switch ($grpIdx) {
case 17584:
return 'your group secret key for 17584';
case 9158:
return 'your group secret key for 9158';
default:
return '';
}
} else {
// Coupon grpIdx
switch ($grpIdx) {
case 3570:
return 'your group secret key for 3570';
case 4178:
return 'your group secret key for 4178';
default:
return '';
}
}
}
}
/**
* Link Event Handler Function
*/
function handleLink($payload) {
error_log('Link clicked: ' . $payload);
// Processing link information by parsing JSON
$linkData = json_decode($payload, true);
if ($linkData) {
// Link Click Statistics Update
$linkId = $linkData['linkId'] ?? '';
$clickTime = $linkData['timestamp'] ?? time();
$userAgent = $linkData['userAgent'] ?? '';
// Storing click information in the database
saveClickEvent($linkId, $clickTime, $userAgent);
error_log("Link {$linkId} clicked at {$clickTime}");
}
}
/**
* Coupon Event Handling Function
*/
function handleCoupon($payload) {
error_log('Coupon redeemed: ' . $payload);
// Parsing JSON to process coupon information
$couponData = json_decode($payload, true);
if ($couponData) {
// Coupon Usage Information Processing
$couponCode = $couponData['couponCode'] ?? '';
$redeemTime = $couponData['timestamp'] ?? time();
$userId = $couponData['userId'] ?? '';
// Storing coupon usage information in the database
saveCouponRedemption($couponCode, $userId, $redeemTime);
error_log("Coupon {$couponCode} redeemed by user {$userId}");
}
}
/**
* Stamp Event Handling Function
*/
function handleStamp($payload, $actionType) {
error_log('Stamp payload: ' . $payload);
// Parsing JSON to process coupon information
$stampData = json_decode($payload, true);
if ($stampData) {
$stampIdx = $stampData['stampIdx'] ?? 0;
switch ($actionType) {
case "ADD":
// Stamp added
break;
case "REMOVE":
// Stamp removed
break;
case "USE":
// Stamp benefit used
break;
default:
return '';
}
}
}
/**
* Store click events in the database
*/
function saveClickEvent($linkId, $clickTime, $userAgent) {
// Implementation of actual database integration logic
// Example: Stored in MySQL, PostgreSQL, etc.
error_log("Saving click event - Link: {$linkId}, Time: {$clickTime}");
}
/**
* Store coupon usage information in the database
*/
function saveCouponRedemption($couponCode, $userId, $redeemTime) {
// Implementation of actual database integration logic
// Example: Updating coupon status, storing usage history, etc.
error_log("Saving coupon redemption - Code: {$couponCode}, User: {$userId}");
}
/**
* Log recording function
*/
function logWebhookEvent($eventType, $data) {
$timestamp = date('Y-m-d H:i:s');
$logMessage = "[{$timestamp}] {$eventType}: " . json_encode($data);
error_log($logMessage);
}
// ===========================================
// Webhook Endpoint Execution Unit
// ===========================================
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
$payload = file_get_contents('php://input');
handleWebhook($payload);
} else {
http_response_code(405);
echo json_encode(['error' => 'Method not allowed']);
}
?>
const express = require('express');
const crypto = require('crypto');
const app = express();
// Environment Settings
const globalSecretKey = process.env.VIVOLDI_WEBHOOK_SECRET || 'your-global-secret-key';
// Form data parser for webhook payloads
app.use(express.raw({ type: '*/*' }));
/**
* Main Webhook Handler Function
*/
function handleWebhook(headers, res, payload) {
const requestId = headers['x-vivoldi-request-id'] || '';
const eventId = headers['x-vivoldi-event-id'] || '';
const webhookType = headers['x-vivoldi-webhook-type'] || '';
const resourceType = headers['x-vivoldi-resource-type'] || '';
const actionType = headers['x-vivoldi-action-type'] || '';
const signature = headers['x-vivoldi-signature'] || '';
// Signature Verification
if (!verifySignature(payload, signature, webhookType, resourceType, eventId)) {
res.status(401).json({ error: 'Invalid signature' });
return;
}
// Processing by Resource Type
switch (resourceType) {
case 'URL':
handleLink(payload);
break;
case 'COUPON':
handleCoupon(payload);
break;
case 'STAMP':
handleStamp(payload);
break;
default:
console.error('Unknown resourceType: ' + resourceType);
}
res.status(200).json({ status: 'success' });
}
/**
* SHA256(hex)
*/
function sha256Hex(data) {
return crypto.createHash('sha256').update(data, 'utf8').digest('hex');
}
/**
* HMAC-SHA256 Signature Verification Function
*/
function verifySignature(payload, signature, webhookType, resourceType, eventId) {
try {
let timestamp, sig;
for (const part of signature.split(',')) {
const p = part.trim();
if (p.startsWith('t=')) timestamp = p.slice(2);
if (p.startsWith('v1=')) sig = p.slice(3);
}
if (!timestamp || !sig || !eventId) return false;
// Timestamp check (±180s)
if (Math.abs(Date.now()/1000 - Number(timestamp)) > 180) return false;
const signedPayload = `${timestamp}.${eventId}.${sha256Hex(payload)}`;
// Secret Key Determination
const secretKey = getSecretKey(webhookType, resourceType, payload);
if (!secretKey) return false;
// HMAC-SHA256 Signature Calculation
const computedSig = crypto
.createHmac('sha256', secretKey)
.update(signedPayload)
.digest('hex');
// Timing-Safe Comparison
return crypto.timingSafeEqual(
Buffer.from(sig.toLowerCase(), 'hex'),
Buffer.from(computedSig.toLowerCase(), 'hex')
);
} catch (e) {
console.error('Signature verification failed: ' + e.message);
return false;
}
}
/**
* Secret Key Return Based on Webhook Type and Group
*/
function getSecretKey(webhookType, resourceType, payload) {
if (webhookType === 'GLOBAL') {
return globalSecretKey;
}
// Group-Specific Secret Key Configuration
let jsonData;
try {
jsonData = JSON.parse(payload);
} catch (error) {
return '';
}
if (resourceType === 'STAMP') {
if (!jsonData.cardIdx) {
return '';
}
const cardIdx = jsonData.cardIdx;
switch (cardIdx) {
case 3570:
return 'your stamp card secret key for 3570';
case 4178:
return 'your stamp card secret key for 4178';
default:
return '';
}
} else {
if (!jsonData.grpIdx) {
return '';
}
const grpIdx = jsonData.grpIdx;
if (resourceType === 'LINK') {
// Link grpIdx
switch (grpIdx) {
case 17584:
return 'your group secret key for 17584';
case 9158:
return 'your group secret key for 9158';
default:
return '';
}
} else {
// Coupon grpIdx
switch (grpIdx) {
case 6350:
return 'your group secret key for 6350';
case 17884:
return 'your group secret key for 17884';
default:
return '';
}
}
}
}
/**
* Link Event Handler Function
*/
function handleLink(payload) {
console.error('Link clicked: ' + payload);
// Processing link information by parsing JSON
let linkData;
try {
linkData = JSON.parse(payload);
} catch (error) {
return;
}
if (linkData) {
// Link Click Statistics Update
const linkId = linkData.linkId || '';
const clickTime = linkData.timestamp || Math.floor(Date.now() / 1000);
const userAgent = linkData.userAgent || '';
// Storing click information in the database
saveClickEvent(linkId, clickTime, userAgent);
console.error(`Link ${linkId} clicked at ${clickTime}`);
}
}
/**
* Coupon Event Handling Function
*/
function handleCoupon(payload) {
console.error('Coupon redeemed: ' + payload);
// Parsing JSON to process coupon information
let couponData;
try {
couponData = JSON.parse(payload);
} catch (error) {
return;
}
if (couponData) {
// Coupon Usage Information Processing
const couponCode = couponData.couponCode || '';
const redeemTime = couponData.timestamp || Math.floor(Date.now() / 1000);
const userId = couponData.userId || '';
// Storing coupon usage information in the database
saveCouponRedemption(couponCode, userId, redeemTime);
console.error(`Coupon ${couponCode} redeemed by user ${userId}`);
}
}
/**
* Stamp Event Handling Function
*/
function handleStamp(payload, actionType) {
console.error('Stamp payload: ' + payload);
// Parsing JSON to process coupon information
let stampData;
try {
stampData = JSON.parse(payload);
} catch (error) {
return;
}
if (stampData) {
const stampIdx = stampData.stampIdx || 0;
switch (actionType) {
case "ADD":
// Stamp added
break;
case "REMOVE":
// Stamp removed
break;
case "USE":
// Stamp benefit used
break;
}
}
}
/**
* Store click events in the database
*/
function saveClickEvent(linkId, clickTime, userAgent) {
// Implementation of actual database integration logic
// Example: Stored in MongoDB, MySQL, PostgreSQL, etc.
console.error(`Saving click event - Link: ${linkId}, Time: ${clickTime}`);
}
/**
* Store coupon usage information in the database
*/
function saveCouponRedemption(couponCode, userId, redeemTime) {
// Implementation of actual database integration logic
// Example: Updating coupon status, storing usage history, etc.
console.error(`Saving coupon redemption - Code: ${couponCode}, User: ${userId}`);
}
/**
* Log recording function
*/
function logWebhookEvent(eventType, data) {
const timestamp = new Date().toISOString().replace('T', ' ').substring(0, 19);
const logMessage = `[${timestamp}] ${eventType}: ${JSON.stringify(data)}`;
console.error(logMessage);
}
// ===========================================
// Webhook Endpoint Execution Unit
// ===========================================
app.post('/webhook/vivoldi', (req, res) => {
const payload = req.body.toString('utf8');
const headers = req.headers;
if (!verifySignature(payload, headers['x-vivoldi-signature'], headers['x-vivoldi-webhook-type'], headers['x-vivoldi-event-id'])) {
return res.status(401).json({ error: 'Invalid signature' });
}
handleWebhook(req.headers, res, payload);
});
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
console.log(`Webhook server running on port ${PORT}`);
});
✨ エンタープライズ級リアルタイム連携
Webhookは、リンク・クーポン・スタンプのイベントをリアルタイムで貴社のCRM、決済、分析システムと連携します。
高可用性インフラ、安定したキューイング・再試行メカニズム、HMACベースのセキュリティ機能を組み合わせ、エンタープライズ環境で高い信頼性を実現します。