Skip to main content

BeginIntegrationOauthInput

Autogenerated input type of BeginIntegrationOauth

input BeginIntegrationOauthInput {
  clientId: String
  clientMutationId: String
  clientSecret: String
  integrationId: ID!
  integrationType: IntegrationTypeEnum!
}

Fields​

BeginIntegrationOauthInput.clientId ● String scalar common​

The merchant's own OAuth app client id, for integrations (e.g. ShipBob) where each merchant registers their own app. Persisted on the integration.

BeginIntegrationOauthInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

BeginIntegrationOauthInput.clientSecret ● String scalar common​

The merchant's own OAuth app client secret. Encrypted on storage. Ignored by integrations that use a shared app.

BeginIntegrationOauthInput.integrationId ● ID! non-null scalar common​

ID of the existing integration record.

BeginIntegrationOauthInput.integrationType ● IntegrationTypeEnum! non-null enum integrations​

Type of the integration; used to dispatch to the right integration class.

Member Of​

beginIntegrationOauth mutation