Skip to main content

Integrating Superwall

Capabilities​

DataGrail's Superwall integration provides the following capabilities:

ProductCapability
Request Manager
Request TypesAccess, Deletion
Identifier CategoriesEmail, Service ID
Field Level ControlsAccess

Before You Start​

To successfully configure this integration, please ensure you have sufficient privileges:

  • DataGrail User Role: Super Admin, Connections Manager

Get a Superwall API Key​

Create an API key and find your Application ID in Superwall.

  1. Log in to the Superwall Dashboard.
  2. Select the project you want to connect.
  3. Copy the Application ID from the project's URL and store it in a secure, temporary location. For example, in https://app.superwall.com/1451/8592/dashboard, the Application ID is 8592.
  4. In the left panel, select Settings > API keys.
  5. Select Create API Key.
  6. Enter a key name, such as DataGrail.
  7. Enable the Users Read and Users Write scopes.
  8. Select Create API Key.
  9. Copy the API key and store it in a secure, temporary location.
Copy the API Key Now

Superwall only displays the API key once. If you leave the page before copying it, create a new key.

Connect to DataGrail​

Enter the credentials you created above in DataGrail.

  1. In DataGrail, navigate to Integrations and select Configure New Integration to search for Superwall.
  2. Enter the Organization API Key and Application ID.
  3. (Optional) Enter the Email Properties to search by email address. Enter the exact Superwall user property keys, separated by commas. For example, email, billing_email. If you leave this field empty, DataGrail only searches the email property.
  4. Select Configure Integration.
How Deletion Works in Superwall

Superwall doesn't offer a way to erase a user. For Deletion requests, DataGrail clears all of the user's attributes instead. The user's ID remains in Superwall.

Next Steps​

Now that you've successfully connected the integration, check out the following resources:

Troubleshooting​

If you are unable to successfully connect the integration, review these common troubleshooting steps:

The connection test fails

Confirm the API key has both the Users Read and Users Write scopes, and that the Application ID belongs to the project the key was created in.

The connection test fails with "Email properties not found"

At least one of the Email Properties you entered doesn't exist in Superwall user properties. Confirm each key matches the user property name exactly, including capitalization, and separate multiple keys with commas.

Ensure Required Permissions Are Granted on API Keys/Resources

DataGrail checks required permissions and scopes on API keys/resources used by each integration. If all necessary permissions are not granted, new connections will fail.

Review Required Account Types and User Roles

If users do not have the necessary permissions or the minimum required user role in the connecting system, the connection to DataGrail will fail. Additionally, connections will fail if your account type does not match the one required by the integration.

See Before You Start to review these requirements.

Technical Details​

The Superwall integration uses the Superwall API:
Access TypeSynchronous
Deletion TypeSynchronous

API Documentation​

Learn more about this API implementation and DataGrail functionality in our API Integration Documentation.

 

Need help?
If you have any questions, please reach out to your dedicated Account Manager or contact us at support@datagrail.io.

Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.