Skip to main content

integration Query

Returns the specified Integration object.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_admin_integration_permissions, org_manage_integrations, org_view_integrations]. 2. The Customer User has any of the following permissions for the Customer and the Objects Attribute marketplace_configuration is AVAILABLE_AND_DEPLOYABLE OR AVAILABLE_NOT_DEPLOYABLE: [customer_admin_instance_deploy]. 3. The signed-in User has any of the following permissions for any version of the object: [integration_admin_permissions, integration_view, integration_edit, integration_remove]. 4. The signed-in User has any of the following permissions for the associated Customer of Integrations available in the Marketplace: [customer_view_marketplace_integrations].

Input fields#

ArgumentTypeDescription
idID!The ID of the Integration object.

Return fields (Integration)#

id (ID!)#

The ID of the object.

createdAt (DateTime!)#

The timestamp at which the object was created.

avatarUrl (String)#

The URL for the avatar image.

labels ([String!])#

The labels that are associated with the object.

versionSequenceId (UUID)#

Identifier for this version sequence.

versionIsLatest (Boolean!)#

Marked if this record is the latest version of this sequence.

versionNumber (Int!)#

Sequential number identifying this version.

versionCreatedBy (User)#

User that created this version.

versionCreatedAt (DateTime)#

Timestamp of the creation of this version.

versionComment (String)#

Additional comments about this version.

versionIsAvailable (Boolean!)#

Indicates if the version is available for use.

name (String!)#

The name of the Integration.

description (String)#

Additional notes about the Integration.

documentation (String)#

Rich text documentation to accompany the Integration.

parent (Integration)#

Parent Integration this Integration was forked from, if any

hasUnpublishedChanges (Boolean!)#

Specifies whether the Integration definition has changes that have not yet been published.

marketplaceTabConfiguration ([String!])#

The Marketplace Tabs available to Customer Users for configuring this Integration.

category (String)#

Specifies the category of the Integration.

overview (String)#

Specifies an Overview of the Integration to describe its functionality for use in the Integration Marketplace.

requiredConfigVariables (RequiredConfigVariableConnection!)#
instances (InstanceConnection!)#

The Integration that has been deployed for the Instance.

flows (IntegrationFlowConnection!)#

The Integration of which the IntegrationFlow is a part.

actions (IntegrationActionConnection!)#

The Integration to which the IntegrationAction is associated via the IntegrationFlow.

attachments ([Attachment])#

A JSON list of objects where each object has a key for name and URL that together describe the Attachment.

versions (VersionConnection!)#

The Versions of the Integration that are available.

versionSequence (IntegrationConnection!)#

Sequence of versions of this Integration

testConfigVariables (InstanceConfigVariableConnection!)#

Config Variables that are used for testing during Integration design.

lastExecutedAt (DateTime)#

The timestamp at which the Integration was most recently executed as part of an Instance.

allowPublish (Boolean!)#

Specifies whether the signed-in User can publish the Integration.

allowFork (Boolean!)#

Specifies whether the signed-in User can fork the Integration.

definition (String)#

The YAML that is the declarative definition for the Integration. Suitable for using to re-import the Integration.

storeConfiguration (IntegrationStoreConfiguration)#

Specifies whether an Integration will be available in the Integration Store and if the Integration is deployable by a Customer User.

marketplaceConfiguration (MarketplaceConfiguration!)#

Specifies whether an Integration will be available in the Integration Marketplace and if the Integration is deployable by a Customer User.

isCustomerDeployable (Boolean)#

Specifies whether the Integration can be deployed by the signed-in User.

allowUpdate (Boolean!)#

Specifies whether the signed-in User can update the Integration.

allowRemove (Boolean!)#

Specifies whether the signed-in User can remove the Integration.

starred (Boolean)#

Indicates whether the record is starred by the signed-in User.