Getting Startedlink
Account owners have access to the account management section. To access the section, open the top left dropdown menu and click "Manage Account." From here, you can access your "Settings" and scroll down to the "API Config" section to access your user-level API key and secret. You will need these to access your Fivetran account using our API.
Click Show to see your issued API secret.
Authenticationlink
Fivetran REST API uses API Key authentication. For each request to the API provide an Authorization
HTTP header with the following value: Basic {api_key}:{api_secret}
. The {api_key}:{api_secret}
part should be base64 encoded.
For instance, for API key d9c4511349dd4b86
and API secret 1f6f2d161365888a1943160ccdb8d968
, encode d9c4511349dd4b86:1f6f2d161365888a1943160ccdb8d968
to base64 (ZDljNDUxMTM0OWRkNGI4NjoxZjZmMmQxNjEzNjU4ODhhMTk0MzE2MGNjZGI4ZDk2OA==
) and use the following Authorization
HTTP header value:
Basic ZDljNDUxMTM0OWRkNGI4NjoxZjZmMmQxNjEzNjU4ODhhMTk0MzE2MGNjZGI4ZDk2OA==
Note: The API key is unique for the account and account owner user pair. Different account owners have different API keys.
API secret regenerationlink
Note: When you regenerate your API secret, your previous API secret will stop working immediately. Make sure that won't affect your system before you generate a new secret.
To generate a new API secret click Generate.
This action will instantly replace your API secret key with a new one.
Request content typelink
Fivetran Public API only accepts requests with the Content-Type: application/json
header explicitly specified in them. Make sure you have this header specified in the request when sending the POST
and PATCH
requests.
Responselink
Every response has the following format:
{
"code": "Success",
"message": "User has been invited to the account",
"data": {
"id": "cardiac_contemplation",
"email": "test.user@mycompany.com",
"given_name": "Test",
"family_name": "User",
"verified": false,
"invited": true,
"picture": "https://mycompany.com/avatars/test_user.png",
"phone": "test_phone",
"logged_in_at": null,
"created_at": "2019-01-20T16:00:09.097014Z"
}
}
Fields
Name | Description |
---|---|
code |
Response status code |
message |
Response status text |
data |
Response data |
Common termslink
Term | Description |
---|---|
source | The application, database, storage or event service that creates the data that you are using Fivetran to access in your destination. |
connector | The pipeline that you create every time you create a new Fivetran connection from your source to your destination. |
connector type | The type of connector that you're creating based on the source. For example, Salesforce is a connector type. |
group | Your Fivetran account can have multiple destinations associated with it and we call those groups. Users and connectors can be provisioned within these groups. |
Troubleshootinglink
We respond with standard codes for errors that occur during request processing.
Supported Connectorslink
- Adobe Analytics Data Feed
- Airtable
- Amplitude
- Anaplan
- Apache Kafka
- Apple App Store
- Apple Search Ads
- AppsFlyer
- AWS CloudTrail
- AWS Inventory
- AWS Lambda
- Azure Blob Storage
- Azure Functions
- Braintree
- Branch
- Braze
- Cloudfront
- Confluent Cloud
- Coupa
- Criteo
- DynamoDB
- Facebook Ad Insights
- Fivetran Log Connector
- Freshdesk
- Front
- FTP
- FTPS
- Google Analytics 360
- Google Cloud Functions
- Google Cloud Storage
- Google Sheets
- Greenhouse
- Heap
- Height
- Help Scout
- Heroku Kafka
- Instagram Business
- Iterable
- Kinesis
- Klaviyo
- Kustomer
- Lever
- Mandrill
- Marin Software
- Marketo
- Microsoft Dynamics 365
- Mixpanel
- MongoDB
- MySql
- NetSuite SuiteAnalytics
- Oracle
- Outbrain
- Pardot
- Pendo
- PostgreSQL
- ReCharge
- Recurly
- Qualtrics
- S3 Amazon
- Sailthru
- Salesforce
- Salesforce Marketing Cloud
- Segment
- Sendgrid
- Service Now
- SFTP
- Snowplow
- Splunk
- Sql Server
- Square
- Stripe
- Taboola
- Twitter Ads
- UserVoice
- Webhooks
- Workday
- Zendesk
- Zendesk Sunshine
- Zuora
Supported through OAuthlink
These connectors can only be authorized through the Connect Card or the Fivetran dashboard.
- Adobe Analytics
- AdRoll
- Asana
- Campaign Manager
- Dropbox
- Eloqua
- Facebook Ad Account
- Facebook Pages
- GitHub
- Google Ad Manager
- Google Ads
- Google Ads Account
- Google Analytics
- Google Analytics (MCF)
- Google Display & Video 360
- Google Play
- Google Search Console
- Help Scout
- HubSpot
- Intercom
- Jira
- Lightspeed Retail
- Linkedin Ad Analytics
- Mailchimp
- Mavenlink
- Microsoft Advertising
- Optimizely
- Pinterest Ads
- Pipedrive
- QuickBooks
- Shopify
- Snapchat Ads
- SurveyMonkey
- Verizon Media
- Xero
- YouTube Analytics
- Zendesk Chat
We plan to support the remaining connectors soon and will notify you as this list grows.
Custom sync schedulinglink
You can customize your connector's sync schedule using the Fivetran REST API. With custom scheduling, you can override Fivetran's default sync schedule and only trigger data syncs when you want them. To learn how sync scheduling works at Fivetran, read our sync frequency and scheduling documentation.
To use the REST API to customize your sync schedule, you must change your connector's schedule configuration to manual scheduling. You can then trigger a new sync whenever you want to sync your data.
Manual schedulinglink
Use the Modify a Connector endpoint to change your connector's schedule_type to manual
. This action overrides the standard sync frequency you defined in the Fivetran dashboard, so you will need to manually trigger your syncs after you make this change. Use the example request below to change your connector's schedule_type:
PATCH api.fivetran.com/v1/connectors/{connector_id}
{
"schedule_type": "manual",
"run_setup_tests": false
}
Next, use the Sync Connector Data endpoint to trigger a data sync according to your own schedule. Alternatively, you can trigger a sync in your Fivetran dashboard.