Skip to main content

connectIntegrationWithRefreshToken

Connects an existing integration using a refresh token only. The integration class persists the refresh token and immediately exchanges it for an access token via the upstream /auth/refresh-style endpoint; both tokens are then stored encrypted on the integration record.

Use this mutation when the merchant has only the long-lived refresh token (e.g. issued by the integration's developer dashboard) and interactive credential exchange is unavailable (MFA / SSO).

Authentication Requirements​

  • Header Authorization must be provided
  • Header X-Company-Id must be provided

Possible Errors​

  • Integration not found in the requesting company
  • Integration of the given type does not support refresh-token connect
  • Refresh token is blank
  • Upstream refresh exchange fails (invalid/revoked token)
connectIntegrationWithRefreshToken(
  input: ConnectIntegrationWithRefreshTokenInput!
): Integration!

Arguments​

connectIntegrationWithRefreshToken.input ● ConnectIntegrationWithRefreshTokenInput! non-null input common​

Parameters for ConnectIntegrationWithRefreshToken

Type​

Integration object integrations​