Skip to main content

Vitally

Sync overview​

The Vitally source supports Full Refresh only.

This source can sync data from the Vitally REST API.

Output schema​

This source syncs the following streams. Each stream uses id as its primary key.

Features​

FeatureSupported?(Yes/No)Notes
Full Refresh SyncYes
Incremental - Append SyncNo
NamespacesNo

Performance considerations​

Vitally's REST API documentation specifies a default limit of 1,000 requests per minute. The connector requests 100 records per page and follows the next cursor.

The connector doesn't set sortBy, so Vitally uses its default updatedAt ordering. Records that change while a sync is paginating can cause duplicates or gaps.

Requirements​

You need a Vitally REST API secret token. In Vitally, open Settings > Integrations under Connectors, select Vitally REST API, and enable the integration. Copy the secret token for an API key. See Vitally's authentication documentation.

Configure the following fields in Airbyte:

  • Custom Subdomain: Enter only the subdomain, not a full URL, for example your-custom-subdomain for https://your-custom-subdomain.rest.vitally.io/.
  • Status: Select active, churned, or activeOrChurned to filter the accounts stream.
  • Secret Token: Enter the REST API secret token. The connector uses it as the HTTP Basic authentication username.
  • Basic Auth Header: Despite its label, the connector uses this field as the HTTP Basic authentication password, not as a complete header. Vitally's documented header uses an empty password ("basic_auth_header": "" in JSON configuration). Don't paste Vitally's copied Basic Auth header into this field.

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
string
domain
string
secret_token
string
status
string
basic_auth_header

Changelog​

Expand to review
VersionDatePull RequestSubject
0.4.42026-09-3081345Add missing airbyte_secret flag to secret_token spec field
0.4.32026-06-0279008Update dependencies
0.4.22025-05-2460783Update dependencies
0.4.12025-05-1059942Update dependencies
0.4.02025-05-0558062Fix subdomain parameter config
0.3.102025-05-0459561Update dependencies
0.3.92025-04-2658951Update dependencies
0.3.82025-04-2058018Update dependencies
0.3.72025-04-0557478Update dependencies
0.3.62025-03-2956894Update dependencies
0.3.52025-03-2256255Update dependencies
0.3.42025-03-0855622Update dependencies
0.3.32025-03-0155090Update dependencies
0.3.22025-02-2254500Update dependencies
0.3.12025-02-1547470Update dependencies
0.3.02025-02-1253648Add support for custom domain.
0.2.12024-08-1644196Bump source-declarative-manifest version
0.2.02024-08-1444049Refactor connector to manifest-only format
0.1.132024-08-1243850Update dependencies
0.1.122024-08-1043505Update dependencies
0.1.112024-08-0343189Update dependencies
0.1.102024-07-2742607Update dependencies
0.1.92024-07-2041877Update dependencies
0.1.82024-07-1041378Update dependencies
0.1.72024-07-0941223Update dependencies
0.1.62024-07-0640808Update dependencies
0.1.52024-06-2540287Update dependencies
0.1.42024-06-2240189Update dependencies
0.1.32024-06-2538605Make compatible with builder
0.1.22024-06-0639203[autopull] Upgrade base image to v1.2.2
0.1.12024-05-2038446[autopull] base image + poetry + up_to_date
0.1.02022-10-2718545Add Vitally Source Connector