Skip to main content
ウェブフックは、Twenty でイベントが発生したときに、ポーリング不要でリアルタイムにお使いのシステムへデータをプッシュします。 外部システムとの同期を保ち、オートメーションをトリガーしたり、アラートを送信したりするために使用できます。

Webhookを作成

  1. Settings → APIs & Webhooks → Webhooksに移動
  2. + Webhookを作成をクリック
  3. ウェブフックの URL を入力(外部からアクセス可能である必要があります)
  4. 保存をクリック
ウェブフックは直ちに有効化され、通知の送信を開始します。

Webhookを管理

編集: ウェブフックをクリック → URL を更新 → 保存 削除: ウェブフックをクリック → 削除 → 確認

イベント

Twenty は次のイベントタイプに対してウェブフックを送信します。
イベント
レコードの作成person.created, company.created, note.created
レコードの更新person.updated, company.updated, opportunity.updated
レコードの削除person.deleted, company.deleted
すべてのイベントタイプはウェブフックの URL に送信されます。 イベントのフィルタリングは将来のリリースで追加される可能性があります。

ペイロード形式

各ウェブフックは JSON ボディを含む HTTP POST を送信します。
フィールド説明
イベント何が起きたか(例: person.created
データ作成/更新/削除された完全なレコード
タイムスタンプイベントが発生した時刻(UTC)
受信を確認するために、2xx HTTP ステータス(200~299)で応答してください。 2xx 以外の応答は配信失敗として記録されます。

ウェブフックの検証

Twenty はセキュリティのために各ウェブフックリクエストに署名します。 リクエストが正当であることを確認するために署名を検証してください。

ヘッダー

ヘッダー説明
X-Twenty-Webhook-SignatureHMAC SHA256 署名
X-Twenty-Webhook-Timestampリクエストのタイムスタンプ

検証手順

  1. X-Twenty-Webhook-Timestamp からタイムスタンプを取得
  2. 次の文字列を作成: {timestamp}:{JSON payload}
  3. ウェブフックシークレットを使用して HMAC SHA256 を計算
  4. X-Twenty-Webhook-Signature と比較

例(Node.js)

ウェブフック vs ワークフロー

メソッド方向ユースケース
ウェブフックOUTあらゆるレコード変更を外部システムへ自動通知
ワークフロー + HTTP リクエストOUTカスタムロジック(フィルター、変換)でデータを外部送信
ワークフローのウェブフックトリガーIN外部システムから Twenty にデータを受信
外部データの受信については、Webhook トリガーを設定を参照してください。