Skip to main content

SetupIntegrationInput

Autogenerated input type of SetupIntegration

input SetupIntegrationInput {
  apiKey: String
  apiSecret: String
  apiToken: String
  brandId: ID
  clientMutationId: String
  description: String
  integrationType: IntegrationTypeEnum!
  name: String!
  roles: [RoleTypeEnum!]!
  settings: JSON
}

Fields​

SetupIntegrationInput.apiKey ● String scalar​

The API key for the integration. This argument can be also used to store the main API key or secret for the integration. It is very important to store the main connection credential using this argument because it will be encrypted and stored in the database.

SetupIntegrationInput.apiSecret ● String scalar​

The API secret for the integration. This argument will be encrypted and stored in the database.

SetupIntegrationInput.apiToken ● String scalar​

The API token for the integration. This argument will be encrypted and stored in the database.

SetupIntegrationInput.brandId ● ID scalar​

The brand id. If the header X-Brand-Id is provided then this argument is optional, otherwise it is required.

SetupIntegrationInput.clientMutationId ● String scalar​

A unique identifier for the client performing the mutation.

SetupIntegrationInput.description ● String scalar​

SetupIntegrationInput.integrationType ● IntegrationTypeEnum! non-null enum​

SetupIntegrationInput.name ● String! non-null scalar​

SetupIntegrationInput.roles ● [RoleTypeEnum!]! non-null enum​

The roles that will be assigned to the integration. This argument is required and it must include at least one role. The roles determine the permissions that the integration will have, and the role should match with the actions that the integration will perform.

SetupIntegrationInput.settings ● JSON scalar​

Additional settings for the integration. This argument can be used to store any additional settings for the integration different from the api_key, the api_secret or the api_token.

Member Of​

setupIntegration mutation