Webhook との統合を最適化する

Bluebeam の API Webhooks（Subscriptions とも呼ばれます）エンドポイントを使用して Studio の更新を受信登録すると、アプリが自動的に変更を受け取るようになり、手動でポーリングする必要がなくなります。

Webhook は Bluebeam API の標準機能であり、すべての統合で利用できます。

Webhook エンドポイントを使用すると、Studio プロジェクトまたはセッションのアクティビティや更新を受信登録できるため、イベントが発生したときにリアルタイムの統合トリガーを有効にできます。Webhook を利用することで、繰り返しポーリングを行う必要がなくなります。追跡したいイベントを購読すると、API エンドポイントが直接更新を送信し、不要な API 呼び出しを減らしてシステム全体のパフォーマンスを向上させることができます。

お客様が Webhook を活用して統合を強化し、Bluebeam API でカスタムワークフローを作成する様子を見れることを嬉しく思います。

イベント通知

Webhook のタイプ	通知をトリガーするイベント
セッション	セッションレベル更新（名前の変更、有効期限の更新、確定）削除セッション文書レベル作成削除
プロジェクト	プロジェクトレベル更新（名前の変更）削除プロジェクト項目レベル作成更新（移動、名前の変更、チェックイン）削除

API エンドポイント

すべてのエンドポイントには以下が必要です。

開発者 API からのトークンを含む認証ヘッダ
client_id ヘッダ

POST /publicapi/v2/subscriptions

本文の例：

copy

{
    "sourceType": "project",
    "resourceId": "123-456-789",
    "callbackURI": {callback URI}
}

sourceType は「session」または「project」になります
resourceID はセッション ID またはプロジェクト ID のいずれかです。
callbackURI は https を使用した有効な URI である必要があります

レスポンスの例：

copy

{
    "subscriptionId": "0476edcf-e0e5-4242-8203-ad1770f4f059",
    "resourceId": "123-456-789",
    "sourceType": "project",
    "creatorEmail": {email},
    "clientId": {client id},
    "subscriptionStatus": "active",
    "created": "2025-06-16T15:50:20.831973204Z",
    "updated": "2025-06-16T15:50:20.831973204Z",
    "callbackURI": {callback URI}
}

PUT /publicapi/v2/subscriptions

サブスクリプションの callbackURI を更新します。

本文の例：

copy

{
    "subscriptionId": "0476edcf-e0e5-4242-8203-ad1770f4f059",
    "callbackURI": {new callback URI}
}

レスポンスの例：

copy

{
    "subscriptionId": "0476edcf-e0e5-4242-8203-ad1770f4f059",
    "resourceId": "123-456-789",
    "sourceType": "session",
    "creatorEmail": {email},
    "clientId": {client id},
    "subscriptionStatus": "active",
    "created": "2025-06-16T15:50:20.831973204Z",
    "updated": "2025-06-16T15:53:30.274499919Z",
    "callbackURI": {new callback URI}
}

GET /publicapi/v2/subscriptions

ユーザーが利用可能なすべてのサブスクリプションのリストを返します。

レスポンスの例：

copy

{
    "subscriptions": [
        {
            "subscriptionId": "0476edcf-e0e5-4242-8203-ad1770f4f059",
            "resourceId": "123-456-789",
            "sourceType": "session",
            "creatorEmail": {email},
            "clientId": {client id},
            "subscriptionStatus": "active",
            "created": "2025-06-16T15:50:20.831973204Z",
            "updated": "2025-06-16T15:53:30.274501793Z",
            "callbackURI": {callback URI}
        },
        {
            "subscriptionId": "f4b3a7b5-4b4c-47af-b1c2-3493255fc26d",
            "resourceId": "987-654-321",
            "sourceType": "project",
            "creatorEmail": {email},
            "clientId": {client id},
            "subscriptionStatus": "disabled",
            "created": "2025-05-13T19:21:00.736687777Z",
            "updated": "2025-06-05T14:37:15.546528614Z",
            "callbackURI": {callback URI}
        }
    ]
}

GET /publicapi/v2/subscriptions/{subscriptionID}

単一のサブスクリプションに関する情報を返します。

レスポンスの例：

copy

{
    "subscriptionId": "0476edcf-e0e5-4242-8203-ad1770f4f059",
    "resourceId": "123-456-789",
    "sourceType": "session",
    "creatorEmail": {email},
    "clientId": {client id},
    "subscriptionStatus": "active",
    "created": "2025-06-16T15:50:20.831973204Z",
    "updated": "2025-06-16T15:53:30.274501793Z",
    "callbackURI": {callback URI}
}

コールバックの例

セッションドキュメントの追加

copy

{
  "Source": "Studio",
  "ResourceID": "123-456-789",
  "ResourceType": "SessionDocuments",
  "Timestamp": "2025-06-16T15:58:44.2265563Z",
  "User": {email},
  "EventType": "Create",
  "IdPath": "null",
  "Path": "null",
  "ItemType": "null",
  "Name": "test.pdf"
}

セッションの名前を変更

copy

{
  "Source": "Studio",
  "ResourceID": "123-456-789",
  "ResourceType": "Sessions",
  "Timestamp": "2025-06-16T15:59:31.2323589Z",
  "User": {email},
  "EventType": "Update",
  "IdPath": "null",
  "Path": "null",
  "ItemType": "null",
  "Name": "newSessionName"
}

プロジェクトファイルのチェックイン

copy

{
  "Source": "Studio",
  "ResourceID": "987-654-321",
  "ResourceType": "ProjectItems",
  "Timestamp": "2025-06-16T16:01:56.8371219Z",
  "User": {email},
  "EventType": "Update",
  "IdPath": "/17484067/17572477",
  "Path": "/level1/test.pdf",
  "ItemType" ："ファイル" 、
  "ファイル名":"test.pdf"
}

Deleting a Project

copy

{
  "Source": "Studio",
  "ResourceID": "987-654-321",
  "ResourceType": "Projects",
  "Timestamp": "2025-06-16T16:03:40.0220965Z",
  "User": {email},
  "EventType": "Delete",
  "IdPath": "null",
  "Path": "null",
  "ItemType": "null",
  "Name": "testProject"
}

開発サポートへのお問い合わせ

統合機能、特定の API エンドポイント、およびその他の Bluebeam 関連の質問については、integrations@bluebeam.com までメールでお問い合わせください。

API エンドポイントと統合プラットフォームの最新アップデートに関する詳細情報については、Developer Portal の API ドキュメントセクションをご覧ください。

リソース

Revu 21

Bluebeam 統合