Connection method: endpoint

This article gives an overview of the endpoint connection method for S3.

For an overview of the different connection methods please refer to this article.

Setup

1. Go to Integrations and click Connect Integration in the top-right corner.
2. Click Connect on the S3 card. The AWS S3 setup opens.
3. On the Choose Connection Method step, select Endpoint.
4. Click Connect & Continue.

Tekst creates the integration and shows the Connection Details step.

The Endpoint URL is the URL you send your files to. It is specific to the integration you just created (which in turn is specific to your organization).

The API Key is created automatically for this integration and is used to authenticate your uploads. Copy it with the copy button next to the field and store it somewhere safe: it is shown only once.

When you have copied both values, check I understand that any generated API keys or secrets have been copied and will not be shown again. and click Next. The Setup Complete step confirms the integration is ready to use.

For more information on how to use the API key please refer to the developer section.

Usage

To upload a file, send a POST request to the endpoint URL with the file you want to upload, and pass the API key in the x-api-key header.

The file can be uploaded using form data. For example, with curl:

curl -X POST "<endpoint URL>" \
  -H "x-api-key: <API key>" \
  -F "file=@order.pdf"

In Postman this looks like this: