Step-by-step guideWebOwner / Admin

Configure a JSON API connection

What you will accomplish

You will configure a polled JSON source with authentication, record extraction, pagination, incremental sync, and an explicit schedule.

Who can do this

Owners and Admins can manage API connections.

Before you start

Obtain the HTTPS request URL, method, authentication details, sample JSON, record path, pagination rules, rate limits, stable record identifier, target track, rooftop, and permitted polling interval.

Add the connection

Open Account menu → Config → Connect your data.
Select API.
Enter Connection name.
Select Target track and Rooftop.
Enter Request URL and select Method.
Select Auth type and enter the required header, username, or credential.
Enter Records path when records are nested in the response.
Select Pagination and complete the fields it reveals, such as page size, maximum pages, or cursor path.
To enable incremental sync, enter Updated-since param.
When shown, enter Watermark field.
Enter Poll interval (minutes).
Select the optional event-date field when applicable.
Select Add API connection.

Test and run

Find the connection.
Select Test.
Resolve URL, authentication, record-path, or response errors.
Select Run now.
Read Import history.

Polling uses the configured interval. Pagination and maximum-page limits can intentionally restrict one run.

Expected result: a successful test reports reachable records or fields, and a completed run appears in Import history with its actual outcome.

Troubleshooting and recovery

Test succeeds but imports zero: verify records path and sample response.
Records repeat: verify correlation-key mapping and incremental settings.
Records are missing: inspect pagination, maximum pages, filters, watermark, and rooftop.
Credential must change: select Edit and use the replacement field; otherwise leave it blank only when the form says the stored credential remains.

Last verified against the product on 2026-07-29.