SSIS Tutorial: How to get data from Hivebrite

Introduction

Hivebrite is a community management platform used for memberships, events, directories, and engagement workflows. Many teams need Hivebrite data in SQL Server for reporting, segmentation, and operational analytics.

In this tutorial, you will learn how to connect Hivebrite API data to SQL Server Integration Services (SSIS) by using ZappySys SSIS PowerPack. You can then automate extraction and loading without writing a custom API client.

Steps

Prepare Hivebrite API access

1. Sign in to your Hivebrite admin area and go to Integrations → External Integrations.
2. Click Create a Service App and give it a name.
   • Copy the Client ID (UUID) and Client Secret shown at creation — the secret is displayed only once and cannot be retrieved afterward.
3. Identify your Authorization Host based on the zone that hosts your community:
   • US: auth.us.hivebrite.com
   • EU: auth.eu.hivebrite.com
   • APAC: auth.apac.hivebrite.com
   • CH: auth.ch.hivebrite.com

Create an OAuth2 connection in SSIS

1. Create or open your SSIS project and package.
2. In Connection Managers, right-click and select New Connection….
3. Select ZS-OAUTH from the SSIS connectors list.
   

   Create a new SSIS OAuth API Connection Manager.

4. Set the following values:
   • OAuth Provider: Custom
   • OAuth Version: OAuth2
   • OAuth Grant Type: Client Credentials Grant
   • Client ID: Your Hivebrite Client ID (UUID)
   • Client Secret: Your Hivebrite Client Secret
   • Access Token URL: https://auth.{zone}.hivebrite.com/oauth2/token
   • Scopes/Permissions: (leave empty)
     

     Hivebrite – OAuth connection configuration

5. Go to the OAuth2 Grant Options tab and add the following to the Extra attributes for the token request parameter:
   
   audience=partner

   1	audience=partner

6. Then click OK to save the configuration.
   

   Hivebrite – OAuth connection advanced configuration

Create and configure JSON Source

1. Drag a Data Flow Task into Control Flow and open it.
   

   Drag and drop Data Flow

2. In Data Flow, drag and drop ZS JSON Source.
   

   SSIS JSON Source – Drag and Drop

3. Open the JSON Source editor and enable Use credentials.
4. Select the Hivebrite OAuth2 connection you created.
5. Set the API URL using your community’s API host. Example to extract members:
   
   https://{your-community}.hivebrite.com/admin/v4/members

   1	https://{your-community}.hivebrite.com/admin/v4/members

6. Set HTTP Request Method to GET.
7. Add the following HTTP Header:
   • Accept: application/json
8. Set JSON Path Filter to $.data[*] — Hivebrite wraps all collection responses under an data array.
9. Click Preview to confirm rows are returned, then click OK.
   

   Hivebrite – JSON source example

Configure destination component

1. Add an Upsert destination (or another destination of your choice, such as a Trash destination or JSON/CSV/XML destination).
2. Connect the output arrow from JSON Source to the destination component.
3. Configure your SQL Server connection and target table.
4. Check the options you want to use: Insert or/and Update.
5. Map the source columns to destination columns in the Mappings section.
   

   Hivebrite – Upsert destination

6. Click OK and execute the package.
7. Validate that Hivebrite rows have been loaded into your SQL Server table.
   

   Hivebrite – Upsert Destination example

Conclusion

You now have a repeatable SSIS pattern to extract Hivebrite API data and load it into SQL Server by using ZappySys SSIS PowerPack. With OAuth2 Client Credentials authentication, proper pagination, and column mapping, you can operationalize Hivebrite data for BI and reporting workflows.

Explore the full capabilities of the ZappySys SSIS PowerPack to extend this setup with advanced transformations, retry logic, auditing, and scheduling through SQL Server Agent.