Skip to main content

ConnectIntegrationInput

Autogenerated input type of ConnectIntegration

input ConnectIntegrationInput {
  brandId: ID @deprecated
  clientMutationId: String
  connectionId: String!
  description: String
  integrationType: IntegrationTypeEnum!
  name: String!
  roles: [RoleTypeEnum!]
  settings: JSON
}

Fields​

ConnectIntegrationInput.brandId ● ID deprecated scalar common​

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only attribute. Integrations are configured by company now. Request company context from the X-Company-Id header will be used instead.

The brand id.

ConnectIntegrationInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

ConnectIntegrationInput.connectionId ● String! non-null scalar common​

The connection request identifier for the integration.

ConnectIntegrationInput.description ● String scalar common​

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

ConnectIntegrationInput.name ● String! non-null scalar common​

ConnectIntegrationInput.roles ● [RoleTypeEnum!] list enum roles-permissions​

The roles that will be assigned to the integration. This argument is required if the integration was not previously setup (otherwise will be ignored) 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.

ConnectIntegrationInput.settings ● JSON scalar common​

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​

connectIntegration mutation