Setting up S3-compatible storage integrations

The beehiiv S3 integration lets you export subscriber interaction data, including email clicks, opens, and  bounces, directly to your own cloud storage bucket for ingestion into an external database or analytics platform.

The following S3-compatible storage providers are supported:

• Amazon Web Services (AWS S3)
• Cloudflare R2
• Backblaze B2
• Wasabi Cloud Storage

In this article, you'll learn how to:

• Configure your bucket and user permissions for each platform.
• Connect your storage provider to your beehiiv workspace.
• Understand the CSV data that beehiiv uploads to your storage platform.

1. Click on Settings in the bottom left corner of your beehiiv account. 
2. From the left panel menu, go to Integrations > Browse apps. Once the Available Apps open, navigate to your storage provider and click Connect. 
   
   
   
3. A setup wizard will walk you through the process. You'll first be prompted to enter your bucket name.
   
   Once entered, the IAM Policy field below will populate with a JSON object showing the access policy required to access your bucket. Copy this policy and apply it to your bucket permissions before proceeding. When ready, click Next.
   
   
   
4. In the Test your connection step, enter your bucket's region and the credentials used to access it. When done, click Next.
   
   
   

5. On the final screen, configure your delivery settings. Specify a directory name, file type, and compression type, then click Connect.
   
   Data can be exported in CSV or Parquet format, with the following compression options: LZ4, GZIP, or no compression. Uncompressed files are split into 16 MB parts.
   
   
   

Access Control Lists are used to access buckets on AWS S3. Before testing your connection, make sure ACLs are enabled in your bucket's permissions settings.

You'll need to provide an Access Key and Secret Access Key from AWS to grant access to your S3 bucket. If you're unfamiliar with IAM users and access keys, refer to the AWS IAM documentation.

Default B2 bucket permissions are sufficient for this integration. When creating an application key scoped to your bucket, be sure to grant read/write permissions and list access.

In the setup wizard, enter your credentials as follows:

• Key ID: Access Key ID
• Application Key: Secret Access Key

Your bucket's region can be found in the Endpoint field on the bucket details page.

After entering your bucket name, you’ll see an access policy displayed as a large JSON object. Follow the steps in the Wasabi documentation to add this access policy to your bucket. Once done, navigate to Access Keys in the left toolbar and create a set of access keys.

The R2 setup requires two pieces of information.

Bucket URL: Navigate to your R2 bucket and click Settings. The bucket URL appears under the General section, labeled S3 API.

API credentials: The API credentials will need to be generated on the R2 Overview page. Once there, find Account Details on the right side and then on the click Manage next to API Tokens.

Data is exported from beehiiv to your bucket on a nightly basis. The exported files follow the schema below. Fields marked as nullable may not always contain a value.