Optimera dina integrationer med Webhooks

Använd Bluebeams API Webhooks-slutpunkter (även kallade prenumerationer) för att prenumerera på Studio-uppdateringar så att din app tar emot ändringar automatiskt, och du slipper söka efter dem manuellt.

Webhooks är en standardfunktion i Bluebeam API som är tillgänglig för alla integrationer.

Webhook-slutpunkter ger dig möjlighet att prenumerera på aktivitet och uppdateringar för Studio-projekt eller Studio-sessioner, så att integrationer kan utlösas automatiskt när vissa händelser inträffar. Webhooks minimerar behovet av upprepade förfrågningar – prenumerera på de händelser som du vill spåra, så skickar API-slutpunkterna uppdateringar direkt. Det bidrar till att minska mängden onödiga API-anrop och förbättra systemets övergripande prestanda.

Vi ser fram emot att se hur du utnyttjar Webhooks för att förbättra dina integrationer och skapa anpassade arbetsflöden med Bluebeam API.

Händelsemeddelanden

Webhooks-typ Händelser som utlöser meddelanden
Session

  • På sessionsnivå

    • Uppdatera (byt namn, uppdatera utgångsdatum, slutför)

    • Radera

  • På sessionsdokumentnivå

    • Skapa
    • Radera
Projekt

  • På projektnivå

    • Uppdatera (byt namn)

    • Radera

  • På projektobjektnivå

    • Skapa
    • Uppdatera (flytta, byt namn, checka in)
    • Radera

API-slutpunkter

Alla slutpunkter kräver följande:

  • En Authorization-rubrik med en token från Developer API

  • En client_id-rubrik

Exempel på brödtext:

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

  • sourceType kan vara ”session” eller ”project”

  • resourceID är antingen sessions-ID eller projekt-ID

  • callbackURI måste vara en giltig URI som använder https

Exempelsvar:

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

 

Uppdaterar callbackURI för en prenumeration.

Exempel på brödtext:

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

Exempelsvar:

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

 

Returnerar en lista över alla prenumerationer som är tillgängliga för användaren.

Exempelsvar:

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

 

Returnerar information om en enskild prenumeration.

Exempelsvar:

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

 

Ställer in en prenumerations status som ”disabled” (inaktiverad).

Returnerar 204 inget innehåll.

Exempel på callbacks

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

 

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

 

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

 

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

 

Kontakta utvecklingssupporten

Om du har frågor om integrationsfunktionerna, specifika API-slutpunkter eller något annat som gäller Bluebeam kan du kontakta oss på integrations@bluebeam.com.

För detaljerad information om API-slutpunkter och de senaste uppdateringarna av integrationsplattformen kan du gå till avsnittet för API Docs i Developer Portal.

Resurser

Revu 21

Bluebeam-integrationer

Bluebeam-integrationer

Använd Bluebeams API Webhooks-slutpunkter (även kallade prenumerationer) för att prenumerera på Studio-uppdateringar så att din app tar emot ändringar automatiskt, och du slipper söka efter dem manuellt.