v1

ApiIntegration

Create integration

Create a new integration with the provided credentials.

Credential requirements by integration type:

PostgreSQL/MySQL/Redshift/SQL Server: host, port, database, username, password
BigQuery: project_id, credentials_json (service account JSON)
Snowflake: account, username, password, warehouse, database
Stripe: account_id, client_secret
Custom: Any key-value pairs in a secrets object

The integration will be validated (connection tested) before being saved.

post/v1/api/integrations

Request

Base URL
https://api.definite.app (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/definite/apis/defapi/docs/v1/api/integrations/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

type'postgres' | 'acumatica' | 'aircall' | 'amplitude' | 'attio' | 'bigquery' | 'cube' | 'custom' | 'ducklake' | 'excel' | 'facebookads' | 'facebookads_system_user' | 'gcs' | 'googleads' | 'googleanalytics' | 'googlesearchconsole' | 'googlesheets' | 'hubspot' | 'iceberg' | 'linkedinads' | 'linkedinpages' | 'mavenlink' | 'mysql' | 'omnisend' | 'pipedrive' | 'twilio' | 'quickbooks' | 'redshift' | 'salesforce' | 'salesloft' | 'sharepointsites' | 'sheets' | 'shopify' | 'slack' | 'snowflake' | 'sqlserver' | 's3' | 'abicart' | 'abra' | 'activecampaign' | 'acuite' | 'adp' | 'aftership' | 'aha' | 'airtable' | 'amazonadvertising' | 'amazonassociates' | 'amazonsellingpartner' | 'anvil' | 'apaleo' | 'appstore' | 'applehealth' | 'asknicely' | 'atinternet' | 'awscloudtrail' | 'awscognito' | 'awscostexplorer' | 'bamboohr' | 'hellobaton' | 'bazaarvoice' | 'bexio' | 'bigmarker' | 'brillium' | 'canvas' | 'chorusai' | 'clickcast' | 'clickup' | 'clientsuccess' | 'closeio' | 'cloudwatch' | 'coingecko' | 'currencyfreaks' | 'dagster' | 'dashhudson' | 'datadog' | 'dearsystems' | 'dixa' | 'domo' | 'emarsys' | 'fastly' | 'fishbowl' | 'freshdesk' | 'freshcaller' | 'freshworks' | 'fullstory' | 'gainsightpx' | 'github' | 'gladly' | 'gong' | 'greenhouse' | 'holidays' | 'hotjar' | 'immuta' | 'instagram' | 'iterable' | 'intercom' | 'jira' | 'jotform' | 'judgeme' | 'keap' | 'klaviyo' | 'krow' | 'lessonly' | 'lightdash' | 'linear' | 'loopreturns' | 'maestroqa' | 'mailerlite' | 'mailjet' | 'marketo' | 'marketplacer' | 'netohq' | 'megaphone' | 'memberful' | 'mercadopago' | 'meshstack' | 'messagebird' | 'metronome' | 'mixpanel' | 'msgraph' | 'mindstamp' | 'miro' | 'mode' | 'monday' | 'mongodb' | 'montapacking' | 'moosend' | 'netlify' | 'netrivals' | 'netsuite' | 'niceincontact' | 'notion' | 'okta' | 'ordoro' | 'partnerize' | 'partoo' | 'peloton' | 'picqer' | 'plentymarkets' | 'getpocket' | 'podbean' | 'pulumicloud' | 'qls' | 'qualified' | 'readthedocs' | 'recruitee' | 'recurly' | 'sailthru' | 'segment' | 'sellsy' | 'sendinblue' | 'shipbob' | 'shiphero' | 'shipstation' | 'shoplazza' | 'showpad' | 'sleeper' | 'smartsheet' | 'square' | 'stamped' | 'stripe' | 'sumologic' | 'talkable' | 'thinkific' | 'tiktokads' | 'tradera' | 'travefy' | 'trustrace' | 'typeform' | 'udemyforbusiness' | 'unleashed' | 'veeqo' | 'webflow' | 'woocommerce' | 'zammad' | 'zendesk' | 'zohocrm' required

credentialsobject required

Integration credentials. For databases: host, port, database, username, password. For APIs: varies by integration type.

namestring nullable

Optional display name for the integration

Response

Integration created successfully

messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.