Optimieren von Integrationen mit Webhooks

Verwenden Sie die API-Webhooks-Endpunkte (auch als Abos bekannt) von Bluebeam, um Studio-Updates zu abonnieren, damit Ihre App automatisch Änderungen erhält und manuelles Abfragen überflüssig wird.

Webhooks sind eine Standardfunktion der Bluebeam-API und stehen allen Integrationen zur Verfügung.

Mit Webhook-Endpunkten können Sie Aktivitäten und Updates für Studio-Projekte oder Sitzungen abonnieren, sodass Integrationsauslöser in Echtzeit aktiviert werden, sobald Ereignisse eintreten. Durch die Verwendung von Webhooks vermeiden Sie wiederholte Abfragen. Abonnieren Sie die Ereignisse, die Sie verfolgen möchten, und die API-Endpunkte senden Updates direkt. Dies trägt dazu bei, unnötige API-Aufrufe zu reduzieren und die Gesamtsystemleistung zu verbessern.

Wir sind gespannt, wie Sie Webhooks nutzen, um Ihre Integrationen zu verbessern und benutzerdefinierte Arbeitsabläufe mit der Bluebeam-API zu erstellen!

Ereignisbenachrichtigungen

Art der Webhooks	Ereignisse, die Benachrichtigungen auslösen
Sitzung	Sitzungsebene Aktualisieren (umbenennen, Ablaufdatum aktualisieren, abschließen) Löschen Sitzungsdokumentebene Erstellen Löschen
Projekt	Projektebene Aktualisieren (umbenennen) Löschen Projektebene Erstellen Aktualisieren (verschieben, umbenennen, einchecken) Löschen

API-Endpunkte

Für alle Endpunkte ist Folgendes erforderlich:

Ein Authorization Header mit einem Token aus der Entwickler-API
Ein client_id-Header

POST /publicapi/v2/Abos

Beispieltext:

Kopieren

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

sourceType kann „Sitzung“ oder „Projekt“ sein
resourceID ist entweder die Sitzungs-ID oder die Projekt-ID
callbackURI muss eine gültige URI mit https sein

Beispielantwort:

Kopieren

{
    "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/Abos

Aktualisiert die callbackURI eines Abos.

Beispieltext:

Kopieren

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

Beispielantwort:

Kopieren

{
    "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/Abos

Antwortet mit einer Liste aller für den Benutzer verfügbaren Abos.

Beispielantwort:

Kopieren

{
    "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}

Antwortet mit Informationen zu einem einzelnen Abo.

Beispielantwort:

Kopieren

{
    "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}
}

Beispiel-Callbacks

Importieren von Sitzungsdokumenten

Kopieren

{
  "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"
}

Umbenennen einer Sitzung

Kopieren

{
  "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"
}

Einchecken einer Projektdatei

Kopieren

{
  "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": "File",
  "Name": "test.pdf"
}

Löschen eines Projekts

Kopieren

{
  "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"
}

Entwickler-Support kontaktieren

Wenn Sie Fragen zur Integrationsfunktionalität, zu bestimmten API-Endpunkten oder zu anderen Bluebeamthemen haben, senden Sie uns eine E-Mail an integrations@bluebeam.com.

Für detaillierte Informationen zu API-Endpunkten und den neuesten Aktualisierungen der Integrationsplattform besuchen Sie den API Docs-Abschnitt im Developer Portal.

Ressourcen

Revu 21

Bluebeam Integrationen