To connect your Zoom account to SmartSYNC you need to set up your own Zoom application. This is a fairly easy process which we guide you through below.
Step 1. Create an application
We will create an application and then, for our SmartZOOM product, revisit the settings later to add scopes and event triggers. To start with though we create a simple application which will be under your Zoom account and only able to access your own Zoom account details. You can disconnect this app at any time to disconnect the integration and only your team will have access to the application. Although the majority of users will be able to do this themselves, if you wish the SmartTHING team to set this application up on your behalf please contact our
support team.
- Visit the Zoom marketplace and log in
- Click the menu Develop > Build App (You may need to accept various agreements and terms, please do so).
- Select a 'General app'
- Edit the app name to be 'SmartSYNC for Raiser's Edge' so you can easily find it in future. This is usually shown in the top left with an edit icon.
- Switch to Production mode with the buttons at the top of the page:
- Now select the right type of app based on your rights within Zoom. You can select an Admin-managed app (if you have admin rights within Zoom) or a simpler User-managed app (for all other users). If in doubt select the User-managed option.
- Note the Client ID and Client Secret as we will need these later
- In the 'OAuth Redirect URL' you will need to enter the redirect URL for your SmartSYNC server. Visit SmartSYNC and in the footer of the page you will see Host: ... i.e. Host: us.smartsync.org. You can use this to find your OAuth Redirect URL:
https://[host]/app/connect/success i.e. https://us.smartsync.org/app/connect/success
- Tick the 'Use Strict Mode for Redirect URLs' and 'Subdomain Check' options - these provide greater security for you (see screenshot above)
- Click Continue
Features
- Note the Secret Token as we will need that later
- Click Continue until you get to the Scopes page
Scopes
- Add the User > View a user scope. In a user application this will be 'used:read:user' under the 'Add scope' button.
- Under 'Scope description' add 'Scopes required to access basic user account details and to pull webinar and event information to Raiser's Edge'
App Listing
Although not necessary to complete the process we advise you also set the below values:
- Company Name: The SmartTHING Limited
- Developer Contact Information: Developer Team and support@smartthing.org
Your app is now ready for use in SmartSYNC
Step 2. Connect SmartSYNC to Zoom
We have a wizard in SmartSYNC that allows you to connect Zoom to Raiser's Edge NXT. This asks you a few simple questions to configure the integration.
- Log in to your SmartSYNC account (the link from the tile on the Home page of Raiser's Edge is easiest here as it uses Blackbaud SSO).
- Go to the Applications tab and click 'Create application'
- Select the SmartZOOM for RENXT option and make sure you complete the required RE configuration updates
- Click Next
Connect your applications
You will need to connect both Zoom and Raiser's Edge to continue.
- You will see Step 2 with no applications available, click the 'Add new' button under 'Connection: Zoom'
- You now get to enter the details you noted in Step 1 for the Client ID, Client secret and Secret token
- Click 'Next' and go through the process to connect Zoom
- When you return to our wizard select your new Zoom connection
- Then click the 'Add new' button under 'Connection: Blackbaud Raiser's Edge NXT
- This is simpler as you just click 'Next' to go through the process of connecting Raiser's Edge. If you can't connect please ensure you have connected the 'SmartSYNC' application in the Blackbaud Marketplace.
- Once again select the new connection when you return to the wizard
- Click 'Next' to continue to the configuration page
On this page select the settings you wish to use when adding Events and Registrations to your Blackbaud Database. All the options from your database will be displayed for you to then select from. Any boxes with a Re dotted border are required fields.
Once complete click the 'Create' button to create your application.
IMPORTANT: You must continue and follow the steps outlined in Step 3 below.
Without this step the system will not work, it is where you link up the instant notifications system within Zoom with SmartSYNC.
Link Zoom and SmartSYNC
- Go to the SmartSYNC Home page > Applications
- Under your SmartZOOM application click the 'Advanced edit' link to show the three data flows we have created.
- We will link up each of these three flows to Zoom. The process being the same for each.
- For each flow:
- Click the name of the flow i.e. ('Zoom: Event Started ...') to edit the flow
- Then under the first step (once the editor loads) you will see a 'Webhook URL'. Copy that and note it against the flow name
- Return to your Zoom application in their developer portal and click on your app to edit it
- Switch to production mode again using the buttons at the top of the page:
- Go to the Access tab and enable 'Event Subscription'
- We will now link up each of the Webhook URLs you recorded earlier:
- Click 'Add New Event Subscription'
- Under Subscription name enter the name of the flow i.e. Event Started, New meeting registration or Participant joined
- Click Add events and select the event:
- for Event Started select Meeting > Start Meeting and Webinar > Start Webinar
- for New meeting registration select Meeting > Meeting Registration has been created and Webinar > Webinar Registration has been created
- for Participant Joined select Meeting > Participant/Host joined meeting and Webinar > Participant/Host joined webinar
Then click 'Done'
- Under 'Event notification endpoint URL' paste in the Webhook URL and then click 'Validate'
- Finally click Save and repeat for the other flows
- You should end up with three events configured and some new scope entries under the Scopes tab
Reconnect SmartSYNC
Finally we need to reconnect SmartSYNC as we changed the scopes for the application. This is very quick...
- Log in to your SmartSYNC account (the link from the tile on the Home page of Raiser's Edge is easiest here as it uses Blackbaud SSO).
- Go to Admin > Applications
- Click the 'Reconnect' button next to the Zoom connection and follow through the process to reconnect it
That's it