Configure authentication to SurveyMonkey

Important

This feature is in Beta. To use it, a workspace admin must turn on Lakeflow Connect for SurveyMonkey from the Previews page. See Manage Azure Databricks previews.

To let the Lakeflow Connect SurveyMonkey connector authenticate, register an app in the SurveyMonkey Developer Portal and deploy it as a private app. The connector uses OAuth user-to-machine (U2M) authentication. Use the credentials retrieved from the steps on this page to create a Unity Catalog connection in Azure Databricks.

Prerequisites

• A SurveyMonkey plan that supports private apps. All users of a private app must belong to the same SurveyMonkey team and have a paid plan that offers direct API access. SurveyMonkey requires an Enterprise plan to deploy a private app. See SurveyMonkey private apps and SurveyMonkey API access.
• The data center that hosts your SurveyMonkey account: US, EU, or Canada. You select it as the Data Region when you create the connection.
• Your Azure Databricks workspace URL, to set the app's OAuth redirect URI.

The connector reads the surveys that the authorizing user owns or that are shared with that user.

Configure SurveyMonkey

Register a SurveyMonkey app to get the client credentials that Azure Databricks uses to authenticate. For more information, see Registering an app in the SurveyMonkey API documentation.

1. Sign in to the SurveyMonkey Developer Portal for your account's data center:

   • US: developer.surveymonkey.com
   • EU: developer.eu.surveymonkey.com
   • Canada: developer.surveymonkey.ca

2. On the My Apps page, click Add a New App.

3. In the App Nickname and App Creator fields, enter the required values.

4. Select Private App, then click Create App. SurveyMonkey creates the app as a draft.

5. Open the app's Settings page.

6. In the OAuth Redirect URL field, enter https://<workspace-url>/login/oauth/http.html, where <workspace-url> is your Azure Databricks workspace URL.

7. Click Submit Changes.

8. Under Scopes, turn on the following scopes:

   • View Surveys (surveys_read)
   • View Collectors (collectors_read)
   • View Contacts (contacts_read)
   • View Responses (responses_read)
   • View Response Details (responses_read_detail)

   For the tables that each scope covers, see Required OAuth permissions.

9. Click Update Scopes.

10. Click Deploy to deploy the app as a private app. SurveyMonkey disables draft apps after a 90-day draft period, and no other SurveyMonkey accounts can authenticate a draft app. See Deploying an app.

11. On the app's Settings page, record the following values. You enter them when you create the connection.

    • Client ID
    • Secret: Click Show Secret to display it. You enter it as the Client Secret.

Next steps

Create a SurveyMonkey connection in Azure Databricks. See Create a SurveyMonkey connection.