Webhook
Webhookにより、Trimojiはイベント発生時(テスト完了、キャンペーン作成など)にリアルタイムで貴社アプリケーションに通知を送信できます。APIに不必要に負荷をかけることなく、データを同期するための最も効率的な方法です。
仕組み:イベントが発生すると、Trimojiは設定したURLに対してHTTP POSTリクエストを送信し、対応するデータを添付します。
ステップ1
Webhookの設定
Webhookの管理は、クライアントインターフェースの「 Trimojiアカウント 」で行います。
設定手順:
-
サーバーの送信先URL(例:
https://your-site.com/api/webhook)を入力します。 - 監視したいイベントを選択します。
- 追加を承認します。
- 重要:Webhook作成後、Trimojiは自動的に一意のシークレット(トークン)を生成します。このトークンを取得して、エンドポイントを保護する必要があります。
ステップ2
セキュリティと認証
Trimojiは、リクエストごとに生成されたシークレットを使用してリクエストに署名し、認証を行います。サーバー側でこの情報を検証し、リクエストが当社のサービスから送信されたものであることを確認する必要があります。
トークンは、各リクエストで次の2つの方法で送信されます:
-
HTTPヘッダー:
Authorization: YOUR_GENERATED_TOKEN -
JSONボディ:
{ "_token": "YOUR_GENERATED_TOKEN", ... }
ステップ3
ペイロード(データ)構造
Trimojiから送信されるすべてのリクエストは、アクションを迅速に識別できる標準化されたJSON形式に従います。
{ "_token": "trimojiが生成したトークン", "_timestamp": "2026-02-11T16:00:00.000Z", "_event": "QUIZZ_COMPLETED", // イベントに応じた動的なデータ "id": 12345, "data": { ... } }
ステップ4
利用可能なイベントリスト
自動化のニーズに応じて、さまざまな種類のアクションにサブスクライブできます:
テスト&評価
-
QUIZZ_SENT -
QUIZZ_COMPLETED
候補者&プロフィール
-
PROFILE_UPDATED -
PROFILE_DELETED -
PROFILE_RESTORED
キャンペーン&メタプロフィール
-
CAMPAIGN_CREATED/UPDATED -
PERSONI_CREATED
セキュリティ&フロー
-
AUTH_LOGIN -
TRANSFER_INCOMING
ステップ5
技術仕様
-
User-Agent:リクエストは
trimoji/1.0.0という識別子で送信されます。 -
期待される応答:サーバーは
200 OKコードを返す必要があります。お客様側でエラーが発生した場合、Trimojiはアカウントのログに失敗を記録します。 -
フォーマット:リクエストボディは常に
JSON形式です。