Custom API warehouse sync

Custom API ingestion turns declared read-only OpenAPI operations into warehouse tables. Start with an HTTPS OpenAPI document and an Embrasure connector manifest that defines exactly which resources may be read.

Prepare the API definition

Provide a public HTTPS OpenAPI URL or upload a JSON or YAML document. Every manifest resource must match an operation in that document and declare:

• a unique resource name and warehouse table name;
• a GET operation, or a POST operation explicitly marked readOnly: true;
• the response path containing the record array;
• at least one stable primary key field;
• pagination details when the endpoint is paginated;
• an incremental field and request parameter when the API supports incremental reads.

Declare bearer tokens or named authentication headers as credential aliases. Enter the secret values in Embrasure; they are stored encrypted and are never returned to the browser.

Preview before activation

Open Custom API setup, enter the definition and credentials, then choose Preview tables. Preview checks the declared operations and shows table names and columns without returning sample row values.

Create the connector only after the preview is correct. Activation starts hourly reads and writes rows only to the selected managed warehouse database. Keep every operation read-only and preserve primary-key and cursor semantics when the upstream API changes.