What’s supported
Supported actions
This connector supports:- Read Actions, including full historic backfill. Please note that incremental reading is only supported for
events. For all other objects, a full read of the Flatfile instance will be done per scheduled read. - Write Actions.
- Proxy Actions, using the base URL
https://api.x.flatfile.com.
Supported Objects
The Flatfile connector supports reading from the following objects: The Flatfile connector supports writing to the following objects:Before you get started
This connector uses API Key authentication. You do not need to create a provider app in the Ampersand Dashboard. Flatfile distinguishes a Secret key from a Publishable key. Server-side access through Ampersand uses the Secret key.Create a Flatfile secret key
- Log in to your Flatfile account.
- Navigate to your developer or API key settings.
- Copy the Secret key for the environment you want to connect.
- Store the key securely.
Using the connector
This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. Provider apps are only required for providers that use OAuth2 Authorization Code grant type. To start integrating with Flatfile:- Create a manifest file like the example.
- Deploy it using the amp CLI.
- If you are using Read Actions, create a destination.
- Embed the InstallIntegration UI component. The UI component will prompt the customer for an API key.
- Start using the connector!
- If your integration has Read Actions, you’ll start getting webhook messages.
- If your integration has Write Actions, you can start making API calls to our Write API.
- If your integration has Proxy Actions, you can start making Proxy API calls.