connections

Connect Api Key

Changed on

Connect a custom (API-key) source, e.g. Adapty.

There is no OAuth popup: the customer pastes their secret key, the backend imports it into Nango's vault, then proves it works before saving anything. A key that Nango accepts but the provider rejects must not leave a live connection behind, so a failed verification rolls the stored key back.

post/api/connections/{provider}/api-key

Request

  • Base URL: https://api.heymetra.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.heymetra.com/api/connections/{provider}/api-key
  • Auth: none declared

Path parameters

provider'google_ads' | 'meta_ads' | 'meta_instagram' | 'meta_page' | 'ga4' | 'gsc' | 'zoho_crm' | 'zoho_salesiq' | 'zoho_marketing' | 'telegram' | 'slack' | 'email' | 'adapty' | 'trendyol' | 'revenuecat' | 'appsflyer' | 'app_store_connect' | 'woocommerce' | 'shopify' | 'stripe' | 'posthog' | 'jira' | 'google_calendar' | 'google_meet' | 'hepsiburada' | 'n11' | 'ciceksepeti' | 'amazon_seller' | 'ikas' required

Headers

authorizationstring nullable
x-workspace-idstring nullable

Request body

credentialsobject required
account_namestring required
write_enabledboolean required
shared_with_workspaceboolean

Response

Successful Response

idstring uuid required
provider'google_ads' | 'meta_ads' | 'meta_instagram' | 'meta_page' | 'ga4' | 'gsc' | 'zoho_crm' | 'zoho_salesiq' | 'zoho_marketing' | 'telegram' | 'slack' | 'email' | 'adapty' | 'trendyol' | 'revenuecat' | 'appsflyer' | 'app_store_connect' | 'woocommerce' | 'shopify' | 'stripe' | 'posthog' | 'jira' | 'google_calendar' | 'google_meet' | 'hepsiburada' | 'n11' | 'ciceksepeti' | 'amazon_seller' | 'ikas' required
account_idstring required
account_namestring nullable required
aliasstring nullable required
display_namestring required
is_activeboolean required
paused_for_planboolean required
write_enabledboolean required
ask_before_sendingboolean
currencystring nullable required
consent_versioninteger nullable
is_mineboolean
may_administerboolean
shared_with_workspaceboolean
referencestring required
identityobject required
credentialsobject
last_errorstring nullable required
created_atstring date-time required
grant_shape'separable' | 'read_only' | 'inseparable' | 'channel' required

What a customer's read-or-write choice can actually buy at this provider.

The choice is offered on every connector, because a customer deciding whether an assistant may change their account should not have to know which providers happen to model that as a scope. What differs is what the choice BUYS, and saying so is this enum's whole job: a screen that offers the same two options everywhere while one of them is unenforceable at three providers is worse than one that says which is which.

Changes

  • 488ce9683884Revision changes
    • warning

      added the new ikas enum value to the response property for the response status

    • info

      added the new enum value ikas to the path request parameter provider

  • 8153ccd4dea1Revision changes
    • warning

      added the new amazon_seller enum value to the response property for the response status

    • warning

      added the new ciceksepeti enum value to the response property for the response status

    • warning

      added the new hepsiburada enum value to the response property for the response status

    • warning

      added the new n11 enum value to the response property for the response status

    • info

      added the new enum value amazon_seller to the path request parameter provider

    • info

      added the new enum value ciceksepeti to the path request parameter provider

    • info

      added the new enum value hepsiburada to the path request parameter provider

    • info

      added the new enum value n11 to the path request parameter provider