Introduction
Bluebeam Studio is a cloud collaboration platform that construction and design teams use to run drawing reviews, markups, and document handoffs through Bluebeam Revu. Many organizations need Studio Sessions, Projects, and Jobs data in SQL Server for reporting, audit trails, and project tracking.
In this tutorial, you will learn how to connect to the Bluebeam Studio API using SQL Server Integration Services (SSIS) with the ZappySys SSIS PowerPack. This approach helps you build repeatable ETL pipelines without writing custom OAuth or API integration code.
Prerequisites
Before we perform the steps listed in this article, make sure the prerequisites are met:- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- Make sure the SSIS designer is installed.
- Download and install ZappySys SSIS PowerPack.
Steps
Get Bluebeam API credentials
- Sign in to the Bluebeam Developer Portal with your BBID credentials.
- Register a new App and note the region it is registered under (US, DE, AU, UK, or SE), since this determines the base URL you will use later.
- Open the App details page and generate your Client ID and Client Secret — store both values securely. You will need the Client ID again later for a required request header.
Create an HTTP connection in SSIS
- Create or open your SSIS project and package.
- In Connection Managers, right-click and select New Connection….
- Select ZS-OAUTH from the SSIS connectors list.
- Set OAuth version to OAuth2
- Set OAuth Grant type to Authorization Code Grant.
- Enter your Client ID and Client Secret from the previous step.
- Set the Authorization URL to https://api.bluebeam.com/oauth2/authorize and the Access Token URL to https://api.bluebeam.com/oauth2/token using your region’s host.
- Set Scope to:
123full_userjobsoffline_access - Click Generate Token and click OK to save the connection.
Create and configure JSON Source
- Drag a Data Flow Task into Control Flow and open it.
- In Data Flow, drag and drop the ZS JSON Source.
- Open the JSON Source editor and enable Use credentials.
- Select the Bluebeam HTTP connection you created earlier.
- Set the API URL using your region’s base URL. Example to list Studio Sessions:
1https://api.bluebeam.com/publicapi/v1/sessions - Set the HTTP Request Method to GET.
- Add the following HTTP Headers:
- Content-Type: application/json
- client_id: your Bluebeam Client ID
Bluebeam rejects the request with only the Bearer token from the OAuth connection; the
client_idheader must be added manually here, since it identifies the App making the call. - Set the JSON Path Filter based on the response shape; example: $.Sessions[*]
- Click Preview to confirm rows are returned, then click OK to save the configuration.
Configure Destination component
- Add an Upsert Destination (or another destination of your choice, such as a Trash destination or JSON/CSV/XML destination).
- Connect the output arrow from JSON Source to the destination component.
- Configure your SQL Server connection and target table.
- Select the options you want to use: Insert and/or Update.
- Map the source columns to destination columns in the Mappings section.
- Click OK and execute the package.
- Validate that Bluebeam Studio rows have been loaded into your SQL Server table.
Conclusion
You now have a working SSIS integration to extract Bluebeam Studio data using ZappySys SSIS PowerPack and the Bluebeam Studio API. With this pattern, you can automate extraction of Sessions, Projects, and Jobs data into SQL Server for reporting and project tracking, since the OAuth2 refresh token keeps the connection authenticated without repeated manual logins.
Explore the full capabilities of the ZappySys SSIS PowerPack to optimize your data integration tasks. By applying this pattern, you can extend your solution to include transformations, data validation, error handling, and scheduling through SQL Server Agent.
Need Help?
If you encounter any issues, our support team is here to help:
- Live Chat: Open the chat widget (bottom right of this page)
- Email: support@zappysys.com
- Support Center: Support | ZappySys






