Skip to main content

Setting up and using the S3 Integration

This article describes how to set up and use your AWS S3 integration.

The S3 integration allows SourceWhale to export your contact, email, and engagement data directly to an Amazon S3 bucket in CSV format. This is useful for custom data warehousing, BI tooling, or further processing in your own pipelines.

In order to set up your S3 integration on SourceWhale simply follow these steps:

Step 1

Navigate to your initials/image in the bottom left-hand corner > Select Integrations from the dropdown menu.

Search for S3 in the search bar.

Step 2

A. Create a bucket where you would like your data to be sent.

B. Next, create an IAM user with s3:ListBucket permission on the bucket and s3:PutObject permission on the objects in that bucket. Then create an access key for the user. An example policy is found below:

Step 3

Enter your Bucket Name, Access Key ID, Secret Access Key.

Step 4

Click 'Activate'.

Once the integration is active you will see a green Connected indicator next to the S3 icon.


How does the S3 Integration work?

When the integration is activated, SourceWhale writes a test object to the bucket to verify the connection. After activation, the following five CSV files are created once per day:

"dumps/contacts/{date}-partial.csv" 
"dumps/sent-mail/{date}-partial.csv"
"dumps/opens/{date}-partial.csv"
"dumps/clicks/{date}-partial.csv"
"dumps/replies/{date}-partial.csv"

These files consist of all contacts sourced, mail sent, and open/click/reply events over the last 24 hours.


Stuck or need some help? Click on the chat icon at the bottom right-hand corner to connect with our support team! 💬

Did this answer your question?