Setup

To start importing data from an HTTP API, first a new importer of the type General HTTP must be created. This can be done in the Importer Configuration. After an importer is created, it will be shown in the list. Make sure that the enabled configuration of the importer is activated.

Configure the importer with the connection details of the external system's API:

setting	description
Base URL	Root URL of the external system's API, e.g. https://api.example.org/flow. All entity endpoints are relative to this.
API secret	Shared secret that Flow sends with every request. See General.
Schedule	How often Flow fetches the data and runs the import.

Make sure to create and use one importer per datasource. One datasource represents one external system instance. If you have e.g. 2 external systems, create also 2 importers. On every run, all entries of the currently imported entity which were imported with this importer in previous runs will be replaced with the freshly fetched data. Data imported by other importers won't get changed.

→ The endpoints must always return everything, not only the entries that changed since the last import!

The external system has to expose the read-only endpoints described in Import Entities. See General for the shared conventions (authentication, IDs, import order and date format).