Overview

Databricks is a unified data analytics platform used by organizations to store, process, and analyze large-scale data.

Common uses for the Alchemer Databricks integration

• Personalize invites and surveys with information in Databricks
• Use Databricks information in survey logic
• Automate data retrieval and updates between Alchemer and Databricks
• Reduce manual data entry and record maintenance
• Keep Databricks records synchronized with responses collected in Alchemer
• Push survey response data into Databricks tables for analytics and reporting

What can the Alchemer Databricks integration do?

• Get data 
• Update row
• Upsert row
• Push to table

You will need

• Your Databricks client ID and secret for your service principal. More details in the authentication how-to guide.
• An Alchemer plan that includes integrations and the Integration Manager permission enabled.  
  • Contact us if you are unsure if your plan includes integrations.

Setup Alchemer Databricks integration in surveys

Databricks | Get data

You will need:

• Your Databricks client ID and secret for your service principal. More details in the authentication how-to guide.
• Survey fields containing a unique identifier for row

Configure the action

1. Open your survey in Survey builder.
2. Select Add New: Action.
3. In the Add Action modal, scroll to the Integrations section.
4. Select Databricks.
5. Select Databricks | Get data.
6. Databricks | Authentication: Select an existing authentication or create a new authentication.
7. Databricks | Choose warehouse: Select the Databricks warehouse you would like to use from the dropdown to write the queries.
8. Databricks | Choose catalog: Select the Databricks catalog you would like to use from the dropdown.
9. Databricks | Choose schema: Select the Databricks schema you would like to use from the dropdown.
10. Databricks | Choose table: Select the Databricks table you would like to use from the dropdown.
11. Databricks | Find row: Select the Alchemer field containing the lookup value.
12. Databricks | Get data back: Select the Databricks fields you want returned to the survey. These can be used to personalize survey questions.
13. Save the action.

Status codes

• 200: A single row was successfully found
• 201: Query ran successfully, but no rows were found
• 202: More than one row was found. The first row is used for the values returned to Alchemer

• 400: The external integration returned an error

Databricks | Update row

You will need:

• Your Databricks client ID and secret for your service principal. More details in the authentication how-to guide.
• Survey fields containing the identifier for the row

Configure the action

1. Open your survey in Survey builder.
2. Select Add New: Action.
3. In the Add Action modal, scroll to the Integrations section.
4. Select Databricks.
5. Select Databricks | Update row.
6. Databricks | Authentication: Select an existing authentication or create a new authentication.
7. Databricks | Choose warehouse: Select the Databricks warehouse you would like to use from the dropdown to write the queries.
8. Databricks | Choose catalog: Select the Databricks catalog you would like to use from the dropdown.
9. Databricks | Choose schema: Select the Databricks schema you would like to use from the dropdown.
10. Databricks | Choose table: Select the Databricks table you would like to use from the dropdown.
11. Databricks | Find row: Select the Alchemer field containing the lookup value.
    Note: All matching rows will be updated, please ensure that your lookup value is unique if you wish to update one row. 
12. Databricks | Update row: Choose the survey data you want to use to update a row in your Databricks table.
13. Databricks | Get data back: Select metadata fields (e.g. message, status code). These can be used to help debug your action setup.
14. Save the action

Status codes

• 200: Successfully updated row
• 201: Query ran successfully. No rows updated
• 202: Multiple rows were found. X row(s) updated
• 400: The external integration returned an error

Databricks | Upsert row

You will need:

• Your Databricks client ID and secret for your service principal. More details in the authentication how-to guide.
• Survey fields containing the identifier for the row

Configure the action

1. Open your survey in Survey builder.
2. Select Add New: Action.
3. In the Add Action modal, scroll to the Integrations section.
4. Select Databricks.
5. Select Databricks | Upsert row.
6. Databricks | Authentication: Select an existing authentication or create a new authentication.
7. Databricks | Choose warehouse: Select the Databricks warehouse you would like to use from the dropdown to write the queries.
8. Databricks | Choose catalog: Select the Databricks catalog you would like to use from the dropdown.
9. Databricks | Choose schema: Select the Databricks schema you would like to use from the dropdown.
10. Databricks | Choose table: Select the Databricks table you would like to use from the dropdown.
11. Databricks | Find row: Select the Alchemer field containing the lookup value.
    Note: All matching rows will be updated, please ensure that your lookup value is unique if you wish to update one row. If no matching rows are found a new row will be created.
12. Databricks | Upsert row: Choose the survey data you want to use to uspert a row in your Databricks table.
13. Databricks | Get data back: Select metadata fields (e.g. message, status code). These can be used to help debug your action setup.
14. Save the action.

Status codes

• 200: Successfully inserted row. 
• 201: Query ran successfully. No rows updated. 
• 202: Successfully updated X row(s).
• 400: The external integration returned an error.

Databricks | Push to table

You will need:

• Your Databricks client ID and secret for your service principal. More details in the authentication how-to guide.
• Survey fields containing the identifier for the table

Configure the action

1. Open your survey in Survey builder.
2. Select Add New: Action.
3. In the Add Action modal, scroll to the Integrations section.
4. Select Databricks.
5. Select Databricks | Push to table.
6. Databricks | Authentication: Select an existing authentication or create a new authentication.
7. Databricks | Choose warehouse: Select the Databricks warehouse you would like to use from the dropdown to write the queries.
8. Databricks | Choose catalog: Select the Databricks catalog you would like to use from the dropdown.
9. Databricks | Choose schema: Select the Databricks schema you would like to use from the dropdown.
10. Databricks | Choose table: Select the Databricks table you would like to use from the dropdown.
11. Databricks | Insert row into table: Choose the survey data you want to use to insert a row into your Databricks table.
12. Databricks | Get data back: Select metadata fields (e.g. message, status code). These can be used to help debug your action setup.
13. Save the action.

Status codes

• 200: Successfully inserted row. 
• 400: The external integration returned an error.

Testing and Validation

How to test

• Submit a survey response that triggers the integration action.
• Confirm the expected update or retrieval occurs in Databricks.
• Use metadata for verification and debugging.

How to verify results

• Check the impacted record in Databricks.
• Ensure retrieved or updated values match expectations.

Monitoring Integration Activity

 Where to find logs

• Go to Results → Individual Responses.
• Select the response you want to inspect.
• Open the Action Log tab.

What logs display

• Success or failure status
• Timestamp
• Input and output values
• Returned status codes from Databricks

Troubleshooting

Authentication issues

• Incorrect or expired credentials
• Missing permissions in Databricks

Lookup failures

• Invalid identifier values
• No matching records

Mapping errors

• Unsupported or invalid fields
• Incorrect formatting

API errors

• Validation issues
• Endpoint restrictions

FAQs