Integration Object

Integrations are a new feature currently in beta-test: this API is subject to change without notice. Visit App Builder NodeJS for more information on integrations in 4me.

Root Connection

All Integration objects of an account are accessible by a query on the root connection integrations. Such a query will return a IntegrationConnection!, which contains the Integration objects in its nodes field.

integrations (IntegrationConnection!)

Root connection for retrieving Integration records.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

filter IntegrationFilter

Filter to determine which Integration records are returned.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

order [IntegrationOrder!]

Order of the Integration records returned.

view IntegrationView

View name.

The default value is current_account.

Fields

The fields in this section list which values can be retrieved when querying Integration records.

account (Account)

The account this record belongs to.

compliance (String)

Compliance description of the integration.

createdAt (ISO8601Timestamp)

The date and time at which the record was created.

description (String)

Description of the integration.

disabled (Boolean)

Whether the integration may not be used for new instances.

features (String)

Feature description of the integration.

id (ID!)

Unique identifier of the object.

latest (Boolean)

Whether this is the latest published version of the integration or the current draft.

name (String)

Name of the integration.

pictureUri (String)

The hyperlink to the image file for the record.

policyJwtAlg (WebhookPolicyJwtAlg)

The algorithm used for generating the policy for the integration's webhook.

policyJwtAudience (String)

The audience for the policy for the integration's webhook.

policyJwtClaimExpiresIn (Int)

The claim expiry time for the policy for the integration's webhook.

published (Boolean)

Whether this integration is published or draft.

reference (String)

This reference can be used to link the integration to an instance using the 4me APIs or the 4me Import functionality.

scopes ([IntegrationScope!])

Scopes of this integration.

serviceInstance (ServiceInstance)

Service instance that is linked to the integration.

source (String)

An identifier for the client application submitting the resource or the name of an external system

sourceID (String)

The unique identifier of the resource in an external system

uiExtensionVersion (UiExtensionVersion)

UI extension version that is linked to the integration.

updatedAt (ISO8601Timestamp)

The date and time of the last update of the record. If the record has no updates it contains the createdAt value.

webhookUriTemplate (String)

The URI for the integration's webhook. The placeholder {account} can be used to include the customer account id in the URI.

Connections

The connection fields in this section allow (paged) access to objects related to a specific Integration record. The actual objects will be in the nodes field of the connection.

automationRules (IntegrationAutomationRuleConnection)

Automation rules of this integration.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

complianceAttachments (AttachmentConnection)

Files and inline images linked to the Compliance field.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

descriptionAttachments (AttachmentConnection)

Files and inline images linked to the Description field.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

featuresAttachments (AttachmentConnection)

Files and inline images linked to the Features field.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

integrationInstances (IntegrationInstanceConnection)

Instances of this integration.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

Implements

Integration implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a Integration.