Integration

An integration with configuration and related resources.

type Integration {
  appId: Int
  applications(
    limit: Int
    page: Int
  ): ApplicationsResult
  config: JSON
  definition: IntegrationDefinition
  envId: Int
  id: Int
  network_site: NetworkSiteResult
  network_sites(
    limit: Int
    page: Int
    search: String
    status: String
  ): NetworkSitesResult
  orgId: Int
  requiredBy: [Integration!]!
  requires: [String!]!
  slug: String!
  status: String
}

Fields

Integration.appId ● Int scalar common

The application ID associated with the integration.

Integration.applications ● ApplicationsResult object common

The applications related to the integration.

Integration.applications.limit ● Int scalar common

The maximum number of applications to return.

Integration.applications.page ● Int scalar common

The page number to return.

Integration.config ● JSON scalar common

The integration configuration.

Integration.definition ● IntegrationDefinition object common

The config definition of an integration registered from a manifest, used to build its settings form. Null for an integration defined in code, on an organization's integration, and when the definition isn't available.

Integration.envId ● Int scalar common

The environment ID associated with the integration.

Integration.id ● Int scalar common

The unique identifier for the integration.

Integration.network_site ● NetworkSiteResult object common

A single network site result related to the integration.

Integration.network_sites ● NetworkSitesResult object common

The network sites related to the integration.

Integration.network_sites.limit ● Int scalar common

The maximum number of network sites to return.

Integration.network_sites.page ● Int scalar common

The page number to return.

Integration.network_sites.search ● String scalar common

A search string to filter network sites.

Integration.network_sites.status ● String scalar common

A status filter for network sites.

Integration.orgId ● Int scalar common

The organization ID associated with the integration.

Integration.requiredBy ● [Integration!]! non-null object common

The integrations that depend on this integration.

Integration.requires ● [String!]! non-null scalar common

The integrations or capabilities required by this integration.

Integration.slug ● String! non-null scalar common

The integration slug.

Integration.status ● String scalar common

The current integration status.

Returned By

manageIntegration mutation

Member Of

AppEnvironment object ● Integration object ● Organization object